net.ninjacat.smooth.collections

Class Maps

java.lang.Object

net.ninjacat.smooth.collections.Maps

public final class Maps
extends Object

Method Summary

Modifier and Type	Method and Description
static <K,V> Map<K,V>	of(Object... pairs) Will create map, give list of key, value pairs.
static <K,V> Map<K,V>	of(Pair<K,V>... pairs) Will create map, give list of key-value pairs.
static <K,V> Map<K,V>	toMap(Iterable<V> list, Func<K,V> keyGenerator) Converts iterable to map using provided Key generator function.
static <K,V> Map<K,V>	toUnmodifiableMap(Iterable<V> list, Func<K,V> keyGenerator) Converts iterable to map using provided Key generator function.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <K,V> Map<K,V> of(Object... pairs)

Will create map, give list of key, value pairs.

Example: Map<Integer, String> map = Maps.of(1, "One", 2, "Two", 3, "Three");

Number of parameters must be even. Will throw ClassCastException if wrong argument types are supplied

Type Parameters:

K - Type of keys

V - Type of values

Parameters:

pairs - list of key-value pairs. There is no special separation of each pair.

Returns:

Map<K,V> of supplied key-value pairs

of

public static <K,V> Map<K,V> of(Pair<K,V>... pairs)

Will create map, give list of key-value pairs.

Pairs are represented by Pair objects where left is used as key and right is used for value.

Type Parameters:

K - Type of keys

V - Type of values

Parameters:

pairs - list of key-value pairs.

Returns:

Map<K,V> of supplied key-value pairs

toMap

public static <K,V> Map<K,V> toMap(Iterable<V> list,
                                   Func<K,V> keyGenerator)

Converts iterable to map using provided Key generator function. Generator function is called on each element of iterable and its result is used as a key for the map.

Type Parameters:

K - Type of map key.

V - Type of iterable values

Parameters:

list - - Iterable to convert into Map

keyGenerator - Key generator function.

Returns:

Map with keys generated by function and values taken from iterable.

toUnmodifiableMap

public static <K,V> Map<K,V> toUnmodifiableMap(Iterable<V> list,
                                               Func<K,V> keyGenerator)

Converts iterable to map using provided Key generator function. Generator function is called on each element of iterable and its result is used as a key for the map.

Generated Map will be unmodifiable.

Type Parameters:

K - Type of map key.

V - Type of iterable values

Parameters:

list - - Iterable to convert into Map

keyGenerator - Key generator function.

Returns:

Map with keys generated by function and values taken from iterable.