org.key_project.util.java

Class CollectionUtil

java.lang.Object

org.key_project.util.java.CollectionUtil

public class CollectionUtil
extends java.lang.Object

Provides static methods to work with Collections.

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SEPARATOR The default separator.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CollectionUtil() Forbid instances by this private constructor.

Method Summary

Modifier and Type	Method and Description
static <T> void	addAll(java.util.Collection<T> collection, java.lang.Iterable<T> iterable) Adds all elements to the Collection.
static <T> void	addAll(java.util.Collection<T> collection, T... elementsToAdd) Adds all elements to the Collection.
static <T> java.util.List<T>	arrayToList(T[] array) Converts the given array to a new List.
static <T> void	binaryInsert(java.util.List<T> list, T toInsert, java.util.Comparator<T> comparator) Performs a binary insert on the given sorted List.
static <T> boolean	contains(java.lang.Iterable<T> iterable, T element) Checks if the given element is contained in the given Iterable.
static <T> boolean	containsSame(java.util.Collection<T> first, java.util.Collection<T> second) Checks if the given two Collections contains the same elements in any order.
static <T> int	count(java.lang.Iterable<T> iterable, IFilter<T> filter) Counts the number of elements in the given Iterable which are selected by the given IFilter.
static <T> T	getFirst(java.lang.Iterable<T> iterable) Returns the first element from the given Iterable.
static <T> int	indexOf(java.util.Iterator<T> iter, T toSearch) Returns the index of the element to search in the given iterator.
static boolean	isEmpty(java.util.Collection<?> collection) Nullpointersave execution of Collection.isEmpty().
static boolean	isEmpty(java.util.Map<?,?> map) Nullpointersave execution of Map.isEmpty().
static <T> boolean	removeAll(java.util.Collection<T> collection, T... elementsToRemove) Removes all elements from the Collection.
static <T> boolean	removeComplete(java.util.Collection<T> collection, T toRemove) Removes all occurrences of the element in the given Collection.
static <T> T	removeFirst(java.lang.Iterable<T> iterable) Removes the first element from the given Iterable.
static <T> T	search(java.lang.Iterable<T> iterable, IFilter<T> filter) Searches an element in the given Iterable instance.
static <T> java.util.List<T>	searchAll(java.lang.Iterable<T> iterable, IFilter<T> filter) Searches all elements accepted by the given IFilter.
static <T> T	searchAndRemove(java.lang.Iterable<T> iterable, IFilter<T> filter) Searches an element in the given Iterable instance and removes the found element from it.
static <T,E extends java.lang.Throwable> T	searchAndRemoveWithException(java.lang.Iterable<T> iterable, IFilterWithException<T,E> filter) Searches an element in the given Iterable instance and removes the found element from it.
static <T> java.util.List<T>	toList(T... objects) Converts the given objects into a List.
static <T> java.util.Set<T>	toSet(T... objects) Converts the given objects into a Set.
static java.lang.String	toString(java.util.Collection<?> collection) Converts the Collection into a String.
static java.lang.String	toString(java.util.Collection<?> collection, java.lang.String separator) Converts the Collection into a String and uses the defined separator to separate elements.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

The default separator.

See Also:

Constant Field Values

Constructor Detail

CollectionUtil

private CollectionUtil()

Forbid instances by this private constructor.

Method Detail

indexOf

public static <T> int indexOf(java.util.Iterator<T> iter,
                              T toSearch)

Returns the index of the element to search in the given iterator.

Parameters:

iter - The iterator to search in.

toSearch - The element to search.

Returns:

The index of the element or -1 if it was not found.

toString

public static java.lang.String toString(java.util.Collection<?> collection)

Converts the Collection into a String.

Parameters:

collection - The Collection to convert.

Returns:

The Collection as String.

toString

public static java.lang.String toString(java.util.Collection<?> collection,
                                        java.lang.String separator)

Converts the Collection into a String and uses the defined separator to separate elements.

Parameters:

collection - The Collection to convert.

separator - The separator between elements.

Returns:

The Collection as String.

isEmpty

public static boolean isEmpty(java.util.Collection<?> collection)

Nullpointersave execution of Collection.isEmpty().

Parameters:

collection - The given Collection.

Returns:

true = is empty or null, false = is not empty.

isEmpty

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

Nullpointersave execution of Map.isEmpty().

Parameters:

map - The given Map.

Returns:

true = is empty or null, false = is not empty.

toList

public static <T> java.util.List<T> toList(T... objects)

Converts the given objects into a List.

Type Parameters:

T - The type of the objects.

Parameters:

objects - The objects array to convert.

Returns:

The created List.

toSet

