com.github.protobufel.multikeymap

Class MultiKeyMaps

java.lang.Object

com.github.protobufel.multikeymap.MultiKeyMaps

public final class MultiKeyMaps
extends java.lang.Object

Provides the factory methods of the generic MultiKeyMap implementations.

Method Summary

Modifier and Type	Method and Description
static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V>	newMultiKeyMap() Creates a new default, Serialiazable instance of MultiKeyMap.
static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V>	newMultiKeyMap(java.util.function.Supplier<java.util.Map<K,V>> mapSupplier, boolean concurrent) Creates a new MultiKeyMap based on the provided map supplier.
static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V>	of(java.util.Map<K,V> map) Creates a new default, Serialiazable instance of MultiKeyMap initialized off the data by the supplied Map.

Methods inherited from class java.lang.Object

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

Method Detail

newMultiKeyMap

public static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V> newMultiKeyMap(java.util.function.Supplier<java.util.Map<K,V>> mapSupplier,
                                                                                      boolean concurrent)

Creates a new MultiKeyMap based on the provided map supplier. The returned MultiKeyMap is Serializable if the provided map is Serializable.

NOTE: Use with caution. This is the advanced functionality.

Type Parameters:

T - the type of a sub-key the key consist of

K - the type of a full key, which is an Iterable of its sub-keys, with usage as in a regular Map

V - the type of a value which stored in the MultiKeyMap under the corresponding key

Parameters:

mapSupplier - a supplier of Map<K, V> this MultiKeyMap is based on

concurrent - create a concurrent instance if true, un-synchronized, regular instance, otherwise

Returns:

a new instance of the implementation of MultiKeyMap

newMultiKeyMap

public static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V> newMultiKeyMap()

Creates a new default, Serialiazable instance of MultiKeyMap.

Type Parameters:

T - the type of a sub-key the key consist of

K - the type of a full key, which is an Iterable of its sub-keys, with usage as in a regular Map

V - the type of a value which stored in the MultiKeyMap under the corresponding key

Returns:

a new instance of the default implementation of MultiKeyMap

of

public static <T,K extends java.lang.Iterable<T>,V> MultiKeyMap<T,K,V> of(java.util.Map<K,V> map)

Creates a new default, Serialiazable instance of MultiKeyMap initialized off the data by the supplied Map.

Type Parameters:

T - the type of a sub-key the key consist of

K - the type of a full key, which is an Iterable of its sub-keys, with usage as in a regular Map

V - the type of a value which stored in the MultiKeyMap under the corresponding key

Parameters:

map - a Map instance to copy data from; the data copied shallowly.

Returns:

a new instance of the default implementation of MultiKeyMap initialized with the map's data