ch.jalu.configme.resource

Class MapNormalizer

java.lang.Object

ch.jalu.configme.resource.MapNormalizer

public class MapNormalizer
extends Object

Normalizes the keys of maps, splitting compound keys and ensuring that all keys are Strings.

Constructor Summary

Constructors

Constructor and Description
MapNormalizer(boolean splitDotPaths) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addValueIntoMap(@NotNull Map<String,Object> map, @NotNull String path, @NotNull Object value) Adds the provided value into the given map, splitting the path into periods appropriately and keeping any intermediate nested maps which may already exist.
protected @NotNull Optional<Map<String,Object>>	createNormalizedMapIfNeeded(@NotNull Object value) Processes the given value if it is a Map and returns an Optional with a new Map if the input value is not in its "normalized form".
protected @NotNull Map<String,Object>	getOrInsertMap(@NotNull Map<String,Object> parentMap, @NotNull String path) Returns the nested map in the given parentMap at the given path, inserting one if none is yet present.
protected boolean	isKeyInvalid(@NotNull Object key)
@Nullable Map<String,Object>	normalizeMap(@Nullable Map<Object,Object> loadedMap) Normalizes the raw map read from a property resource for further use in a property reader.
protected boolean	splitDotPaths()

Methods inherited from class java.lang.Object

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

Constructor Detail

MapNormalizer

public MapNormalizer(boolean splitDotPaths)

Constructor.

Parameters:

splitDotPaths - whether compound keys (keys with ".") should be split

Method Detail

splitDotPaths

protected final boolean splitDotPaths()

normalizeMap

@Nullable
public @Nullable Map<String,Object> normalizeMap(@Nullable
                                                           @Nullable Map<Object,Object> loadedMap)

Normalizes the raw map read from a property resource for further use in a property reader.

Parameters:

loadedMap - the map to normalize

Returns:

new map with sanitized structure (or same if no changes are needed)

createNormalizedMapIfNeeded

@NotNull
protected @NotNull Optional<Map<String,Object>> createNormalizedMapIfNeeded(@NotNull
                                                                                     @NotNull Object value)

Processes the given value if it is a Map and returns an Optional with a new Map if the input value is not in its "normalized form". Recursively visits and replaces nested maps.

Parameters:

value - the value to process

Returns:

optional with a new map to replace the given one with, empty optional if not needed or not applicable

isKeyInvalid

protected boolean isKeyInvalid(@NotNull
                               @NotNull Object key)

addValueIntoMap

protected void addValueIntoMap(@NotNull
                               @NotNull Map<String,Object> map,
                               @NotNull
                               @NotNull String path,
                               @NotNull
                               @NotNull Object value)

Adds the provided value into the given map, splitting the path into periods appropriately and keeping any intermediate nested maps which may already exist.

Parameters:

map - the map to add the value to

path - the path to store the value under

value - the value to store

getOrInsertMap

@NotNull
protected @NotNull Map<String,Object> getOrInsertMap(@NotNull
                                                              @NotNull Map<String,Object> parentMap,
                                                              @NotNull
                                                              @NotNull String path)

Returns the nested map in the given parentMap at the given path, inserting one if none is yet present. Periods in the path argument are not handled by this method. Note that this method overrides any non-Map values stored at the given path.

Parameters:

parentMap - the map to retrieve the nested map from

path - the key with which the value should be looked up from the map

Returns:

the nested map, as stored under the path in the given map