org.adroitlogic.x.utils

Class MapUtils

java.lang.Object

org.adroitlogic.x.utils.MapUtils

public class MapUtils
extends Object

Utility class for handling Java map data structures

Since:

17.01

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
MapUtils()

Method Summary

Modifier and Type	Method and Description
static <K,V> Map<K,V>	asMap(K key1, V value1, Object... theRest) Creates a typed Map including the provided content, treating it as a sequence of key-value pairs.
static Map<String,String>	asStringMap(String... content) Creates a Map including the provided String content, treating it as a sequence of key-value pairs
static <K,V> Map<K,V>	cloneMap(Map<K,V> originalMap) Creates a clone of a given Map.
static List<StringPair>	toListOfStringPairs(Map<String,?> sourceMap)
static List<StringTrio>	toListOfStringTrios(Map<String,Map<String,?>> sourceMap)
static <T> Map<String,List<T>>	toMapOfListType(Map<String,? extends List<?>> map, Class<T> type) Converts a map with String keys and List values, to a map with String keys and List of given type of values
static <T> Map<String,T>	toMapOfType(Map<String,?> map, Class<T> type) Converts a map with String keys to a map with String keys and T values
static Map<String,List<String>>	toStringListMap(Map<String,? extends List<?>> map) Converts a map with String keys and List values, to a map with String keys and List of String values
static Map<String,String>	toStringValuedMap(Map<String,?> map) Converts a map with String keys to a map with String keys and String values

Methods inherited from class java.lang.Object

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

Constructor Detail

MapUtils

public MapUtils()

Method Detail

toStringValuedMap

public static Map<String,String> toStringValuedMap(Map<String,?> map)

Converts a map with String keys to a map with String keys and String values

Parameters:

map - the map with String keys

Returns:

a map with String keys and String values

toMapOfType

public static <T> Map<String,T> toMapOfType(Map<String,?> map,
                                            Class<T> type)

Converts a map with String keys to a map with String keys and T values

Type Parameters:

T - the type of the values in the resulting map

Parameters:

map - the map with String keys

type - the class of the type of the resulting map values

Returns:

a map with String keys and type values

Throws:

IllegalArgumentException - if the any of the values in the map cannot be converted to the given type

toStringListMap

public static Map<String,List<String>> toStringListMap(Map<String,? extends List<?>> map)

Converts a map with String keys and List values, to a map with String keys and List of String values

Parameters:

map - the map with String keys and List values

Returns:

a map with String keys and List of String values

toMapOfListType

public static <T> Map<String,List<T>> toMapOfListType(Map<String,? extends List<?>> map,
                                                      Class<T> type)

Converts a map with String keys and List values, to a map with String keys and List of given type of values

Type Parameters:

T - the type of the resulting values in the List values in the Map

Parameters:

map - the map with String keys and List values

type - the class of the type that the resulting values in the List values of the Map

Returns:

a map with String keys and List of given type of values

Throws:

IllegalArgumentException - if the any of the objects in any of the lists in the map cannot be converted to the given type

toListOfStringPairs

public static List<StringPair> toListOfStringPairs(Map<String,?> sourceMap)

toListOfStringTrios

public static List<StringTrio> toListOfStringTrios(Map<String,Map<String,?>> sourceMap)

cloneMap

public static <K,V> Map<K,V> cloneMap(Map<K,V> originalMap)

Creates a clone of a given Map. The original and cloned maps will refer separate objects for Java immutable entries (keys or values) while both will refer the same objects for mutable objects.

Type Parameters:

K - the type of the entry keys

V - the type of the entry values

Parameters:

originalMap - the map to be cloned

Returns:

new instance of Map with the contents of the original map, or empty map if the original map is null

asStringMap

public static Map<String,String> asStringMap(String... content)

Creates a Map including the provided String content, treating it as a sequence of key-value pairs

Parameters:

content - the content to be included in the map, in the form key1, value1, key2, value2, ...

Returns:

a new instance of Map including the provided content as key-value pairs

asMap

public static <K,V> Map<K,V> asMap(K key1,
                                   V value1,
                                   Object... theRest)

Creates a typed Map including the provided content, treating it as a sequence of key-value pairs. Key and value types of the map would be determined using the first two parameters. Please note that this method does not perform type validation for the rest of the content (included in theRest.

Type Parameters:

K - the key type for the map (determined using key1

V - the value type for the map (determined using value1

Parameters:

key1 - the first key to be included in the map; decides the key type of the map

value1 - the first value to be included in the map; decides the value type of the map

theRest - rest of the content to be included in the map, in the form key2, value3, key3, value3, ...

Returns:

a new instance of a typed Map including the provided content as key-value pairs