Package org.apache.commons.collections4.map

Class UnmodifiableEntrySet<K,V>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.set.AbstractSetDecorator<java.util.Map.Entry<K,V>>

org.apache.commons.collections4.map.UnmodifiableEntrySet<K,V>

All Implemented Interfaces:

Unmodifiable

public final class UnmodifiableEntrySet<K,V>
extends AbstractSetDecorator<java.util.Map.Entry<K,V>>
implements Unmodifiable

Decorates a map entry Set to ensure it can't be altered.

Attempts to modify it will result in an UnsupportedOperationException.

Since:

3.0

Version:

$Id: UnmodifiableEntrySet.java 1686855 2015-06-22 13:00:27Z tn $

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	add(java.util.Map.Entry<K,V> object)
boolean	addAll(java.util.Collection<? extends java.util.Map.Entry<K,V>> coll)
void	clear()
java.util.Iterator<java.util.Map.Entry<K,V>>	iterator()
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> coll)
boolean	retainAll(java.util.Collection<?> coll)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] array)
static <K,V> java.util.Set<java.util.Map.Entry<K,V>>	unmodifiableEntrySet(java.util.Set<java.util.Map.Entry<K,V>> set)	Factory method to create an unmodifiable set of Map Entry objects.

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

contains, containsAll, isEmpty, setCollection, size, toString

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

decorated, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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, of, of, of, of, of, of, of, of, of, of, of, of, size, spliterator

Method Detail

unmodifiableEntrySet

public static <K,V> java.util.Set<java.util.Map.Entry<K,V>> unmodifiableEntrySet(java.util.Set<java.util.Map.Entry<K,V>> set)

Factory method to create an unmodifiable set of Map Entry objects.

Type Parameters:

K - the key type

V - the value type

Parameters:

set - the set to decorate, must not be null

Returns:

a new unmodifiable entry set

Throws:

java.lang.NullPointerException - if set is null

Since:

4.0

add

public boolean add(java.util.Map.Entry<K,V> object)

Overrides:

add in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

addAll

public boolean addAll(java.util.Collection<? extends java.util.Map.Entry<K,V>> coll)

Overrides:

addAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

clear

public void clear()

Overrides:

clear in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

remove

public boolean remove(java.lang.Object object)

Overrides:

remove in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

removeAll

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

Overrides:

removeAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

retainAll

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

Overrides:

retainAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

iterator

public java.util.Iterator<java.util.Map.Entry<K,V>> iterator()

Overrides:

iterator in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

toArray

public java.lang.Object[] toArray()

Overrides:

toArray in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

toArray

public <T> T[] toArray(T[] array)

Overrides:

toArray in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>