public static <T> java.util.Set<T> toSet(T... objects)

Converts the given objects into a Set.

Type Parameters:

T - The type of the objects.

Parameters:

objects - The objects array to convert.

Returns:

The created Set.

addAll

public static <T> void addAll(java.util.Collection<T> collection,
                              T... elementsToAdd)

Adds all elements to the Collection.

Type Parameters:

T - The type of the Collections elements.

Parameters:

collection - The Collection to add to.

elementsToAdd - The elements to add.

addAll

public static <T> void addAll(java.util.Collection<T> collection,
                              java.lang.Iterable<T> iterable)

Adds all elements to the Collection.

Type Parameters:

T - The type of the Collections elements.

Parameters:

collection - The Collection to add to.

elementsToAdd - The elements to add.

removeAll

public static <T> boolean removeAll(java.util.Collection<T> collection,
                                    T... elementsToRemove)

Removes all elements from the Collection.

Type Parameters:

T - The type of the Collections elements.

Parameters:

collection - The Collection to remove from.

elementsToRemove - The elements to remove.

Returns:

true if the Collection changed as result of this call.

removeComplete

public static <T> boolean removeComplete(java.util.Collection<T> collection,
                                         T toRemove)

Removes all occurrences of the element in the given Collection.

Parameters:

collection - The Collection to remove from.

toRemove - The element to remove.

Returns:

true if at least one element was removed, false if the Collection was not modified.

searchAll

public static <T> java.util.List<T> searchAll(java.lang.Iterable<T> iterable,
                                              IFilter<T> filter)

Searches all elements accepted by the given IFilter.

Parameters:

iterable - The Iterable to search in.

filter - The IFilter to use.

Returns:

The elements accepted by the given IFilter.

search

public static <T> T search(java.lang.Iterable<T> iterable,
                           IFilter<T> filter)

Searches an element in the given Iterable instance.

Parameters:

iterable - The instance to search in.

filter - The filter to select an element.

Returns:

The found element or null if no element was found.

searchAndRemove

public static <T> T searchAndRemove(java.lang.Iterable<T> iterable,
                                    IFilter<T> filter)

Searches an element in the given Iterable instance and removes the found element from it.

Parameters:

iterable - The instance to search in.

filter - The filter to select an element.

Returns:

The found element or null if no element was found.

searchAndRemoveWithException

public static <T,E extends java.lang.Throwable> T searchAndRemoveWithException(java.lang.Iterable<T> iterable,
                                                                               IFilterWithException<T,E> filter)
                                                                        throws E extends java.lang.Throwable

Searches an element in the given Iterable instance and removes the found element from it.

Parameters:

iterable - The instance to search in.

filter - The filter to select an element.

Returns:

The found element or null if no element was found.

Throws:

E extends java.lang.Throwable

contains

public static <T> boolean contains(java.lang.Iterable<T> iterable,
                                   T element)

Checks if the given element is contained in the given Iterable.

Parameters:

iterable - The given Iterable to search in.

element - The element to search.

Returns:

true = contained, false = not contained

count

public static <T> int count(java.lang.Iterable<T> iterable,
                            IFilter<T> filter)

Counts the number of elements in the given Iterable which are selected by the given IFilter.

Parameters:

iterable - The elements to count in.

filter - The IFilter to select elements.

Returns:

The number of elements selected by the IFilter in the given Iterable.

containsSame

public static <T> boolean containsSame(java.util.Collection<T> first,
                                       java.util.Collection<T> second)

Checks if the given two Collections contains the same elements in any order.

Empty Collections and null parameters are treated as equal.

Parameters:

first - The first Collection.

second - The second Collection.

Returns:

true both Collections contains same elements, false Collections are different.

getFirst

public static <T> T getFirst(java.lang.Iterable<T> iterable)

Returns the first element from the given Iterable.

Parameters:

iterable - The Iterable to get first element from.

Returns:

The first element or null if no element is available.

removeFirst

public static <T> T removeFirst(java.lang.Iterable<T> iterable)

Removes the first element from the given Iterable.

Parameters:

iterable - The Iterable to remove first element from.

Returns:

The removed first element or null if no element was removed.

arrayToList

public static <T> java.util.List<T> arrayToList(T[] array)

Converts the given array to a new List.

Parameters:

array - to be converted.

Returns:

the new List containing all array elements.

binaryInsert

public static <T> void binaryInsert(java.util.List<T> list,
                                    T toInsert,
                                    java.util.Comparator<T> comparator)

Performs a binary insert on the given sorted List.

Parameters:

list - The sorted List to insert in.

toInsert - The element to insert.

comparator - The Comparator to use.