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

java.lang.Object
  extended by org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
      extended by org.apache.commons.collections4.collection.UnmodifiableCollection<E>
Type Parameters:
E - the type of the elements in the collection
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, Unmodifiable

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

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

This class is Serializable from Commons Collections 3.1.

Attempts to modify it will result in an UnsupportedOperationException.

Since:
3.0
Version:
$Id: UnmodifiableCollection.java 1479401 2013-05-05 21:51:47Z tn $
See Also:
Serialized Form

Method Summary
 boolean add(E object)
           
 boolean addAll(Collection<? extends E> coll)
           
 void clear()
           
 Iterator<E> iterator()
           
 boolean remove(Object object)
           
 boolean removeAll(Collection<?> coll)
           
 boolean retainAll(Collection<?> coll)
           
static
<T> Collection<T>
unmodifiableCollection(Collection<T> coll)
          Factory method to create an unmodifiable collection.
 
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, decorated, equals, hashCode, isEmpty, setCollection, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

unmodifiableCollection

public static <T> Collection<T> unmodifiableCollection(Collection<T> coll)
Factory method to create an unmodifiable collection.

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

Type Parameters:
T - the type of the elements in the collection
Parameters:
coll - the collection to decorate, must not be null
Returns:
an unmodifiable collection
Throws:
IllegalArgumentException - if collection is null
Since:
4.0

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>


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.