io.jsonwebtoken.lang

Interface Registry<K,V>

Type Parameters:

K - key type

V - value type

All Superinterfaces:

Map<K,V>

public interface Registry<K,V>
extends Map<K,V>

An immutable (read-only) repository of key-value pairs. In addition to Map read methods, this interface also provides guaranteed/expected lookup via the forKey(Object) method.

Immutability

Registries are immutable and cannot be changed. Registry extends the Map interface purely out of convenience: to allow easy key/value pair access and iteration, and other conveniences provided by the Map interface, as well as for seamless use with existing Map-based APIs. Attempting to call any of the Map interface's mutation methods however (such as put, remove, clear, etc) will throw an UnsupportedOperationException.

Since:

0.12.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
V	forKey(K key) Returns the value assigned the specified key or throws an IllegalArgumentException if there is no associated value.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

forKey

V forKey(K key)
         throws IllegalArgumentException

Returns the value assigned the specified key or throws an IllegalArgumentException if there is no associated value. If a value is not required, consider using the Map.get(Object) method instead.

Parameters:

key - the registry key assigned to the required value

Returns:

the value assigned the specified key

Throws:

IllegalArgumentException - if there is no value assigned the specified key

See Also:

Map.get(Object)