UnmodifiableEntrySet

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:

java.io.Serializable, java.lang.Iterable<java.util.Map.Entry<K,V>>, java.util.Collection<java.util.Map.Entry<K,V>>, java.util.Set<java.util.Map.Entry<K,V>>, 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 1494280 2013-06-18 20:07:04Z tn $

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`UnmodifiableEntrySet.UnmodifiableEntry` Implementation of a map entry that is unmodifiable.
`private class`	`UnmodifiableEntrySet.UnmodifiableEntrySetIterator` Implementation of an entry set iterator.

Field Summary

Fields
Modifier and Type Field and Description

private static long serialVersionUID
Serialization version

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

Constructor Summary

Constructors
Modifier Constructor and Description

private UnmodifiableEntrySet(java.util.Set<java.util.Map.Entry<K,V>> set)
Constructor that wraps (not copies).

Constructors
Modifier	Constructor and Description
`private`	`UnmodifiableEntrySet(java.util.Set<java.util.Map.Entry<K,V>> set)` Constructor that wraps (not copies).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.set.AbstractSetDecorator
decorated

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, equals, hashCode, isEmpty, setCollection, size, 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

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
  - UnmodifiableEntrySet
```
private UnmodifiableEntrySet(java.util.Set<java.util.Map.Entry<K,V>> 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
  - 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.IllegalArgumentException - if set is null
    
    Since:
    
    4.0
  - add
```
public boolean add(java.util.Map.Entry<K,V> object)
```
    Specified by:
    
    add in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    add in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    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)
```
    Specified by:
    
    addAll in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    addAll in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    addAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    clear in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    clear in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - remove
```
public boolean remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    remove in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    remove in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> coll)
```
    Specified by:
    
    removeAll in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    removeAll in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    removeAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> coll)
```
    Specified by:
    
    retainAll in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    retainAll in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    retainAll in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - iterator
```
public java.util.Iterator<java.util.Map.Entry<K,V>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    iterator in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    iterator in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    toArray in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    toArray in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>
  - toArray
```
public <T> T[] toArray(T[] array)
```
    Specified by:
    
    toArray in interface java.util.Collection<java.util.Map.Entry<K,V>>
    
    Specified by:
    
    toArray in interface java.util.Set<java.util.Map.Entry<K,V>>
    
    Overrides:
    
    toArray in class AbstractCollectionDecorator<java.util.Map.Entry<K,V>>

Class UnmodifiableEntrySet<K,V>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

serialVersionUID

Constructor Detail

UnmodifiableEntrySet

Method Detail

unmodifiableEntrySet

add

addAll

clear

remove

removeAll

retainAll

iterator

toArray

toArray