|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.collection.AbstractCollectionDecorator
public abstract class AbstractCollectionDecorator
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.
| Field Summary | |
|---|---|
protected java.util.Collection |
collection
The collection being decorated |
| Constructor Summary | |
|---|---|
protected |
AbstractCollectionDecorator()
Constructor only used in deserialization, do not use otherwise. |
protected |
AbstractCollectionDecorator(java.util.Collection coll)
Constructor that wraps (not copies). |
| Method Summary | |
|---|---|
boolean |
add(java.lang.Object object)
|
boolean |
addAll(java.util.Collection coll)
|
void |
clear()
|
boolean |
contains(java.lang.Object object)
|
boolean |
containsAll(java.util.Collection coll)
|
boolean |
equals(java.lang.Object object)
|
protected java.util.Collection |
getCollection()
Gets the collection being decorated. |
int |
hashCode()
|
boolean |
isEmpty()
|
java.util.Iterator |
iterator()
|
boolean |
remove(java.lang.Object object)
|
boolean |
removeAll(java.util.Collection coll)
|
boolean |
retainAll(java.util.Collection coll)
|
int |
size()
|
java.lang.Object[] |
toArray()
|
java.lang.Object[] |
toArray(java.lang.Object[] object)
|
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected java.util.Collection collection
| Constructor Detail |
|---|
protected AbstractCollectionDecorator()
protected AbstractCollectionDecorator(java.util.Collection coll)
coll - the collection to decorate, must not be null
java.lang.IllegalArgumentException - if the collection is null| Method Detail |
|---|
protected java.util.Collection getCollection()
public boolean add(java.lang.Object object)
add in interface java.util.Collectionpublic boolean addAll(java.util.Collection coll)
addAll in interface java.util.Collectionpublic void clear()
clear in interface java.util.Collectionpublic boolean contains(java.lang.Object object)
contains in interface java.util.Collectionpublic boolean isEmpty()
isEmpty in interface java.util.Collectionpublic java.util.Iterator iterator()
iterator in interface java.lang.Iterableiterator in interface java.util.Collectionpublic boolean remove(java.lang.Object object)
remove in interface java.util.Collectionpublic int size()
size in interface java.util.Collectionpublic java.lang.Object[] toArray()
toArray in interface java.util.Collectionpublic java.lang.Object[] toArray(java.lang.Object[] object)
toArray in interface java.util.Collectionpublic boolean containsAll(java.util.Collection coll)
containsAll in interface java.util.Collectionpublic boolean removeAll(java.util.Collection coll)
removeAll in interface java.util.Collectionpublic boolean retainAll(java.util.Collection coll)
retainAll in interface java.util.Collectionpublic boolean equals(java.lang.Object object)
equals in interface java.util.Collectionequals in class java.lang.Objectpublic int hashCode()
hashCode in interface java.util.CollectionhashCode in class java.lang.Objectpublic java.lang.String toString()
toString in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||