org.apache.commons.collections.collection

Class UnmodifiableCollection

Implemented Interfaces:
Collection, Serializable, 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.

Version:
$Revision: 1.8 $ $Date: 2004/06/03 22:02:13 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

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

collection

Method Summary

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

add, addAll, clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Method Details

add

public boolean add(Object object)
Overrides:
add in interface AbstractCollectionDecorator

addAll

public boolean addAll(Collection coll)
Overrides:
addAll in interface AbstractCollectionDecorator

clear

public void clear()
Overrides:
clear in interface AbstractCollectionDecorator

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

iterator

public Iterator iterator()
Overrides:
iterator in interface AbstractCollectionDecorator

remove

public boolean remove(Object object)
Overrides:
remove in interface AbstractCollectionDecorator

removeAll

public boolean removeAll(Collection coll)
Overrides:
removeAll in interface AbstractCollectionDecorator

retainAll

public boolean retainAll(Collection coll)
Overrides:
retainAll in interface AbstractCollectionDecorator

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.