org.apache.commons.collections.collection
public abstract class AbstractCollectionDecorator extends Object implements Collection
Collection
to provide additional behaviour.
Each method call made on this Collection
is forwarded to the
decorated Collection
. This class is used as a framework on which
to build to extensions such as synchronized and unmodifiable behaviour. The
main advantage of decoration is that one decorator can wrap any implementation
of Collection
, whereas sub-classing requires a new class to be
written for each implementation.
This implementation does not perform any special processing with iterator. Instead it simply returns the value from the wrapped collection. This may be undesirable, for example if you are trying to write an unmodifiable implementation it might provide a loophole.
Since: Commons Collections 3.0
Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
Field Summary | |
---|---|
protected Collection | collection The collection being decorated |
Constructor Summary | |
---|---|
protected | AbstractCollectionDecorator()
Constructor only used in deserialization, do not use otherwise. |
protected | AbstractCollectionDecorator(Collection coll)
Constructor that wraps (not copies).
|
Method Summary | |
---|---|
boolean | add(Object object) |
boolean | addAll(Collection coll) |
void | clear() |
boolean | contains(Object object) |
boolean | containsAll(Collection coll) |
boolean | equals(Object object) |
protected Collection | getCollection()
Gets the collection being decorated.
|
int | hashCode() |
boolean | isEmpty() |
Iterator | iterator() |
boolean | remove(Object object) |
boolean | removeAll(Collection coll) |
boolean | retainAll(Collection coll) |
int | size() |
Object[] | toArray() |
Object[] | toArray(Object[] object) |
String | toString() |
Since: Commons Collections 3.1
Parameters: coll the collection to decorate, must not be null
Throws: IllegalArgumentException if the collection is null
Returns: the decorated collection