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

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

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Unmodifiable

public final class UnmodifiableCollection<E>
extends AbstractSerializableCollectionDecorator<E>
implements Unmodifiable

Decorates another Collection to ensure it can't be altered.

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:05 $

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> Collection<E>	decorate(Collection<E> coll) Factory method to create an unmodifiable collection.
Iterator<E>	iterator()
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

Method Detail

decorate

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

Factory method to create an unmodifiable collection.

If the collection passed in is already unmodifiable, it is returned.

Parameters:

coll - the collection to decorate, must not be null

Returns:

an unmodifiable collection

Throws:

IllegalArgumentException - if collection 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>