gnu.trove.impl.unmodifiable

Class TUnmodifiableCharCollection

java.lang.Object

gnu.trove.impl.unmodifiable.TUnmodifiableCharCollection

All Implemented Interfaces:

TCharCollection, java.io.Serializable

Direct Known Subclasses:

TUnmodifiableCharList, TUnmodifiableCharSet

public class TUnmodifiableCharCollection
extends java.lang.Object
implements TCharCollection, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TUnmodifiableCharCollection(TCharCollection c)

Method Summary

Modifier and Type	Method and Description
boolean	add(char e) 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> coll) Adds all of the elements in collection to the collection.
boolean	addAll(TCharCollection coll) Adds all of the elements in the TCharCollection to the collection.
void	clear() Empties the collection.
boolean	contains(char o) 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<?> coll) Tests the collection to determine if all of the elements in collection are present.
boolean	containsAll(TCharCollection coll) Tests the collection to determine if all of the elements in TCharCollection are present.
boolean	forEach(TCharProcedure procedure) Executes procedure for each element in the collection.
char	getNoEntryValue() Returns the value that is used to represent null.
boolean	isEmpty() Returns true if this collection contains no elements.
TCharIterator	iterator() Creates an iterator over the values of the collection.
boolean	remove(char o) Removes entry from the collection.
boolean	removeAll(char[] array) Removes all of the elements in array from the collection.
boolean	removeAll(java.util.Collection<?> coll) Removes all of the elements in collection from the collection.
boolean	removeAll(TCharCollection coll) 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<?> coll) Removes any values in the collection which are not contained in collection.
boolean	retainAll(TCharCollection coll) 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[] a) Returns an array containing elements in this collection.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface gnu.trove.TCharCollection

equals, hashCode

Constructor Detail

TUnmodifiableCharCollection

public TUnmodifiableCharCollection(TCharCollection c)

Method Detail

size

public int size()

Description copied from interface: TCharCollection

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

Specified by:

size in interface TCharCollection

Returns:

the number of elements in this collection (its cardinality)

isEmpty

public boolean isEmpty()

Description copied from interface: TCharCollection

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface TCharCollection

Returns:

true if this collection contains no elements

contains

public boolean contains(char o)

Description copied from interface: TCharCollection

Returns true if this collection contains the specified element.

Specified by:

contains in interface TCharCollection

Parameters:

o - an char value

Returns:

true if the collection contains the specified element.

toArray

public char[] toArray()

Description copied from interface: TCharCollection

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.

Specified by:

toArray in interface TCharCollection

Returns:

an array containing all the elements in this collection

toArray

public char[] toArray(char[] a)

Description copied from interface: TCharCollection

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 TCharCollection.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.

Specified by:

toArray in interface TCharCollection

Parameters:

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

Returns:

an char[] containing all the elements in this collection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNoEntryValue

public char getNoEntryValue()

Description copied from interface: TCharCollection

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

Specified by:

getNoEntryValue in interface TCharCollection

Returns:

the value that represents null

forEach

public boolean forEach(TCharProcedure procedure)

Description copied from interface: TCharCollection

Executes procedure for each element in the collection.

Specified by:

forEach in interface TCharCollection

Parameters:

procedure - a TCharProcedure value

Returns:

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

iterator

public TCharIterator iterator()

Description copied from interface: TCharCollection

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

Specified by:

iterator in interface TCharCollection

Returns:

an TCharIterator value

add

public boolean add(char e)

Description copied from interface: TCharCollection

Inserts a value into the collection.

Specified by:

add in interface TCharCollection

Parameters:

e - a char value

Returns:

true if the collection was modified by the add operation

remove

public boolean remove(char o)

Description copied from interface: TCharCollection

Removes entry from the collection.

Specified by:

remove in interface TCharCollection

Parameters:

o - an char value

Returns:

true if the collection was modified by the remove operation.

containsAll

public boolean containsAll(java.util.Collection<?> coll)

Description copied from interface: TCharCollection

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

Specified by:

containsAll in interface TCharCollection

Parameters:

coll - a Collection value

Returns:

true if all elements were present in the collection.

containsAll

public boolean containsAll(TCharCollection coll)

Description copied from interface: TCharCollection

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

Specified by:

containsAll in interface TCharCollection

Parameters:

coll - a TCharCollection value

Returns:

true if all elements were present in the collection.

containsAll

public boolean containsAll(char[] array)

Description copied from interface: TCharCollection

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

Specified by:

containsAll in interface TCharCollection

Parameters:

array - as array of char primitives.

Returns:

true if all elements were present in the collection.

addAll

public boolean addAll(TCharCollection coll)

Description copied from interface: TCharCollection

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

Specified by:

addAll in interface TCharCollection

Parameters:

coll - a TCharCollection value

Returns:

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

addAll

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

Description copied from interface: TCharCollection

Adds all of the elements in collection to the collection.

Specified by:

addAll in interface TCharCollection

Parameters:

coll - a Collection value

Returns:

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

addAll

public boolean addAll(char[] array)

Description copied from interface: TCharCollection

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

Specified by:

addAll in interface TCharCollection

Parameters:

array - a array of char primitives.

Returns:

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

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Description copied from interface: TCharCollection

Removes all of the elements in collection from the collection.

Specified by:

removeAll in interface TCharCollection

Parameters:

coll - a Collection value

Returns:

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

removeAll

public boolean removeAll(TCharCollection coll)

Description copied from interface: TCharCollection

Removes all of the elements in TCharCollection from the collection.

Specified by:

removeAll in interface TCharCollection

Parameters:

coll - a TCharCollection value

Returns:

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

removeAll

public boolean removeAll(char[] array)

Description copied from interface: TCharCollection

Removes all of the elements in array from the collection.

Specified by:

removeAll in interface TCharCollection

Parameters:

array - an array of char primitives.

Returns:

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

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Description copied from interface: TCharCollection

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

Specified by:

retainAll in interface TCharCollection

Parameters:

coll - a Collection value

Returns:

true if the collection was modified by the retain all operation

retainAll

public boolean retainAll(TCharCollection coll)

Description copied from interface: TCharCollection

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

Specified by:

retainAll in interface TCharCollection

Parameters:

coll - a TCharCollection value

Returns:

true if the collection was modified by the retain all operation

retainAll

public boolean retainAll(char[] array)

Description copied from interface: TCharCollection

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

Specified by:

retainAll in interface TCharCollection

Parameters:

array - an array of char primitives.

Returns:

true if the collection was modified by the retain all operation

clear

public void clear()

Description copied from interface: TCharCollection

Empties the collection.

Specified by:

clear in interface TCharCollection