org.jlog2.util

Class CollectionHandler

java.lang.Object

org.jlog2.util.CollectionHandler

public class CollectionHandler
extends java.lang.Object

This provides some utility functions for java.util collections or lists, etc.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
CollectionHandler()

Method Summary

Modifier and Type	Method and Description
static <T> void	addAll(java.util.ArrayList<T> addTo, java.util.ArrayList<T> toAdd) Add all values in toAdd to addTo, allowing repeat values.
static <T> void	addAllSet(java.util.ArrayList<T> addTo, java.util.ArrayList<T> toAdd) Add all values in toAdd to addTo, but do not allow duplication of existing values.
static <K,V> java.util.ArrayList<K>	cloneHashKeys(java.util.HashMap<K,V> toClone) Clone the hashtable keys and return as a list.
static <K,V> java.util.HashMap<K,V>	cloneHashtable(java.util.HashMap<K,V> toClone) Clone the hashtable list and return.
static <K,V> java.util.ArrayList<V>	cloneHashValues(java.util.HashMap<K,V> toClone) Clone the hashtable values and return as a list.
static <T> java.util.ArrayList	cloneVector(java.util.ArrayList<T> toClone) Clone the vector list and return.
static <T> java.util.ArrayList	combinedVector(java.util.ArrayList<T> list1, java.util.ArrayList<T> list2) Return a list of all elements that are in both list 1 and list 2.
static <K,V> void	putAll(java.util.HashMap<K,V> addTo, java.util.HashMap<K,V> toAdd) Add all values in toAdd to addTo.
static <T> java.util.ArrayList<T>	reciprocalVector(java.util.ArrayList<T> list1, java.util.ArrayList<T> list2) Return a list of all elements that are in list 1 but not in list 2.
static <T> void	removeAll(java.util.ArrayList<T> removeFrom, java.util.ArrayList<T> toRemove) Remove all values in toRemove from removeFrom.
static <T> T[]	toArray(java.util.ArrayList<T> toClone) Clone the list and return as an array.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionHandler

public CollectionHandler()

Method Detail

cloneVector

public static <T> java.util.ArrayList cloneVector(java.util.ArrayList<T> toClone)

Clone the vector list and return.

Parameters:

toClone - the list to clone.

Returns:

a light copy (clone list only) of the vector.

addAll

public static <T> void addAll(java.util.ArrayList<T> addTo,
                              java.util.ArrayList<T> toAdd)

Add all values in toAdd to addTo, allowing repeat values.

Parameters:

addTo - the list to add to.

toAdd - the values to add.

addAllSet

public static <T> void addAllSet(java.util.ArrayList<T> addTo,
                                 java.util.ArrayList<T> toAdd)

Add all values in toAdd to addTo, but do not allow duplication of existing values.

Parameters:

addTo - the list to add to.

toAdd - the values to add.

removeAll

public static <T> void removeAll(java.util.ArrayList<T> removeFrom,
                                 java.util.ArrayList<T> toRemove)

Remove all values in toRemove from removeFrom.

Parameters:

removeFrom - the list to remove from.

toRemove - the list of items to remove.

combinedVector

public static <T> java.util.ArrayList combinedVector(java.util.ArrayList<T> list1,
                                                     java.util.ArrayList<T> list2)

Return a list of all elements that are in both list 1 and list 2.

Parameters:

list1 - the first list of indexes.

list2 - the second list of indexes.

Returns:

a list of all indexes in both lists.

reciprocalVector

public static <T> java.util.ArrayList<T> reciprocalVector(java.util.ArrayList<T> list1,
                                                          java.util.ArrayList<T> list2)

Return a list of all elements that are in list 1 but not in list 2.

Parameters:

list1 - the first list of indexes.

list2 - the second list of indexes.

Returns:

a list of all indexes in list 1 but not in list 2.

toArray

public static <T> T[] toArray(java.util.ArrayList<T> toClone)

Clone the list and return as an array.

Parameters:

toClone - the list to clone.

Returns:

a copy of the elements in an array list.

cloneHashtable

public static <K,V> java.util.HashMap<K,V> cloneHashtable(java.util.HashMap<K,V> toClone)

Clone the hashtable list and return.

Parameters:

toClone - the list to clone.

Returns:

a light copy (clone list only) of the hashtable.

cloneHashKeys

public static <K,V> java.util.ArrayList<K> cloneHashKeys(java.util.HashMap<K,V> toClone)

Clone the hashtable keys and return as a list.

Parameters:

toClone - the list to clone.

Returns:

a light copy (clone list only) of the hashtable keys.

cloneHashValues

public static <K,V> java.util.ArrayList<V> cloneHashValues(java.util.HashMap<K,V> toClone)

Clone the hashtable values and return as a list.

Parameters:

toClone - the list to clone.

Returns:

a light copy (clone list only) of the hashtable values.

putAll

public static <K,V> void putAll(java.util.HashMap<K,V> addTo,
                                java.util.HashMap<K,V> toAdd)

Add all values in toAdd to addTo.

Parameters:

addTo - the hashtable to add to.

toAdd - the values to add.