org.apache.commons.collections.keyvalue

Class UnmodifiableMapEntry

java.lang.Object

org.apache.commons.collections.keyvalue.AbstractKeyValue

org.apache.commons.collections.keyvalue.AbstractMapEntry

org.apache.commons.collections.keyvalue.UnmodifiableMapEntry

All Implemented Interfaces:

java.util.Map.Entry, KeyValue, Unmodifiable

public final class UnmodifiableMapEntry
extends AbstractMapEntry
implements Unmodifiable

A Map.Entry that throws UnsupportedOperationException when setValue is called.

Since:

Commons Collections 3.0

Constructor Summary

Constructors

Constructor and Description
UnmodifiableMapEntry(KeyValue pair) Constructs a new entry from the specified KeyValue.
UnmodifiableMapEntry(java.util.Map.Entry entry) Constructs a new entry from the specified Map.Entry.
UnmodifiableMapEntry(java.lang.Object key, java.lang.Object value) Constructs a new entry with the specified key and given value.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	setValue(java.lang.Object value) Throws UnsupportedOperationException.

Methods inherited from class org.apache.commons.collections.keyvalue.AbstractMapEntry

equals, hashCode

Methods inherited from class org.apache.commons.collections.keyvalue.AbstractKeyValue

getKey, getValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, getKey, getValue

Constructor Detail

UnmodifiableMapEntry

public UnmodifiableMapEntry(java.lang.Object key,
                            java.lang.Object value)

Constructs a new entry with the specified key and given value.

Parameters:

key - the key for the entry, may be null

value - the value for the entry, may be null

UnmodifiableMapEntry

public UnmodifiableMapEntry(KeyValue pair)

Constructs a new entry from the specified KeyValue.

Parameters:

pair - the pair to copy, must not be null

Throws:

java.lang.NullPointerException - if the entry is null

UnmodifiableMapEntry

public UnmodifiableMapEntry(java.util.Map.Entry entry)

Constructs a new entry from the specified Map.Entry.

Parameters:

entry - the entry to copy, must not be null

Throws:

java.lang.NullPointerException - if the entry is null

Method Detail

setValue

public java.lang.Object setValue(java.lang.Object value)

Throws UnsupportedOperationException.

Specified by:

setValue in interface java.util.Map.Entry

Overrides:

setValue in class AbstractMapEntry

Parameters:

value - the new value

Returns:

the previous value

Throws:

java.lang.UnsupportedOperationException - always