org.apache.commons.collections.collection
Class UnmodifiableCollection

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, Unmodifiable

public final class UnmodifiableCollection
extends AbstractSerializableCollectionDecorator
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: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

See Also:

Serialized Form

Field Summary

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

collection

Method Summary

boolean	add(java.lang.Object object)
boolean	addAll(java.util.Collection coll)
void	clear()
static java.util.Collection	decorate(java.util.Collection coll) Factory method to create an unmodifiable collection.
java.util.Iterator	iterator()
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection coll)
boolean	retainAll(java.util.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 java.util.Collection decorate(java.util.Collection 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:

java.lang.IllegalArgumentException - if collection is null

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Overrides:

iterator in class AbstractCollectionDecorator

add

public boolean add(java.lang.Object object)

Specified by:

add in interface java.util.Collection

Overrides:

add in class AbstractCollectionDecorator

addAll

public boolean addAll(java.util.Collection coll)

Specified by:

addAll in interface java.util.Collection

Overrides:

addAll in class AbstractCollectionDecorator

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Overrides:

clear in class AbstractCollectionDecorator

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection

Overrides:

remove in class AbstractCollectionDecorator

removeAll

public boolean removeAll(java.util.Collection coll)

Specified by:

removeAll in interface java.util.Collection

Overrides:

removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(java.util.Collection coll)

Specified by:

retainAll in interface java.util.Collection

Overrides:

retainAll in class AbstractCollectionDecorator