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

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

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, BoundedCollection<E>

public final class UnmodifiableBoundedCollection<E>
extends AbstractSerializableCollectionDecorator<E>
implements BoundedCollection<E>

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 methods are no longer accessible. The factory on this class will attempt to retrieve the bounded nature by examining the package scope variables.

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:34:04 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Method Summary

boolean	add(E object)
boolean	addAll(Collection<? extends E> coll)
void	clear()
static <E> BoundedCollection<E>	decorate(BoundedCollection<E> coll) Factory method to create an unmodifiable bounded collection.
static <E> BoundedCollection<E>	decorateUsing(Collection<E> coll) Factory method to create an unmodifiable bounded collection.
boolean	isFull() Returns true if this collection is full and no new elements can be added.
Iterator<E>	iterator()
int	maxSize() Gets the maximum size of the collection (the bound).
boolean	remove(Object object)
boolean	removeAll(Collection<?> coll)
boolean	retainAll(Collection<?> coll)

Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

contains, containsAll, equals, getCollection, hashCode, isEmpty, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray

Method Detail

decorate

public static <E> BoundedCollection<E> decorate(BoundedCollection<E> coll)

Factory method to create an unmodifiable bounded collection.

Parameters:

coll - the BoundedCollection to decorate, must not be null

Returns:

a new unmodifiable bounded collection

Throws:

IllegalArgumentException - if bag is null

decorateUsing

public static <E> BoundedCollection<E> decorateUsing(Collection<E> 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

Returns:

a new unmodifiable bounded collection

Throws:

IllegalArgumentException - if bag is null

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(E object)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

public boolean addAll(Collection<? extends E> coll)

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(Collection<?> coll)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(Collection<?> coll)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollectionDecorator<E>

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<E>

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<E>

Returns:

the maximum number of elements the collection can hold