org.opendaylight.yangtools.util

Class SharedSingletonMap<K,V>

java.lang.Object

org.opendaylight.yangtools.util.SharedSingletonMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

Serializable, Map<K,V>, Immutable, MutationBehaviour<Immutable>, UnmodifiableMapPhase<K,V>

@Beta
public abstract class SharedSingletonMap<K,V>
extends Object
implements Serializable, UnmodifiableMapPhase<K,V>

Implementation of the Map interface which stores a single mapping. The key set is shared among all instances which contain the same key. This implementation does not support null keys or values.

In case the set of keys is statically known, you can use SharedSingletonMapTemplate to efficiently create SharedSingletonMap instances.

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@NonNull SingletonSet<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)
V	get(Object key)
int	hashCode()
boolean	isEmpty()
@NonNull SingletonSet<K>	keySet()
static <K,V> @NonNull SharedSingletonMap<K,V>	orderedCopyOf(Map<K,V> map) Create a SharedSingletonMap of specified key and value, which retains insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().
static <K,V> @NonNull SharedSingletonMap<K,V>	orderedOf(K key, V value) Create a SharedSingletonMap of specified key and value, which retains insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
String	toString()
static <K,V> @NonNull SharedSingletonMap<K,V>	unorderedCopyOf(Map<K,V> map) Create a SharedSingletonMap from specified single-element map, which does not retain insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().
static <K,V> @NonNull SharedSingletonMap<K,V>	unorderedOf(K key, V value) Create a SharedSingletonMap of specified key and value, which does not retain insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().
@NonNull SingletonSet<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.util.UnmodifiableMapPhase

toModifiableMap

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

orderedOf

public static <K,V> @NonNull SharedSingletonMap<K,V> orderedOf(K key,
                                                               V value)

Create a SharedSingletonMap of specified key and value, which retains insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().

Parameters:

key - key

value - value

Returns:

A SharedSingletonMap

Throws:

NullPointerException - if any of the arguments is null

unorderedOf

public static <K,V> @NonNull SharedSingletonMap<K,V> unorderedOf(K key,
                                                                 V value)

Create a SharedSingletonMap of specified key and value, which does not retain insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().

Parameters:

key - key

value - value

Returns:

A SharedSingletonMap

Throws:

NullPointerException - if any of the arguments is null

orderedCopyOf

public static <K,V> @NonNull SharedSingletonMap<K,V> orderedCopyOf(Map<K,V> map)

Create a SharedSingletonMap of specified key and value, which retains insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().

Parameters:

map - input map

Returns:

A SharedSingletonMap

Throws:

NullPointerException - if map is null

IllegalArgumentException - if map does not have exactly one entry

unorderedCopyOf

public static <K,V> @NonNull SharedSingletonMap<K,V> unorderedCopyOf(Map<K,V> map)

Create a SharedSingletonMap from specified single-element map, which does not retain insertion order when transformed via UnmodifiableMapPhase.toModifiableMap().

Parameters:

map - input map

Returns:

A SharedSingletonMap

Throws:

NullPointerException - if map is null

IllegalArgumentException - if map does not have exactly one entry

entrySet

public final @NonNull SingletonSet<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

keySet

public final @NonNull SingletonSet<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public final @NonNull SingletonSet<V> values()

Specified by:

values in interface Map<K,V>

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public final boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public final V get(Object key)

Specified by:

get in interface Map<K,V>

size

public final int size()

Specified by:

size in interface Map<K,V>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

put

public final V put(K key,
                   V value)

Specified by:

put in interface Map<K,V>

remove

public final V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

public final void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

clear

public final void clear()

Specified by:

clear in interface Map<K,V>

hashCode

public final int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object