com.gigaspaces.internal.utils

Class CollectionUtils

java.lang.Object

com.gigaspaces.internal.utils.CollectionUtils

public abstract class CollectionUtils
extends Object

Miscellaneous collection utility methods. Mainly for internal use within the framework.

Author:

kimchy

Constructor Summary

Constructors

Constructor and Description
CollectionUtils()

Method Summary

Modifier and Type	Method and Description
static <T> Collection<T>	cloneCollection(Collection<T> collection)
static <T> List<T>	cloneList(List<T> list)
static <K,V> Map<K,V>	cloneMap(Map<K,V> map)
static <T> boolean	contains(Enumeration<T> enumeration, T element) Check whether the given Enumeration contains the given element.
static <T> boolean	contains(Iterator<T> iterator, T element) Check whether the given Iterator contains the given element.
static <T> boolean	containsAny(Collection<T> source, Collection<T> candidates) Return true if any element in 'candidates' is contained in 'source'; otherwise returns false.
static <T> boolean	equals(Collection<T> c1, Collection<T> c2)
static <T> T	findFirstMatch(Collection<T> source, Collection<T> candidates) Return the first element in 'candidates' that is contained in 'source'.
static <T> T	findValueOfType(Collection<T> collection, Class<? extends T> type) Find a value of the given type in the given collection.
static <T> T	findValueOfType(Collection<T> collection, Class<? extends T>[] types) Find a value of one of the given types in the given collection: searching the collection for a value of the first type, then searching for a value of the second type, etc.
static <T> T	first(Collection<T> collection)
static <T> boolean	hasUniqueObject(Collection<T> collection) Determine whether the given collection only contains a single unique object.
static boolean	isEmpty(Collection<?> collection) Return true if the supplied Collection is null or empty.
static boolean	isEmpty(Map<?,?> map) Return true if the supplied Map is null or empty.
static void	mergePropertiesIntoMap(Properties props, Map<String,String> map) Merge the given Properties instance into the given Map, copying all properties (key-value pairs) over.
static <T> List<T>	toList(T... items) Converts the supplied array into a List.
static <T> Set<T>	toSet(T... items) Converts the supplied array into a Set.
static <T> List<T>	toUnmodifiableList(T... items)
static <T> Set<T>	toUnmodifiableSet(T... items)

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionUtils

public CollectionUtils()

Method Detail

isEmpty

public static boolean isEmpty(Collection<?> collection)

Return true if the supplied Collection is null or empty. Otherwise, return false.

Parameters:

collection - the Collection to check

isEmpty

public static boolean isEmpty(Map<?,?> map)

Return true if the supplied Map is null or empty. Otherwise, return false.

Parameters:

map - the Map to check

contains

public static <T> boolean contains(Iterator<T> iterator,
                                   T element)

Check whether the given Iterator contains the given element.

Parameters:

iterator - the Iterator to check

element - the element to look for

Returns:

true if found, false else

contains

public static <T> boolean contains(Enumeration<T> enumeration,
                                   T element)

Check whether the given Enumeration contains the given element.

Parameters:

enumeration - the Enumeration to check

element - the element to look for

Returns:

true if found, false else

hasUniqueObject

public static <T> boolean hasUniqueObject(Collection<T> collection)

Determine whether the given collection only contains a single unique object.

Parameters:

collection - the collection to check

Returns:

true if the collection contains a single reference or multiple references to the same instance, false else

findValueOfType

public static <T> T findValueOfType(Collection<T> collection,
                                    Class<? extends T> type)
                             throws IllegalArgumentException

Find a value of the given type in the given collection.

Parameters:

collection - the collection to search

type - the type to look for

Returns:

a value of the given type found, or null if none

Throws:

IllegalArgumentException - if more than one value of the given type found

findValueOfType

public static <T> T findValueOfType(Collection<T> collection,
                                    Class<? extends T>[] types)

Find a value of one of the given types in the given collection: searching the collection for a value of the first type, then searching for a value of the second type, etc.

Parameters:

collection - the collection to search

types - the types to look for, in prioritized order

Returns:

a of one of the given types found, or null if none

Throws:

IllegalArgumentException - if more than one value of the given type found

toList

public static <T> List<T> toList(T... items)

Converts the supplied array into a List.

Parameters:

source - the original array

Returns:

the converted List result

toUnmodifiableList

public static <T> List<T> toUnmodifiableList(T... items)

toSet

public static <T> Set<T> toSet(T... items)

Converts the supplied array into a Set.

Parameters:

source - the original array

Returns:

the converted List result

toUnmodifiableSet

public static <T> Set<T> toUnmodifiableSet(T... items)

mergePropertiesIntoMap

public static void mergePropertiesIntoMap(Properties props,
                                          Map<String,String> map)

Merge the given Properties instance into the given Map, copying all properties (key-value pairs) over.

Uses Properties.propertyNames() to even catch default properties linked into the original Properties instance.

Parameters:

props - the Properties instance to merge (may be null)

map - the target Map to merge the properties into

containsAny

public static <T> boolean containsAny(Collection<T> source,
                                      Collection<T> candidates)

Return true if any element in 'candidates' is contained in 'source'; otherwise returns false.

findFirstMatch

public static <T> T findFirstMatch(Collection<T> source,
                                   Collection<T> candidates)

Return the first element in 'candidates' that is contained in 'source'. If no element in 'candidates' is present in 'source' returns null. Iteration order is Collection implementation specific.

equals

public static <T> boolean equals(Collection<T> c1,
                                 Collection<T> c2)

cloneList

public static <T> List<T> cloneList(List<T> list)

cloneCollection

public static <T> Collection<T> cloneCollection(Collection<T> collection)

cloneMap

public static <K,V> Map<K,V> cloneMap(Map<K,V> map)

first

public static <T> T first(Collection<T> collection)