org.apache.commons.collections.keyvalue
Class UnmodifiableMapEntry<K,V>

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

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:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:35:10 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

Field Summary

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

key, value

Constructor Summary

UnmodifiableMapEntry(KeyValue<K,V> pair)
Constructs a new entry from the specified KeyValue.

UnmodifiableMapEntry(K key, V value)
Constructs a new entry with the specified key and given value.

UnmodifiableMapEntry(Map.Entry<K,V> entry)
Constructs a new entry from the specified MapEntry.

Method Summary

V	setValue(V 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

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

Methods inherited from interface java.util.Map.Entry

getKey, getValue

Constructor Detail

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<K,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<K,V> entry)

Constructs a new entry from the specified MapEntry.

Parameters:

entry - the entry to copy, must not be null

Throws:

NullPointerException - if the entry is null

Method Detail

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