com.communote.server.api.core.property

Class PropertyHelper

java.lang.Object

com.communote.server.api.core.property.PropertyHelper

public class PropertyHelper
extends Object

Helper for working with Property entities and their TOs.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static boolean	containsPropertyTO(Iterable<StringPropertyTO> properties, String group, String key, String value) Test whether the provided collection contains the given property and has the provided value
static StringPropertyTO	getPropertyTO(Iterable<StringPropertyTO> properties, String group, String key) Retrieve the identified property from the provided collection or null if it is not contained
static <T extends StringProperty> Collection<StringPropertyTO>	nullifyMissingProperties(Iterable<T> source, Collection<StringPropertyTO> target) Add for each property of the source collection a property with same group and key and null as value to the target collection if there is no property with that group and key in the target collection.
static Collection<StringPropertyTO>	nullifyMissingPropertyTOs(Iterable<StringPropertyTO> source, Collection<StringPropertyTO> target) Add for each property of the source collection a property with same group and key and null as value to the target collection if there is no property with that group and key in the target collection.
static StringPropertyTO	removePropertyTO(Iterable<StringPropertyTO> properties, String group, String key) Remove the identified property from the provided collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

containsPropertyTO

public static boolean containsPropertyTO(Iterable<StringPropertyTO> properties,
                                         String group,
                                         String key,
                                         String value)

Test whether the provided collection contains the given property and has the provided value

Parameters:

properties - the properties to search

group - the group key of the property

key - the key of the property

value - the value the property should have

Returns:

true if the property is contained and has the value

getPropertyTO

public static StringPropertyTO getPropertyTO(Iterable<StringPropertyTO> properties,
                                             String group,
                                             String key)

Retrieve the identified property from the provided collection or null if it is not contained

Parameters:

properties - the properties to search

group - the group key of the property

key - the key of the property

Returns:

the found property or null

nullifyMissingProperties

public static <T extends StringProperty> Collection<StringPropertyTO> nullifyMissingProperties(Iterable<T> source,
                                                                                               Collection<StringPropertyTO> target)

Add for each property of the source collection a property with same group and key and null as value to the target collection if there is no property with that group and key in the target collection.

Parameters:

source - the properties that should be nullified if they are not in the target collection. Can be null.

target - the collection of properties to update. Can be null.

Returns:

the updated target collection or a new collection if target was null

nullifyMissingPropertyTOs

public static Collection<StringPropertyTO> nullifyMissingPropertyTOs(Iterable<StringPropertyTO> source,
                                                                     Collection<StringPropertyTO> target)

Add for each property of the source collection a property with same group and key and null as value to the target collection if there is no property with that group and key in the target collection.

Parameters:

source - the properties that should be nullified if they are not in the target collection. Can be null.

target - the collection of properties to update. Can be null.

Returns:

the updated target collection or a new collection if target was null

removePropertyTO

public static StringPropertyTO removePropertyTO(Iterable<StringPropertyTO> properties,
                                                String group,
                                                String key)

Remove the identified property from the provided collection.

Parameters:

properties - the properties to search

group - the group key of the property

key - the key of the property

Returns:

the removed property or null if it was not contained

Since:

3.5