AbstractCollectionDecorator (Commons Collections 4.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.collections.collection
Class AbstractCollectionDecorator<E>

java.lang.Object
  org.apache.commons.collections.collection.AbstractCollectionDecorator<E>

All Implemented Interfaces:: Iterable<E>, Collection<E>

Direct Known Subclasses:: AbstractBagDecorator, AbstractBufferDecorator, AbstractDualBidiMap.View, AbstractListDecorator, AbstractSerializableCollectionDecorator, AbstractSetDecorator

public abstract class AbstractCollectionDecorator<E>
extends Object
implements Collection<E>
extends Object
implements Collection<E>

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
Version:: $Revision: 1.1.1.1 $ $Date: 2005/05/23 04:33:58 $
Author:: Stephen Colebourne, Matt Hall, John Watkinson, Paul Jack

Field Summary
`protected Collection<E>`	`collection` The collection being decorated

Constructor Summary
`protected`	`AbstractCollectionDecorator()` Constructor only used in deserialization, do not use otherwise.
`protected`	`AbstractCollectionDecorator(Collection<E> coll)` Constructor that wraps (not copies).

Method Summary

boolean add(E object)

boolean addAll(Collection<? extends E> coll)

void clear()

boolean contains(Object object)

boolean containsAll(Collection<?> coll)

boolean equals(Object object)

protected Collection<E> getCollection()
Gets the collection being decorated.

int hashCode()

boolean isEmpty()

Iterator<E> iterator()

boolean remove(Object object)

boolean removeAll(Collection<?> coll)

boolean retainAll(Collection<?> coll)

int size()

Object[] toArray()





<T> T[]

toArray(T[] object)

String toString()

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

collection

protected Collection<E> collection

The collection being decorated

Constructor Detail