org.opendaylight.yangtools.util

Class ImmutableOffsetMapTemplate<K>

java.lang.Object

org.opendaylight.yangtools.util.ImmutableMapTemplate<K>

org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate<K>

Type Parameters:

K - the type of keys maintained by this template

All Implemented Interfaces:

Immutable, MutationBehaviour<Immutable>

public abstract class ImmutableOffsetMapTemplate<K>
extends ImmutableMapTemplate<K>

Template for instantiating ImmutableOffsetMap instances with a fixed set of keys. The template can then be used as a factory for instances via using instantiateTransformed(Map, BiFunction) or, more efficiently, using instantiateWithValues(Object[]) where the argument array has values ordered corresponding to the key order defined by keySet().

Method Summary

Modifier and Type	Method and Description
<T,V> @NonNull ImmutableOffsetMap<K,V>	instantiateTransformed(Map<K,T> fromMap, BiFunction<K,T,V> valueTransformer) Instantiate an immutable map by applying specified transformer to values of fromMap.
<V> @NonNull ImmutableOffsetMap<K,V>	instantiateWithValues(V... values) Instantiate an immutable map by filling values from provided array.
Set<K>	keySet() Returns the set of keys expected by this template, in the iteration order Maps resulting from instantiation will have.
static <K> @NonNull ImmutableOffsetMapTemplate<K>	ordered(Collection<K> keys) Create a template which produces Maps with specified keys, with iteration order matching the iteration order of keys.
String	toString()
static <K> @NonNull ImmutableOffsetMapTemplate<K>	unordered(Collection<K> keys) Create a template which produces Maps with specified keys, with unconstrained iteration order.

Methods inherited from class java.lang.Object

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

Method Detail

ordered

public static <K> @NonNull ImmutableOffsetMapTemplate<K> ordered(Collection<K> keys)

Create a template which produces Maps with specified keys, with iteration order matching the iteration order of keys. keySet() will return these keys in exactly the same order. The resulting map will retain insertion order through UnmodifiableMapPhase.toModifiableMap() transformations.

Type Parameters:

K - the type of keys maintained by resulting template

Parameters:

keys - Keys in requested iteration order.

Returns:

A template object.

Throws:

NullPointerException - if keys or any of its elements is null

IllegalArgumentException - if keys is does not have at least two keys

unordered

public static <K> @NonNull ImmutableOffsetMapTemplate<K> unordered(Collection<K> keys)

Create a template which produces Maps with specified keys, with unconstrained iteration order. Produced maps will have the iteration order matching the order returned by keySet(). The resulting map will NOT retain ordering through UnmodifiableMapPhase.toModifiableMap() transformations.

Type Parameters:

K - the type of keys maintained by resulting template

Parameters:

keys - Keys in any iteration order.

Returns:

A template object.

Throws:

NullPointerException - if keys or any of its elements is null

IllegalArgumentException - if keys is does not have at least two keys

keySet

public final Set<K> keySet()

Description copied from class: ImmutableMapTemplate

Returns the set of keys expected by this template, in the iteration order Maps resulting from instantiation will have.

Specified by:

keySet in class ImmutableMapTemplate<K>

Returns:

This template's key set

See Also:

Map.keySet()

instantiateTransformed

public final <T,V> @NonNull ImmutableOffsetMap<K,V> instantiateTransformed(Map<K,T> fromMap,
                                                                           BiFunction<K,T,V> valueTransformer)

Description copied from class: ImmutableMapTemplate

Instantiate an immutable map by applying specified transformer to values of fromMap.

Specified by:

instantiateTransformed in class ImmutableMapTemplate<K>

Type Parameters:

T - the type of input values

V - the type of mapped values

Parameters:

fromMap - Input map

valueTransformer - Transformation to apply to values

Returns:

An immutable map

instantiateWithValues

@SafeVarargs
public final <V> @NonNull ImmutableOffsetMap<K,V> instantiateWithValues(V... values)

Description copied from class: ImmutableMapTemplate

Instantiate an immutable map by filling values from provided array. The array MUST be ordered to match key order as returned by ImmutableMapTemplate.keySet().

Specified by:

instantiateWithValues in class ImmutableMapTemplate<K>

Type Parameters:

V - the type of mapped values

Parameters:

values - Values to use

Returns:

An immutable map

toString

public final String toString()

Overrides:

toString in class Object