UnmodifiableCollection (Apache Commons Collections 3.2.2 API)

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: 972404 $ $Date: 2008-04-10 14:33:15 +0200 (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

Methods
Modifier and Type	Method and 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

- Method Detail
  - 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 Iterable
    
    Specified by:
    
    iterator in interface Collection
    
    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

Class UnmodifiableCollection

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

decorate

iterator

add

addAll

clear

remove

removeAll

retainAll