Package org.apache.commons.collections4.keyvalue

# Class UnmodifiableMapEntry<K,V>

java.lang.Object
org.apache.commons.collections4.keyvalue.AbstractKeyValue<K,V>
org.apache.commons.collections4.keyvalue.AbstractMapEntry<K,V>
org.apache.commons.collections4.keyvalue.UnmodifiableMapEntry<K,V>

Type Parameters:
  `K` - The type of keys
  `V` - The type of mapped values

All Implemented Interfaces:
  `Map.Entry<K,V>`, `KeyValue<K,V>`, `Unmodifiable`

public final class UnmodifiableMapEntry<K,V> extends AbstractMapEntry<K,V> implements Unmodifiable
A `Map.Entry` that throws UnsupportedOperationException when `setValue` is called.

Since:
  3.0

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `UnmodifiableMapEntry(Map.Entry<? extends K,? extends V> entry)`
  Constructs a new entry from the specified `Map.Entry`.
  `UnmodifiableMapEntry(K key, V value)`
  Constructs a new entry with the specified key and given value.
  `UnmodifiableMapEntry(KeyValue<? extends K,? extends V> pair)`
  Constructs a new entry from the specified `KeyValue`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `V`
  `setValue(V value)`
  Throws UnsupportedOperationException.

  ### Methods inherited from class org.apache.commons.collections4.keyvalue.AbstractMapEntry

  `equals, hashCode`

  ### Methods inherited from class org.apache.commons.collections4.keyvalue.AbstractKeyValue

  `getKey, getValue, setKey, toString`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface java.util.Map.Entry

  `getKey, getValue`

- ## Constructor Details

  - ### UnmodifiableMapEntry

    public UnmodifiableMapEntry(K key, V 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<? extends K,? extends V> pair)
    Constructs a new entry from the specified `KeyValue`.
    Parameters:
      `pair` - The pair to copy, must not be null
    Throws:
      `NullPointerException` - if the entry is null

  - ### UnmodifiableMapEntry

    public UnmodifiableMapEntry(Map.Entry<? extends K,? extends V> entry)
    Constructs a new entry from the specified `Map.Entry`.
    Parameters:
      `entry` - The entry to copy, must not be null
    Throws:
      `NullPointerException` - if the entry is null

- ## Method Details

  - ### setValue

    public V setValue(V value)
    Throws UnsupportedOperationException.
    Specified by:
      `setValue` in interface `Map.Entry<K,V>`
    Overrides:
      `setValue` in class `AbstractMapEntry<K,V>`
    Parameters:
      `value` - The new value
    Returns:
      The previous value
    Throws:
      `UnsupportedOperationException` - always