UnmodifiableSet

org.apache.commons.collections4.set

Class UnmodifiableSet<E>

java.lang.Object
- org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
- - org.apache.commons.collections4.set.AbstractSetDecorator<E>
  - - org.apache.commons.collections4.set.AbstractSerializableSetDecorator<E>
    - - org.apache.commons.collections4.set.UnmodifiableSet<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, Unmodifiable
```
public final class UnmodifiableSet<E>
extends AbstractSerializableSetDecorator<E>
implements Unmodifiable
```
Decorates another Set 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 <E> Set<E>`	`unmodifiableSet(Set<? extends E> set)` Factory method to create an unmodifiable set.

Methods inherited from class org.apache.commons.collections4.set.AbstractSetDecorator
decorated, equals, hashCode

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

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

Methods inherited from interface java.util.Set
contains, containsAll, isEmpty, size, spliterator, toArray, toArray

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

Methods inherited from interface java.lang.Iterable
forEach

Method Detail

unmodifiableSet
```
public static <E> Set<E> unmodifiableSet(Set<? extends E> set)
```
Factory method to create an unmodifiable set.

Type Parameters:

E - the element type

Parameters:

set - the set to decorate, must not be null

Returns:

a new unmodifiable set

Throws:

NullPointerException - if set 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)