Package 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:

Serializable, Iterable, 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 14:33:15 +0200 (Thu, 10 Apr 2008) $

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	Serialization version

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

collection

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UnmodifiableCollection(Collection coll)	Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method	Description
boolean	add(Object object)
boolean	addAll(Collection coll)
void	clear()
static Collection	decorate(Collection coll)	Factory method to create an unmodifiable collection.
Iterator	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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version

See Also:

• Constant Field Values

Constructor Details

UnmodifiableCollection

private UnmodifiableCollection(Collection coll)

Constructor that wraps (not copies).

Parameters:

coll - the collection to decorate, must not be null

Throws:

IllegalArgumentException - if collection is null

Method Details

decorate

public static Collection decorate(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:

IllegalArgumentException - if collection is null

iterator

public Iterator iterator()

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Iterable

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