org.eclipse.jkube.kit.common.util

Class MapUtil

java.lang.Object

org.eclipse.jkube.kit.common.util.MapUtil

public class MapUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	getFlattenedMap(Map<?,?> source) Build a flattened representation of provided Map.
static Map<String,Object>	getNestedMap(Map<String,?> flattenedMap) Build a nested representation of the provided Map.
static void	mergeIfAbsent(Map<String,String> map, Map<String,String> toMerge) Add all values of a map to another map, but only if not already existing.
static <K,V> Map<K,V>	mergeMaps(Map<K,V>... maps) Returns a new map with all the entries of first map with rest map entries which don't override map1.
static Map<String,String>	mergeMaps(Properties... properties) Returns a new map with all the entries the provided properties merged.
static void	putAllIfNotNull(Map<String,String> ret, Map<String,String> toPut) Copies all the elements i.e., the mappings, from toPut map into ret, if toPut isn't null.

Methods inherited from class java.lang.Object

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

Method Detail

mergeIfAbsent

public static void mergeIfAbsent(Map<String,String> map,
                                 Map<String,String> toMerge)

Add all values of a map to another map, but only if not already existing.

Parameters:

map - target map

toMerge - the values to add

mergeMaps

@SafeVarargs
public static <K,V> Map<K,V> mergeMaps(Map<K,V>... maps)

Returns a new map with all the entries of first map with rest map entries which don't override map1. Can handle either maps being null. Always returns a new mutable map. Note: Be careful about the ordering of maps passed here. First map passed in the var args would always be given precedence over other maps in case there are colliding entries with same key values.

Type Parameters:

K - first type

V - second type

Parameters:

maps - var arg for maps

Returns:

merged hash map

mergeMaps

public static Map<String,String> mergeMaps(Properties... properties)

Returns a new map with all the entries the provided properties merged. The first arguments take precedence over the later ones. i.e. properties defined in the last argument will not override properties defined in the first argument.

Parameters:

properties - var arg for properties

Returns:

merged hash map

putAllIfNotNull

public static void putAllIfNotNull(Map<String,String> ret,
                                   Map<String,String> toPut)

Copies all the elements i.e., the mappings, from toPut map into ret, if toPut isn't null.

Parameters:

ret - target hash map

toPut - source hash map

getFlattenedMap

public static Map<String,Object> getFlattenedMap(Map<?,?> source)

Build a flattened representation of provided Map.

The conversion is compliant with the thorntail spring-boot rules.

Given a Map of Maps:

 Collections.singletonMap("key", Collections.singletonMap("nested-key", "value"));
 

It will return a Map with the following structure

 Collections.singletonMap("key.nested-key", "value");
 

Parameters:

source - map of maps

Returns:

map with merged nested-keys

getNestedMap

public static Map<String,Object> getNestedMap(Map<String,?> flattenedMap)

Build a nested representation of the provided Map.

Given a Map with a flat structure, it returns a Map of nested Maps. The original keys are split by the dot (.) character. For each element, a new Map node is created.

Given the following YAML representation of a Map:

 one.two.key: value
 one.two.three: other
 

It will converted to:

 one:
   two:
     key: value
     three: other
 

Parameters:

flattenedMap - map with a flat structure

Returns:

converted nested map