gnu.trove
Interface TCharCollection

All Known Subinterfaces:

TCharList, TCharQueue, TCharSet

All Known Implementing Classes:

TByteCharHashMap.TValueView, TCharArrayList, TCharByteHashMap.TKeyView, TCharCharHashMap.TKeyView, TCharCharHashMap.TValueView, TCharDoubleHashMap.TKeyView, TCharFloatHashMap.TKeyView, TCharHashSet, TCharIntHashMap.TKeyView, TCharLinkedList, TCharLongHashMap.TKeyView, TCharShortHashMap.TKeyView, TDoubleCharHashMap.TValueView, TFloatCharHashMap.TValueView, TIntCharHashMap.TValueView, TLongCharHashMap.TValueView, TShortCharHashMap.TValueView

public interface TCharCollection

An interface that mimics the Collection interface.

Field Summary

static long

serialVersionUID

Method Summary

boolean	add(char entry) Inserts a value into the collection.
boolean	addAll(char[] array) Adds all of the elements in the array to the collection.
boolean	addAll(java.util.Collection<? extends java.lang.Character> collection) Adds all of the elements in collection to the collection.
boolean	addAll(TCharCollection collection) Adds all of the elements in the TCharCollection to the collection.
void	clear() Empties the collection.
boolean	contains(char entry) Returns true if this collection contains the specified element.
boolean	containsAll(char[] array) Tests the collection to determine if all of the elements in array are present.
boolean	containsAll(java.util.Collection<?> collection) Tests the collection to determine if all of the elements in collection are present.
boolean	containsAll(TCharCollection collection) Tests the collection to determine if all of the elements in TCharCollection are present.
boolean	equals(java.lang.Object o) Compares the specified object with this collection for equality.
boolean	forEach(TCharProcedure procedure) Executes procedure for each element in the collection.
char	getNoEntryValue() Returns the value that is used to represent null.
int	hashCode() Returns the hash code value for this collection.
boolean	isEmpty() Returns true if this collection contains no elements.
TCharIterator	iterator() Creates an iterator over the values of the collection.
boolean	remove(char entry) Removes entry from the collection.
boolean	removeAll(char[] array) Removes all of the elements in array from the collection.
boolean	removeAll(java.util.Collection<?> collection) Removes all of the elements in collection from the collection.
boolean	removeAll(TCharCollection collection) Removes all of the elements in TCharCollection from the collection.
boolean	retainAll(char[] array) Removes any values in the collection which are not contained in array.
boolean	retainAll(java.util.Collection<?> collection) Removes any values in the collection which are not contained in collection.
boolean	retainAll(TCharCollection collection) Removes any values in the collection which are not contained in TCharCollection.
int	size() Returns the number of elements in this collection (its cardinality).
char[]	toArray() Returns an array containing all of the elements in this collection.
char[]	toArray(char[] dest) Returns an array containing elements in this collection.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getNoEntryValue

char getNoEntryValue()

Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Returns:

the value that represents null

size

int size()

Returns the number of elements in this collection (its cardinality). If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of elements in this collection (its cardinality)

isEmpty

boolean isEmpty()

Returns true if this collection contains no elements.

Returns:

true if this collection contains no elements

contains

boolean contains(char entry)

Returns true if this collection contains the specified element.

Parameters:

entry - an char value

Returns:

true if the collection contains the specified element.

iterator

TCharIterator iterator()

Creates an iterator over the values of the collection. The iterator supports element deletion.

Returns:

an TCharIterator value

toArray

char[] toArray()

Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:

an array containing all the elements in this collection

toArray

char[] toArray(char[] dest)

Returns an array containing elements in this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is collection to getNoEntryValue(). (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any elements representing null.)

If the native array is smaller than the collection size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Parameters:

dest - the array into which the elements of this collection are to be stored.

Returns:

an char[] containing all the elements in this collection

Throws:

java.lang.NullPointerException - if the specified array is null

add

boolean add(char entry)

Inserts a value into the collection.

Parameters:

entry - a char value

Returns:

true if the collection was modified by the add operation

remove

boolean remove(char entry)

Removes entry from the collection.

Parameters:

entry - an char value

Returns:

true if the collection was modified by the remove operation.

containsAll

boolean containsAll(java.util.Collection<?> collection)

Tests the collection to determine if all of the elements in collection are present.

Parameters:

collection - a Collection value

Returns:

true if all elements were present in the collection.

containsAll

boolean containsAll(TCharCollection collection)

Tests the collection to determine if all of the elements in TCharCollection are present.

Parameters:

collection - a TCharCollection value

Returns:

true if all elements were present in the collection.

containsAll

boolean containsAll(char[] array)

Tests the collection to determine if all of the elements in array are present.

Parameters:

array - as array of char primitives.

Returns:

true if all elements were present in the collection.

addAll

boolean addAll(java.util.Collection<? extends java.lang.Character> collection)

Adds all of the elements in collection to the collection.

Parameters:

collection - a Collection value

Returns:

true if the collection was modified by the add all operation.

addAll

boolean addAll(TCharCollection collection)

Adds all of the elements in the TCharCollection to the collection.

Parameters:

collection - a TCharCollection value

Returns:

true if the collection was modified by the add all operation.

addAll

boolean addAll(char[] array)

Adds all of the elements in the array to the collection.

Parameters:

array - a array of char primitives.

Returns:

true if the collection was modified by the add all operation.

retainAll

boolean retainAll(java.util.Collection<?> collection)

Removes any values in the collection which are not contained in collection.

Parameters:

collection - a Collection value

Returns:

true if the collection was modified by the retain all operation

retainAll

boolean retainAll(TCharCollection collection)

Removes any values in the collection which are not contained in TCharCollection.

Parameters:

collection - a TCharCollection value

Returns:

true if the collection was modified by the retain all operation

retainAll

boolean retainAll(char[] array)

Removes any values in the collection which are not contained in array.

Parameters:

array - an array of char primitives.

Returns:

true if the collection was modified by the retain all operation

removeAll

boolean removeAll(java.util.Collection<?> collection)

Removes all of the elements in collection from the collection.

Parameters:

collection - a Collection value

Returns:

true if the collection was modified by the remove all operation.

removeAll

boolean removeAll(TCharCollection collection)

Removes all of the elements in TCharCollection from the collection.

Parameters:

collection - a TCharCollection value

Returns:

true if the collection was modified by the remove all operation.

removeAll

boolean removeAll(char[] array)

Removes all of the elements in array from the collection.

Parameters:

array - an array of char primitives.

Returns:

true if the collection was modified by the remove all operation.

clear

void clear()

Empties the collection.

forEach

boolean forEach(TCharProcedure procedure)

Executes procedure for each element in the collection.

Parameters:

procedure - a TCharProcedure value

Returns:

false if the loop over the collection terminated because the procedure returned false for some value.

equals

boolean equals(java.lang.Object o)

Compares the specified object with this collection for equality. Returns true if the specified object is also a collection, the two collection have the same size, and every member of the specified collection is contained in this collection (or equivalently, every member of this collection is contained in the specified collection). This definition ensures that the equals method works properly across different implementations of the collection interface.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to be compared for equality with this collection

Returns:

true if the specified object is equal to this collection

hashCode

int hashCode()

Returns the hash code value for this collection. The hash code of a collection is defined to be the sum of the hash codes of the elements in the collection. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two collection s1 and s2, as required by the general contract of Object.hashCode().

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this collection

See Also:

Object.equals(Object), Collection.equals(Object)