⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.collection

Class AbstractCollectionDecorator

java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator

All Implemented Interfaces:
Collection

Known Direct Subclasses:
AbstractBagDecorator, AbstractDualBidiMap.View, AbstractBufferDecorator, PredicatedCollection, TransformedCollection, UnmodifiableBoundedCollection, UnmodifiableCollection, AbstractListDecorator, AbstractSetDecorator


public abstract class AbstractCollectionDecorator
extends java.lang.Object
implements Collection

Decorates another 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
Authors:
Stephen Colebourne
Paul Jack

Field Summary

Collection

collection

The collection being decorated

Constructor Summary

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)

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()

Field Details

collection

protected final Collection collection

The collection being decorated

Constructor Details

AbstractCollectionDecorator

protected AbstractCollectionDecorator(Collection coll)

Constructor that wraps (not copies).

Parameters:
coll - the collection to decorate, must not be null
Throws:
- if the collection is null

Method Details

add

public boolean add(Object object)

Parameters:
object

addAll

public boolean addAll(Collection coll)

Parameters:
coll

clear

public void clear()


contains

public boolean contains(Object object)

Parameters:
object

containsAll

public boolean containsAll(Collection coll)

Parameters:
coll

equals

public boolean equals(Object object)

Parameters:
object

getCollection

protected Collection getCollection()

Gets the collection being decorated.

Returns:
the decorated collection

hashCode

public int hashCode()


isEmpty

public boolean isEmpty()


iterator

public Iterator iterator()


remove

public boolean remove(Object object)

Parameters:
object

removeAll

public boolean removeAll(Collection coll)

Parameters:
coll

retainAll

public boolean retainAll(Collection coll)

Parameters:
coll

size

public int size()


toArray

public Object[] toArray()


toArray

public Object[] toArray(Object[] object)

Parameters:
object

toString

public String toString()