org.apache.commons.collections.collection

Class AbstractCollectionDecorator

Implemented Interfaces:
Collection
Known Direct Subclasses:
AbstractBagDecorator, AbstractBufferDecorator, AbstractDualBidiMap.View, AbstractListDecorator, AbstractSerializableCollectionDecorator, 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.

Version:
$Revision: 1.4 $ $Date: 2004/06/02 21:53:03 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

Field Summary

protected Collection
collection
The collection being decorated

Constructor Summary

AbstractCollectionDecorator()
Constructor only used in deserialization, do not use otherwise.
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()

Field Details

collection

protected Collection collection
The collection being decorated

Constructor Details

AbstractCollectionDecorator

protected AbstractCollectionDecorator()
Constructor only used in deserialization, do not use otherwise.
Since:
Commons Collections 3.1

AbstractCollectionDecorator

protected AbstractCollectionDecorator(Collection coll)
Constructor that wraps (not copies).
Parameters:
coll - the collection to decorate, must not be null

Method Details

add

public boolean add(Object object)

addAll

public boolean addAll(Collection coll)

clear

public void clear()

contains

public boolean contains(Object object)

containsAll

public boolean containsAll(Collection coll)

equals

public boolean equals(Object 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)

removeAll

public boolean removeAll(Collection coll)

retainAll

public boolean retainAll(Collection coll)

size

public int size()

toArray

public Object[] toArray()

toArray

public Object[] toArray(Object[] object)

toString

public String toString()

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.