UnmodifiableCollection

org.apache.commons.collections4.collection

Class UnmodifiableCollection<E>

java.lang.Object
- org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
- - 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

See Also:

Serialized Form

Method Summary

All Methods

Static Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`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<? extends T> coll)` Factory method to create an unmodifiable collection.

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, decorated, isEmpty, setCollection, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - unmodifiableCollection
```
public static <T> Collection<T> unmodifiableCollection(Collection<? extends 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:
    
    NullPointerException - if collection is null
    
    Since:
    
    4.0
  - iterator
```
public Iterator<E> iterator()
```
  - add
```
public boolean add(E object)
```
  - addAll
```
public boolean addAll(Collection<? extends E> coll)
```
  - clear
```
public void clear()
```
  - remove
```
public boolean remove(Object object)
```
  - removeAll
```
public boolean removeAll(Collection<?> coll)
```
  - retainAll
```
public boolean retainAll(Collection<?> coll)
```