org.apache.commons.collections.collection
Class UnmodifiableBoundedCollection
java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
|
+--org.apache.commons.collections.collection.UnmodifiableBoundedCollection
- All Implemented Interfaces:
- BoundedCollection, Collection
- public final class UnmodifiableBoundedCollection
- extends AbstractCollectionDecorator
- implements BoundedCollection
UnmodifiableBoundedCollection
decorates another BoundedCollection
to ensure it can't be altered.
If a BoundedCollection is first wrapped in some other collection decorator,
such as synchronized or predicated, the BoundedCollection nature is lost.
The factory on this class will attempt to retrieve the bounded nature by
examining the package scope variables.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.5 $ $Date: 2004/01/14 21:43:18 $
- Author:
- Stephen Colebourne
decorate
public static BoundedCollection decorate(BoundedCollection coll)
- Factory method to create an unmodifiable bounded collection.
- Parameters:
coll
- the BoundedCollection
to decorate, must not be null- Throws:
IllegalArgumentException
- if bag is null
decorateUsing
public static BoundedCollection decorateUsing(Collection coll)
- Factory method to create an unmodifiable bounded collection.
This method is capable of drilling down through up to 1000 other decorators
to find a suitable BoundedCollection.
- Parameters:
coll
- the BoundedCollection
to decorate, must not be null- Throws:
IllegalArgumentException
- if bag is null
iterator
public Iterator iterator()
- Specified by:
iterator
in interface Collection
- Overrides:
iterator
in class AbstractCollectionDecorator
add
public boolean add(Object object)
- Specified by:
add
in interface Collection
- Overrides:
add
in class AbstractCollectionDecorator
addAll
public boolean addAll(Collection coll)
- Specified by:
addAll
in interface Collection
- Overrides:
addAll
in class AbstractCollectionDecorator
clear
public void clear()
- Specified by:
clear
in interface Collection
- Overrides:
clear
in class AbstractCollectionDecorator
remove
public boolean remove(Object object)
- Specified by:
remove
in interface Collection
- Overrides:
remove
in class AbstractCollectionDecorator
removeAll
public boolean removeAll(Collection coll)
- Specified by:
removeAll
in interface Collection
- Overrides:
removeAll
in class AbstractCollectionDecorator
retainAll
public boolean retainAll(Collection coll)
- Specified by:
retainAll
in interface Collection
- Overrides:
retainAll
in class AbstractCollectionDecorator
isFull
public boolean isFull()
- Description copied from interface:
BoundedCollection
- Returns true if this collection is full and no new elements can be added.
- Specified by:
isFull
in interface BoundedCollection
- Following copied from interface:
org.apache.commons.collections.BoundedCollection
- Returns:
true
if the collection is full
maxSize
public int maxSize()
- Description copied from interface:
BoundedCollection
- Gets the maximum size of the collection (the bound).
- Specified by:
maxSize
in interface BoundedCollection
- Following copied from interface:
org.apache.commons.collections.BoundedCollection
- Returns:
- the maximum number of elements the collection can hold
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.