Package org.apache.commons.collections.set

Class UnmodifiableSet

java.lang.Object

org.apache.commons.collections.collection.AbstractCollectionDecorator

org.apache.commons.collections.set.AbstractSetDecorator

org.apache.commons.collections.set.AbstractSerializableSetDecorator

org.apache.commons.collections.set.UnmodifiableSet

All Implemented Interfaces:

Serializable, Iterable, Collection, Set, Unmodifiable

public final class UnmodifiableSet
extends AbstractSerializableSetDecorator
implements Unmodifiable

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

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $

See Also:

• Serialized Form

Field Summary

Fields

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

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

collection

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UnmodifiableSet(Set set)	Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method	Description
boolean	add(Object object)
boolean	addAll(Collection coll)
void	clear()
static Set	decorate(Set set)	Factory method to create an unmodifiable set.
Iterator	iterator()
boolean	remove(Object object)
boolean	removeAll(Collection coll)
boolean	retainAll(Collection coll)

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

getSet

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

contains, containsAll, equals, hashCode, isEmpty, size, spliterator, toArray, toArray

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version

See Also:

• Constant Field Values

Constructor Details

UnmodifiableSet

private UnmodifiableSet(Set set)

Constructor that wraps (not copies).

Parameters:

set - the set to decorate, must not be null

Throws:

IllegalArgumentException - if set is null

Method Details

decorate

public static Set decorate(Set set)

Factory method to create an unmodifiable set.

Parameters:

set - the set to decorate, must not be null

Throws:

IllegalArgumentException - if set is null

iterator

public Iterator iterator()

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Set

Overrides:

iterator in class AbstractCollectionDecorator

add

public boolean add(Object object)

Specified by:

add in interface Collection

Specified by:

add in interface Set

Overrides:

add in class AbstractCollectionDecorator

addAll

public boolean addAll(Collection coll)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface Set

Overrides:

addAll in class AbstractCollectionDecorator

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface Set

Overrides:

clear in class AbstractCollectionDecorator

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection

Specified by:

remove in interface Set

Overrides:

remove in class AbstractCollectionDecorator

removeAll

public boolean removeAll(Collection coll)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface Set

Overrides:

removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(Collection coll)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface Set

Overrides:

retainAll in class AbstractCollectionDecorator