org.apache.commons.collections.collection
Class UnmodifiableCollection

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.collection.UnmodifiableCollection
All Implemented Interfaces:
Collection, Unmodifiable

public final class UnmodifiableCollection
extends AbstractCollectionDecorator
implements Unmodifiable

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

Since:
Commons Collections 3.0
Version:
$Revision: 1.4 $ $Date: 2004/01/14 21:43:18 $
Author:
Stephen Colebourne

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
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 Collection decorate(Collection coll)
Factory method to create an unmodifiable collection.
Parameters:
coll - the collection to decorate, must not be null
Throws:
IllegalArgumentException - if collection is null

iterator

public Iterator iterator()
Overrides:
iterator in class AbstractCollectionDecorator

add

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

addAll

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

clear

public void clear()
Overrides:
clear in class AbstractCollectionDecorator

remove

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

removeAll

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

retainAll

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


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