bak.pcj
Class UnmodifiableCharCollection

java.lang.Object
  bak.pcj.UnmodifiableCharCollection

All Implemented Interfaces:

CharCollection

Direct Known Subclasses:

UnmodifiableCharList, UnmodifiableCharSet

public class UnmodifiableCharCollection

extends Object

implements CharCollection

This class represents unmodifiable collections of char values.

Since:

1.0

See Also:

Collections.unmodifiableCollection(java.util.Collection)

Field Summary

protected CharCollection

collection The collection underlying this unmodifiable collection.

Constructor Summary

UnmodifiableCharCollection(CharCollection c)
Creates a new unmodifiable collection on an existing collection.

Method Summary

boolean	add(char v) Throws UnsupportedOperationException.
boolean	addAll(CharCollection c) Throws UnsupportedOperationException.
void	clear() Throws UnsupportedOperationException.
boolean	contains(char v) Indicates whether this collection contains a specified element.
boolean	containsAll(CharCollection c) Indicates whether all elements of a specified collection is contained in this collection.
boolean	equals(Object obj) Indicates whether this collection is equal to some object.
int	hashCode() Returns a hash code value for this collection.
boolean	isEmpty() Indicates whether this collection is empty.
CharIterator	iterator() Returns an iterator over this collection.
boolean	remove(char v) Throws UnsupportedOperationException.
boolean	removeAll(CharCollection c) Throws UnsupportedOperationException.
boolean	retainAll(CharCollection c) Throws UnsupportedOperationException.
int	size() Returns the number of elements in this collection.
char[]	toArray() Returns the elements of this collection as an array.
char[]	toArray(char[] a) Returns the elements of this collection as an array.
void	trimToSize() Minimizes the memory used by this collection.

Methods inherited from class java.lang.Object

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

Field Detail

collection

protected CharCollection collection

The collection underlying this unmodifiable collection.

Constructor Detail

UnmodifiableCharCollection

public UnmodifiableCharCollection(CharCollection c)

Creates a new unmodifiable collection on an existing collection. The result is a collection whose elements and behaviour is the same as the existing collection's except that the new collection cannot be modified.

Parameters:

c - the existing collection to make unmodifiable.

Throws:

NullPointerException - if c is null.

Method Detail

add

public boolean add(char v)

Throws UnsupportedOperationException.

Specified by:

add in interface CharCollection

Parameters:

v - the element to add to this collection.

Returns:

true if this collection was modified as a result of adding v; returns false otherwise.

Throws:

UnsupportedOperationException - unconditionally.

See Also:

CharCollection.addAll(CharCollection)

addAll

public boolean addAll(CharCollection c)

Throws UnsupportedOperationException.

Specified by:

addAll in interface CharCollection

Parameters:

c - the collection whose elements to add to this collection.

Returns:

true if this collection was modified as a result of adding the elements of c; returns false otherwise.

Throws:

UnsupportedOperationException - unconditionally.

See Also:

CharCollection.add(char)

clear

public void clear()

Throws UnsupportedOperationException.

Specified by:

clear in interface CharCollection

Throws:

UnsupportedOperationException - unconditionally.

contains

public boolean contains(char v)

Description copied from interface: CharCollection

Indicates whether this collection contains a specified element.

Specified by:

contains in interface CharCollection

Parameters:

v - the element to test for containment.

Returns:

true if v is contained in this collection; returns false otherwise.

See Also:

CharCollection.containsAll(CharCollection)

containsAll

public boolean containsAll(CharCollection c)

Description copied from interface: CharCollection

Indicates whether all elements of a specified collection is contained in this collection.

Specified by:

containsAll in interface CharCollection

Parameters:

c - the collection whose elements to test for containment.

Returns:

true if all the elements of c are contained in this collection; returns false otherwise.

See Also:

CharCollection.contains(char)

equals

public boolean equals(Object obj)

Description copied from interface: CharCollection

Indicates whether this collection is equal to some object.

Specified by:

equals in interface CharCollection

hashCode

public int hashCode()

Description copied from interface: CharCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface CharCollection

isEmpty

public boolean isEmpty()

Description copied from interface: CharCollection

Indicates whether this collection is empty.

Specified by:

isEmpty in interface CharCollection

Returns:

true if this collection is empty; returns false otherwise.

iterator

public CharIterator iterator()

Description copied from interface: CharCollection

Returns an iterator over this collection.

Specified by:

iterator in interface CharCollection

Returns:

an iterator over this collection.

remove

public boolean remove(char v)

Throws UnsupportedOperationException.

Specified by:

remove in interface CharCollection

Parameters:

v - the char value to remove from this collection.

Returns:

true if this collection was modified as a result of removing v; returns false otherwise.

Throws:

UnsupportedOperationException - unconditionally.

removeAll

public boolean removeAll(CharCollection c)

Throws UnsupportedOperationException.

Specified by:

removeAll in interface CharCollection

Parameters:

c - the collection whose elements to remove from this collection.

Returns:

true if this collection was modified as a result of removing the elements of c; returns false otherwise.

Throws:

UnsupportedOperationException - unconditionally.

retainAll

public boolean retainAll(CharCollection c)

Throws UnsupportedOperationException.

Specified by:

retainAll in interface CharCollection

Parameters:

c - the collection whose elements to retain in this collection.

Returns:

true if this collection was modified as a result of removing the elements not contained in c; returns false otherwise.

Throws:

UnsupportedOperationException - unconditionally.

size

public int size()

Description copied from interface: CharCollection

Returns the number of elements in this collection.

Specified by:

size in interface CharCollection

Returns:

the number of elements in this collection.

toArray

public char[] toArray()

Description copied from interface: CharCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface CharCollection

Returns:

a new array containing the elements of this collection.

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface CharCollection

Parameters:

a - an array to fill with the elements of this collection; if a is null or not big enough to contain all the elements of this collection, an new array is allocated, and a is not changed.

Returns:

a, if a has room for all the elements of this collection; otherwise a new array is allocated, filled with the elements of this collection, and returned.

trimToSize

public void trimToSize()

Description copied from interface: CharCollection

Minimizes the memory used by this collection. The exact operation of this method depends on the class implementing it. Implementors may choose to ignore it completely.

Specified by:

trimToSize in interface CharCollection