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:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.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

Version:

$Id: UnmodifiableSet.java 1533984 2013-10-20 21:12:51Z tn $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serialization version

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UnmodifiableSet(java.util.Set<? extends E> set) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
boolean	add(E object)
boolean	addAll(java.util.Collection<? extends E> coll)
void	clear()
java.util.Iterator<E>	iterator()
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> coll)
boolean	retainAll(java.util.Collection<?> coll)
static <E> java.util.Set<E>	unmodifiableSet(java.util.Set<? extends E> set) Factory method to create an unmodifiable set.

Methods inherited from class org.apache.commons.collections4.set.AbstractSetDecorator

decorated

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

contains, containsAll, equals, hashCode, 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, equals, hashCode, isEmpty, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization version

See Also:

Constant Field Values

Constructor Detail

UnmodifiableSet

private UnmodifiableSet(java.util.Set<? extends E> set)

Constructor that wraps (not copies).

Parameters:

set - the set to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if set is null

Method Detail

unmodifiableSet

public static <E> java.util.Set<E> unmodifiableSet(java.util.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:

java.lang.IllegalArgumentException - if set is null

Since:

4.0

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.Set<E>

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(E object)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

public boolean addAll(java.util.Collection<? extends E> coll)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

Overrides:

retainAll in class AbstractCollectionDecorator<E>