org.forgerock.openam.utils

Class SingleValueMapper<K,V>

java.lang.Object

org.forgerock.openam.utils.SingleValueMapper<K,V>

Type Parameters:

K - the first value.

V - the second value.

public class SingleValueMapper<K,V>
extends Object

A utility collection which maintains mappings for any given value. At any point, the value can only be mapped to a single key. This class makes an implicit contract with the caller by maintaining only one key mapped to a given value. If the caller changes which key should map to the value, they do not need clean up the previous mapping, this class will perform this task for them. This should reduce memory leak to orphaned key/value mappings. Thread Safety: Uses ConcurrentHashMap and limited synchronized to ensure thread-safety and atomicity.

Constructor Summary

Constructors

Constructor and Description
SingleValueMapper()

Method Summary

Modifier and Type	Method and Description
V	get(K k) Gets the value corresponding to the specified key.
K	getValue(V v) Gets the key corresponding to the specified value.
void	put(K k, V v) Store a mapping of key to value.
V	remove(K k) Removes the named key from the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleValueMapper

public SingleValueMapper()

Method Detail

get

public V get(K k)

Gets the value corresponding to the specified key.

Parameters:

k - The key to fetch a value for. May not be null.

Returns:

A possibly null value for the given key.

getValue

public K getValue(V v)

Gets the key corresponding to the specified value.

Parameters:

v - The value to get the key for. May not be null.

Returns:

A possibly null key for the given value.

put

public void put(K k,
                V v)

Store a mapping of key to value. Note: If there was a previous mapping for value, this will be cleaned up. Synchronized: to ensure both maps are updated in an atomic way.

Parameters:

k - The key to map against the value. May not be null.

v - The value to map against the key. May not be null.

remove

public V remove(K k)

Removes the named key from the map. Synchronized: to ensure both maps are updated in an atomic way.

Parameters:

k - The key to remove the mapping for. May not be null.

Returns:

A non null mapped value.