SettingsMapImpl (Punch Common Core Library 6.4.5 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,Object>
  - - org.thales.punch.settings.impl.SettingsMapImpl

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, ISettingsMap

Direct Known Subclasses:

DirHandle, NamedSettingsMapImpl
```
public class SettingsMapImpl
extends HashMap<String,Object>
implements ISettingsMap
```
This class extends HashMap<String,Object>, in order to provide simple additional operators to get Typed settings from the settings map, and to simplify settings-using caller code by taking care of runtime class checks, settings existence check, default value providing) As HashMap, the constructor taking a map as parameter works by shallow copy (internal sub-settings objects are shared with the original).

Author:

Cedric VAN FRACHEM

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

protected String originatorName
The name is used to generate helpful error or exceptions, should a property be wrong or missing.

Fields
Modifier and Type	Field and Description
`protected String`	`originatorName` The name is used to generate helpful error or exceptions, should a property be wrong or missing.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SettingsMapImpl()` Use new SettingsMapBuilder().build() if you use it from api.
`protected`	`SettingsMapImpl(Map<String,Object> map, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`asFlatValuesMap()`
`Map<String,Object>`	`asFlatValuesMap(String indexedBy)`
`Map<String,Object>`	`asFlatValuesMapIgnoreSettingsList(String indexedBy)`
`String`	`asHjsonString()`
`String`	`asJsonString()`
`String`	`asJsonString(IJsonSerializer s)` This variant relies on an external serializer to deal with unsupported classes found in the SettingsMap.
`String`	`asKvString()`
`List<Map<String,Object>>`	`asListFlatValuesMapIgnoreSettingsList(String indexedBy)`
`String`	`asYamlString()`
`String`	`childAsJson(String s)` Whatever be the type of the child, return a json representation of it.
`byte[]`	`childAsRawContent(String key)` Retrieve the content of a file node.
`byte[]`	`childAsTarGz(String dirName)` Assuming the SettingsMap contains a folder, this method returns a tar gz byte array of all its content.
`ISettingsMap`	`childFileAsMap(String key)` Return a child file as a map.
`boolean`	`childIsDir(String key)`
`boolean`	`childIsFile(String key)`
`Boolean`	`getAsBoolean(String key)`
`Boolean`	`getAsBoolean(String key, Boolean defaultValue)`
`Double`	`getAsDouble(String key, Double defaultValue)`
`Integer`	`getAsInteger(String key)`
`Integer`	`getAsInteger(String key, Integer defaultValue)`
`org.joda.time.DateTime`	`getAsIsoDateTime(String key, org.joda.time.DateTime defaultValue)`
`Long`	`getAsLong(String key)`
`Long`	`getAsLong(String key, Long defaultValue)`
`long`	`getAsMsDuration(String key, long defaultValue)` Return a duration.
`Boolean`	`getAsRequiredBoolean(String key)`
`Double`	`getAsRequiredDouble(String key)`
`Integer`	`getAsRequiredInteger(String key)`
`org.joda.time.DateTime`	`getAsRequiredIsoDateTime(String key)`
`Long`	`getAsRequiredLong(String key)`
`Object`	`getAsRequiredObject(String key)` Return a mandatory property.
`Object`	`getAsRequiredObjectOfClass(String key, Class<?> expectedClass)`
`ISettingsList`	`getAsRequiredSettingsList(String key)`
`ISettingsMap`	`getAsRequiredSettingsMap(String key)` Return a mandatory sub-map from a key.
`String`	`getAsRequiredString(String key)` Return a mandatory string property.
`TimeValue`	`getAsRequiredTimeValue(String key)` Return a mandatory TimeValue
`ZonedDateTime`	`getAsRequiredZonedDateTime(String key)`
`ISettingsList`	`getAsSettingsList(String key)`
`ISettingsList`	`getAsSettingsList(String key, ISettingsList defaultValue)`
`ISettingsList`	`getAsSettingsListOrEmpty(String key)` Get a settings list or an empty one if nonefound.
`ISettingsMap`	`getAsSettingsMap(String key)`
`ISettingsMap`	`getAsSettingsMap(String key, ISettingsMap defaultValue)`
`String`	`getAsString(String key)`
`String`	`getAsString(String key, String defaultValue)`
`TimeValue`	`getAsTimeValue(String key, TimeValue defaultValue)` Return a TimeValue
`protected String`	`getChildName(String key)`
`ISettingsMap`	`getCreateMap(String key)` Get a new map or create one if not found.
`ISettingsMap`	`getDeepCopy()` Get a deep copy object of this map.
`ISettingsMap`	`getMapOrEmpty(String key)` Get a map or an empty one if nout found.
`Object`	`getNestedProperty(Object defaultValue, String... keys)` Get an optional nested property identified by a succession of keys to navigate into the properties tree
`static SettingsMapImpl`	`getNewInstance()`
`ISettingsMap`	`getOrCreateNestedSettingsMap(String... keys)` Get a nested settings map identified by a succession of keys to navigate into the properties tree
`String`	`getOriginatorName()`
`Object`	`getRequiredNestedProperty(String... keys)` Get a required nested property identified by a succession of keys to navigate into the properties tree
`String`	`getStringOrFail(String key)` Return a mandatory string property.
`String`	`getStringOrFail(String key, String defaultValue)` Return a string property or a default value
`long`	`getTimeValueMs(String key, long defaultValue)` Given a "100ms" "10m" "1h" "2d" representation, return the corresponding value in ms.
`protected ISettingsList`	`newSettingsListChild(List<Object> list, String name)` Returns a new instance of appropriate Settings list implementation for this settings tree Initialized with same content as a provided list containing The returned object has not been added to the THIS settings map
`protected ISettingsMap`	`newSettingsMapChild(Map<String,Object> map, String name)` Returns a new instance of appropriate Settings map implementation for this settings tree Initialized with same content as a provided map containing The returned object has not been added to the THIS settings map
`protected ISettingsMap`	`newSettingsMapChild(String name)` Returns a new instance of appropriate Settings map implementation for this settings tree The returned object has not been added to the THIS settings map
`void`	`overrideWith(ISettingsMap otherSettings)` Recursively import/override settings in this map with settings from another map.
`ISettingsMap`	`putUsingDottedPath(String dottedPath, Object value)` Put a nested value using the dotted notation for creating the path.
`ISettingsMap`	`putUsingSlashPath(String path, Object value)` Put a nested value using the "/" filesystem notation for creating the path.
`ISettingsMap`	`removeUsingDottedPath(String dottedPath)` Remove a leaf node using a dotted path.
`ISettingsMap`	`removeUsingSlashPath(String path)` Remove a leaf node using a dotted path.
`void`	`setJsonDecoding(boolean b)` By default files loaded from (typically) zookeeper of from the local file system are automatically decoded as json (if, of course, their content is json compatible).
`ISettingsMap`	`setNestedProperty(Object value, String... keys)` Add a nested property.
`ISettingsMap`	`setOriginatorName(String name)` SettingsMap can be associated with a name referencing the original file (typically0.
`ISettingsMap`	`setPropertyIfMissing(String key, Object value)` Set a property only if it does not exists yet.

Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.thales.punch.settings.api.ISettingsMap
childAsListOfString, childAsMapEntries, childAsMapValues, childAsRequiredListOfString, childAsRequiredString, childAsString, childAsStringContent, getCreateAsListOfMap

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- Field Detail
  - originatorName
```
protected String originatorName
```
    The name is used to generate helpful error or exceptions, should a property be wrong or missing. It typically is the original settings file name.
- Constructor Detail
  - SettingsMapImpl
```
protected SettingsMapImpl()
```
    Use new SettingsMapBuilder().build() if you use it from api. This constructor is only internal to this package.
  - SettingsMapImpl
```
protected SettingsMapImpl(Map<String,Object> map,
                          String name)
```
    Parameters:
    
    map - The settings map to shallow copy
    
    name - The name context to tag all logs/exceptions concerning properties of this map
- Method Detail
  - getAsBoolean
```
public Boolean getAsBoolean(String key)
```
    Specified by:
    
    getAsBoolean in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Boolean class
  - getAsString
```
public String getAsString(String key)
```
    Specified by:
    
    getAsString in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a String class
  - getAsLong
```
public Long getAsLong(String key)
```
    Specified by:
    
    getAsLong in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Long class
  - getAsInteger
```
public Integer getAsInteger(String key)
```
    Specified by:
    
    getAsInteger in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Long class
  - getAsSettingsList
```
public ISettingsList getAsSettingsList(String key)
```
    Specified by:
    
    getAsSettingsList in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed an extension of List<Object>
  - getAsSettingsMap
```
public ISettingsMap getAsSettingsMap(String key)
```
    Specified by:
    
    getAsSettingsMap in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed an extension of Map<String,Object>
  - getAsBoolean
```
public Boolean getAsBoolean(String key,
                            Boolean defaultValue)
```
    Specified by:
    
    getAsBoolean in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed a Boolean class
  - getAsString
```
public String getAsString(String key,
                          String defaultValue)
```
    Specified by:
    
    getAsString in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed a String class
  - getAsDouble
```
public Double getAsDouble(String key,
                          Double defaultValue)
```
    Specified by:
    
    getAsDouble in interface ISettingsMap
    
    Parameters:
    
    key - the key
    
    defaultValue - a double default value returned of the key is not found
    
    Returns:
    
    the found or default double value
  - getAsLong
```
public Long getAsLong(String key,
                      Long defaultValue)
```
    Specified by:
    
    getAsLong in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed a Long class
  - getAsInteger
```
public Integer getAsInteger(String key,
                            Integer defaultValue)
```
    Specified by:
    
    getAsInteger in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed a Long class
  - getAsSettingsList
```
public ISettingsList getAsSettingsList(String key,
                                       ISettingsList defaultValue)
```
    Specified by:
    
    getAsSettingsList in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed an extension of List<Object>
  - newSettingsMapChild
```
protected ISettingsMap newSettingsMapChild(Map<String,Object> map,
                                           String name)
```
    Returns a new instance of appropriate Settings map implementation for this settings tree Initialized with same content as a provided map containing The returned object has not been added to the THIS settings map
    
    Parameters:
    
    map - an Objects map containing settings, used to initialize the new settings map
    
    name - a name
    
    Returns:
    
    return an ISettingsMap
  - newSettingsListChild
```
protected ISettingsList newSettingsListChild(List<Object> list,
                                             String name)
```
    Returns a new instance of appropriate Settings list implementation for this settings tree Initialized with same content as a provided list containing The returned object has not been added to the THIS settings map
    
    Parameters:
    
    list - a list of of type object
    
    name - a name
    
    Returns:
    
    return an ISettingsList
  - newSettingsMapChild
```
protected ISettingsMap newSettingsMapChild(String name)
```
    Returns a new instance of appropriate Settings map implementation for this settings tree The returned object has not been added to the THIS settings map
    
    Parameters:
    
    name - a name
    
    Returns:
    
    return an ISettingsMap
  - getAsSettingsMap
```
public ISettingsMap getAsSettingsMap(String key,
                                     ISettingsMap defaultValue)
```
    Specified by:
    
    getAsSettingsMap in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    defaultValue - the default value
    
    Returns:
    
    defaultValue if key is not found, otherwise guaranteed an extension of Map<String,Object>
  - getAsRequiredObject
```
public Object getAsRequiredObject(String key)
```
    Description copied from interface: ISettingsMap
    
    Return a mandatory property.
    
    Specified by:
    
    getAsRequiredObject in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
  - getAsRequiredObjectOfClass
```
public Object getAsRequiredObjectOfClass(String key,
                                         Class<?> expectedClass)
```
    Specified by:
    
    getAsRequiredObjectOfClass in interface ISettingsMap
    
    Parameters:
    
    key - the property key to retrieve
    
    expectedClass - the class of which the property must be checked an instance of
    
    Returns:
    
    fetched value, guaranteed an extension of expectedClass
  - getAsRequiredBoolean
```
public Boolean getAsRequiredBoolean(String key)
```
    Specified by:
    
    getAsRequiredBoolean in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Boolean class
  - getAsRequiredLong
```
public Long getAsRequiredLong(String key)
```
    Specified by:
    
    getAsRequiredLong in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Long class
  - getAsRequiredDouble
```
public Double getAsRequiredDouble(String key)
```
    Specified by:
    
    getAsRequiredDouble in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Double class
  - getAsRequiredInteger
```
public Integer getAsRequiredInteger(String key)
```
    Specified by:
    
    getAsRequiredInteger in interface ISettingsMap
    
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed an Integer class
  - getStringOrFail
```
public String getStringOrFail(String key)
                       throws ConfigurationException
```
    Description copied from interface: ISettingsMap
    
    Return a mandatory string property.
    
    Specified by:
    
    getStringOrFail in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
    
    Throws:
    
    ConfigurationException - if the property is missing or is not a string
  - getStringOrFail
```
public String getStringOrFail(String key,
                              String defaultValue)
                       throws ConfigurationException
```
    Description copied from interface: ISettingsMap
    
    Return a string property or a default value
    
    Specified by:
    
    getStringOrFail in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    defaultValue - the default value
    
    Returns:
    
    the requested value
    
    Throws:
    
    ConfigurationException
  - getAsRequiredString
```
public String getAsRequiredString(String key)
```
    Description copied from interface: ISettingsMap
    
    Return a mandatory string property.
    
    Specified by:
    
    getAsRequiredString in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
  - getAsRequiredIsoDateTime
```
public org.joda.time.DateTime getAsRequiredIsoDateTime(String key)
```
    Specified by:
    
    getAsRequiredIsoDateTime in interface ISettingsMap
    
    Parameters:
    
    key - the key of the timestamp
    
    Returns:
    
    an expected timestamp in iso format
  - getAsIsoDateTime
```
public org.joda.time.DateTime getAsIsoDateTime(String key,
                                               org.joda.time.DateTime defaultValue)
```
    Specified by:
    
    getAsIsoDateTime in interface ISettingsMap
    
    Parameters:
    
    key - the key of the timestamp
    
    defaultValue - the default value
    
    Returns:
    
    an expected timestamp in iso format
  - getAsRequiredZonedDateTime
```
public ZonedDateTime getAsRequiredZonedDateTime(String key)
```
    Specified by:
    
    getAsRequiredZonedDateTime in interface ISettingsMap
    
    Parameters:
    
    key - the key of the timestamp
    
    Returns:
    
    an expected timestamp in zone date time format
  - getAsRequiredSettingsList
```
public ISettingsList getAsRequiredSettingsList(String key)
```
    Specified by:
    
    getAsRequiredSettingsList in interface ISettingsMap
    
    Parameters:
    
    key - the key you look for
    
    Returns:
    
    a target List<Object>
  - getAsSettingsListOrEmpty
```
public ISettingsList getAsSettingsListOrEmpty(String key)
```
    Description copied from interface: ISettingsMap
    Get a settings list or an empty one if nonefound. This method is a helper instead of writing:
```
 getAsSettingsList(key, new SettingsListBuilder().build());
 
```
    It is useful to deal with optional settings.
    Specified by:
    
    getAsSettingsListOrEmpty in interface ISettingsMap
    
    Parameters:
    
    key - the sub list key
    
    Returns:
    
    the found list or an empty one.
  - getAsRequiredSettingsMap
```
public ISettingsMap getAsRequiredSettingsMap(String key)
```
    Description copied from interface: ISettingsMap
    
    Return a mandatory sub-map from a key. In Json terms, that means returning a json object.
    The returned sub map is an instance of ISettingsMap, you can use it as a standard Mao or use the extra getters.
    This method does not provide lazy loading of inner files. Use chiladAsMap if that is what you need.
    
    Specified by:
    
    getAsRequiredSettingsMap in interface ISettingsMap
    
    Parameters:
    
    key - the sub-map key name
    
    Returns:
    
    the sub map, if found
  - getChildName
```
protected String getChildName(String key)
```
    Parameters:
    
    key - a key
    
    Returns:
    
    a string giving if possible a full path to the property (node.node.node.key). If the name context is not known, the return value is just the property key in the map. *
  - setOriginatorName
```
public ISettingsMap setOriginatorName(String name)
```
    Description copied from interface: ISettingsMap
    
    SettingsMap can be associated with a name referencing the original file (typically0. That name is simply used when a property is missing, to build a useful error message.
    
    Specified by:
    
    setOriginatorName in interface ISettingsMap
    
    Parameters:
    
    name - the name to associate
    
    Returns:
    
    this settings map
  - getOriginatorName
```
public String getOriginatorName()
```
    Specified by:
    
    getOriginatorName in interface ISettingsMap
    
    Returns:
    
    current value of string used to identify naming context in exception/log strings.
  - getAsTimeValue
```
public TimeValue getAsTimeValue(String key,
                                TimeValue defaultValue)
```
    Description copied from interface: ISettingsMap
    
    Return a TimeValue
    
    Specified by:
    
    getAsTimeValue in interface ISettingsMap
    
    Parameters:
    
    key - the timeValue key
    
    defaultValue - a default TimeValue
    
    Returns:
    
    the found TimeValue or null
  - getAsRequiredTimeValue
```
public TimeValue getAsRequiredTimeValue(String key)
```
    Description copied from interface: ISettingsMap
    
    Return a mandatory TimeValue
    
    Specified by:
    
    getAsRequiredTimeValue in interface ISettingsMap
    
    Parameters:
    
    key - the timeValue key
    
    Returns:
    
    the required TimeValue
  - overrideWith
```
public void overrideWith(ISettingsMap otherSettings)
```
    Description copied from interface: ISettingsMap
    
    Recursively import/override settings in this map with settings from another map. For tree like implementations, this is a full ADDITIVE merge, recursive up to the leaf level (therefore different from a Map.putAll() ) Please note that list sub items cannot be "merged" and will be overridden by the otherSettings version if present in both settings
    
    Specified by:
    
    overrideWith in interface ISettingsMap
    
    Parameters:
    
    otherSettings - the new settings
  - putUsingDottedPath
```
public ISettingsMap putUsingDottedPath(String dottedPath,
                                       Object value)
```
    Description copied from interface: ISettingsMap
    
    Put a nested value using the dotted notation for creating the path. For example using "a.b.c" creates a child property with "a", "b", "c". Will navigate in settings tree following provided dot-separated path, creating sub-settings map as needed if they do not already exist then will put the object, as by the put() operation A RuntimeException will occur if a non-final segment of the provided path leads to an already existing setting that is not a SettingsMap
    
    Specified by:
    
    putUsingDottedPath in interface ISettingsMap
    
    Parameters:
    
    dottedPath - dot-separated settings path
    
    value - the value
    
    Returns:
    
    this instance
  - putUsingSlashPath
```
public ISettingsMap putUsingSlashPath(String path,
                                      Object value)
```
    Description copied from interface: ISettingsMap
    
    Put a nested value using the "/" filesystem notation for creating the path. For example using "a/b/c" creates a child property with "a", "b", "c". A RuntimeException will occur if a non-final segment of the provided path leads to an already existing setting that is not a SettingsMap
    
    Specified by:
    
    putUsingSlashPath in interface ISettingsMap
    
    value - the value
    
    Returns:
    
    this instance
  - removeUsingDottedPath
```
public ISettingsMap removeUsingDottedPath(String dottedPath)
```
    Description copied from interface: ISettingsMap
    
    Remove a leaf node using a dotted path. This method has no effect if the path does not exist.
    
    Specified by:
    
    removeUsingDottedPath in interface ISettingsMap
    
    Returns:
    
    this map without the removerd node.
  - removeUsingSlashPath
```
public ISettingsMap removeUsingSlashPath(String path)
```
    Description copied from interface: ISettingsMap
    
    Remove a leaf node using a dotted path. This method has no effect if the path does not exist.
    
    Specified by:
    
    removeUsingSlashPath in interface ISettingsMap
    
    Returns:
    
    this map without the removerd node.
  - asJsonString
```
public String asJsonString()
```
    Specified by:
    
    asJsonString in interface ISettingsMap
    
    Returns:
    
    a Json representation of this settings map.
  - asJsonString
```
public String asJsonString(IJsonSerializer s)
```
    Description copied from interface: ISettingsMap
    
    This variant relies on an external serializer to deal with unsupported classes found in the SettingsMap. For example Files.
    
    Specified by:
    
    asJsonString in interface ISettingsMap
    
    Parameters:
    
    s - your external serializer
    
    Returns:
    
    a JSON representation of this settings map.
  - asFlatValuesMap
```
public Map<String,Object> asFlatValuesMap()
```
    Specified by:
    
    asFlatValuesMap in interface ISettingsMap
    
    Returns:
    
    a value map indexed by dotted key path "my"."subsetting"."setting" => value
  - asKvString
```
public String asKvString()
```
    Specified by:
    
    asKvString in interface ISettingsMap
    
    Returns:
    
    a simple key value flatten representation, handy for logging.
  - asFlatValuesMap
```
public Map<String,Object> asFlatValuesMap(String indexedBy)
```
    Specified by:
    
    asFlatValuesMap in interface ISettingsMap
    
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a value map indexed by a specified key path "my"."subsetting"."setting" => value
  - asFlatValuesMapIgnoreSettingsList
```
public Map<String,Object> asFlatValuesMapIgnoreSettingsList(String indexedBy)
```
    Specified by:
    
    asFlatValuesMapIgnoreSettingsList in interface ISettingsMap
    
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a value map indexed by a specified key path "my"."subsetting"."setting" => value
  - asListFlatValuesMapIgnoreSettingsList
```
public List<Map<String,Object>> asListFlatValuesMapIgnoreSettingsList(String indexedBy)
```
    Specified by:
    
    asListFlatValuesMapIgnoreSettingsList in interface ISettingsMap
    
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a list of value map indexed by a specified key path "my"."subsetting"."setting" => value
  - childAsJson
```
public String childAsJson(String s)
```
    Description copied from interface: ISettingsMap
    
    Whatever be the type of the child, return a json representation of it.
    
    Specified by:
    
    childAsJson in interface ISettingsMap
    
    Parameters:
    
    s - the child key.
    
    Returns:
    
    the child string representation
  - childAsTarGz
```
public byte[] childAsTarGz(String dirName)
```
    Description copied from interface: ISettingsMap
    
    Assuming the SettingsMap contains a folder, this method returns a tar gz byte array of all its content.
    
    Specified by:
    
    childAsTarGz in interface ISettingsMap
    
    Parameters:
    
    dirName - the child directory name
    
    Returns:
    
    the corresponding compressed archive
  - childIsFile
```
public boolean childIsFile(String key)
```
    Specified by:
    
    childIsFile in interface ISettingsMap
    
    Parameters:
    
    key - the name of a child property
    
    Returns:
    
    true if the child is a regular file
  - childIsDir
```
public boolean childIsDir(String key)
```
    Specified by:
    
    childIsDir in interface ISettingsMap
    
    Parameters:
    
    key - the name of a child property
    
    Returns:
    
    true if the child is a regular directory
  - childAsRawContent
```
public byte[] childAsRawContent(String key)
```
    Description copied from interface: ISettingsMap
    
    Retrieve the content of a file node. Watchout if the file is not found an empty byte array is returned.
    
    Specified by:
    
    childAsRawContent in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the file node content
  - getMapOrEmpty
```
public ISettingsMap getMapOrEmpty(String key)
```
    Description copied from interface: ISettingsMap
    Get a map or an empty one if nout found. This method is a helpr instead of writing:
```
 getAsSettingsMap(key, new SettingsMapBuilder().build());
 
```
    It is useful to deal with optional settings.
    Specified by:
    
    getMapOrEmpty in interface ISettingsMap
    
    Parameters:
    
    key - the sub map key
    
    Returns:
    
    the found map or an empty one.
  - getCreateMap
```
public ISettingsMap getCreateMap(String key)
```
    Description copied from interface: ISettingsMap
    
    Get a new map or create one if not found. Watch out this result in storing an empty sub map in your map. Make sure you need this.
    
    Specified by:
    
    getCreateMap in interface ISettingsMap
    
    Parameters:
    
    key - the sub map key.
    
    Returns:
  - childFileAsMap
```
public ISettingsMap childFileAsMap(String key)
```
    Description copied from interface: ISettingsMap
    
    Return a child file as a map. This requires your file to be map compatible, i.e; a json hjson or yaml file.
    This method lets you easily check if a file is a valid YAML JSON or HJSON file.
    
    Specified by:
    
    childFileAsMap in interface ISettingsMap
    
    Parameters:
    
    key - tfile name; relative to where you are.
    
    Returns:
    
    the decoded dictionary
  - setPropertyIfMissing
```
public ISettingsMap setPropertyIfMissing(String key,
                                         Object value)
```
    Description copied from interface: ISettingsMap
    
    Set a property only if it does not exists yet.
    
    Specified by:
    
    setPropertyIfMissing in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    value - the property value
    
    Returns:
    
    this map
  - getNewInstance
```
public static SettingsMapImpl getNewInstance()
```
    Returns:
    
    a new empty instance
  - setJsonDecoding
```
public void setJsonDecoding(boolean b)
```
    By default files loaded from (typically) zookeeper of from the local file system are automatically decoded as json (if, of course, their content is json compatible).
    Use this to request no decoding. You will then get FileHandle instead.
    
    Parameters:
    
    b - true or false
  - getTimeValueMs
```
public long getTimeValueMs(String key,
                           long defaultValue)
```
    Description copied from interface: ISettingsMap
    
    Given a "100ms" "10m" "1h" "2d" representation, return the corresponding value in ms.
    
    Specified by:
    
    getTimeValueMs in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    defaultValue - the defaultValue
    
    Returns:
    
    the value in milliseconds
  - getAsMsDuration
```
public long getAsMsDuration(String key,
                            long defaultValue)
```
    Description copied from interface: ISettingsMap
    
    Return a duration. The user enters "2ms" "3d" "6h" and you a retunr with the equivalent duration in milliseconds
    
    Specified by:
    
    getAsMsDuration in interface ISettingsMap
    
    Parameters:
    
    key - the property key
    
    defaultValue - the default value
    
    Returns:
    
    the duration
  - setNestedProperty
```
public ISettingsMap setNestedProperty(Object value,
                                      String... keys)
```
    Description copied from interface: ISettingsMap
    Add a nested property.
    This lets you add directly an inner property. For example:
```
 map.addNestedProperty(23, "user", "bob", "age");
 
```
    Specified by:
    
    setNestedProperty in interface ISettingsMap
    
    Parameters:
    
    value - the value
    
    keys - the list of keys
    
    Returns:
    
    this builder
  - getDeepCopy
```
public ISettingsMap getDeepCopy()
```
    Description copied from interface: ISettingsMap
    
    Get a deep copy object of this map. Useful when data encapsulation is required.
    
    Specified by:
    
    getDeepCopy in interface ISettingsMap
    
    Returns:
    
    the SettingMap copy
  - getOrCreateNestedSettingsMap
```
public ISettingsMap getOrCreateNestedSettingsMap(String... keys)
```
    Description copied from interface: ISettingsMap
    
    Get a nested settings map identified by a succession of keys to navigate into the properties tree
    
    Specified by:
    
    getOrCreateNestedSettingsMap in interface ISettingsMap
    
    Parameters:
    
    keys - the list of keys that will be used to navigate into the settings tree.
    
    Returns:
    
    the settings map if found, else a newly created settings map, actually inserted in the settings map tree (this is different from childAsMap(), which will also return an empty map in this case, but DETACHED from the base properties tree.
  - getNestedProperty
```
public Object getNestedProperty(Object defaultValue,
                                String... keys)
```
    Description copied from interface: ISettingsMap
    
    Get an optional nested property identified by a succession of keys to navigate into the properties tree
    
    Specified by:
    
    getNestedProperty in interface ISettingsMap
    
    Parameters:
    
    defaultValue - the value that will be returned if at least one of the successive keys is missing
    
    keys - the list of keys that will be used to navigate into the settings tree.
    
    Returns:
    
    the property value if found, else the provided default value
  - getRequiredNestedProperty
```
public Object getRequiredNestedProperty(String... keys)
```
    Description copied from interface: ISettingsMap
    
    Get a required nested property identified by a succession of keys to navigate into the properties tree
    
    Specified by:
    
    getRequiredNestedProperty in interface ISettingsMap
    
    Parameters:
    
    keys - the list of keys that will be used to navigate into the settings tree.
    
    Returns:
    
    the property value if found, else an IllegalArgumentException is raised (if any provided key does not match a tree node)
  - asHjsonString
```
public String asHjsonString()
```
    Specified by:
    
    asHjsonString in interface ISettingsMap
    
    Returns:
    
    a HJson representation of this settings map.
  - asYamlString
```
public String asYamlString()
```
    Specified by:
    
    asYamlString in interface ISettingsMap
    
    Returns:
    
    a Yaml representation of this settings map.

Class SettingsMapImpl

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface org.thales.punch.settings.api.ISettingsMap

Methods inherited from interface java.util.Map

Field Detail

originatorName

Constructor Detail

SettingsMapImpl

SettingsMapImpl

Method Detail

getAsBoolean

getAsString

getAsLong

getAsInteger

getAsSettingsList

getAsSettingsMap

getAsBoolean

getAsString

getAsDouble

getAsLong

getAsInteger

getAsSettingsList

newSettingsMapChild

newSettingsListChild

newSettingsMapChild

getAsSettingsMap

getAsRequiredObject

getAsRequiredObjectOfClass

getAsRequiredBoolean

getAsRequiredLong

getAsRequiredDouble

getAsRequiredInteger

getStringOrFail

getStringOrFail

getAsRequiredString

getAsRequiredIsoDateTime

getAsIsoDateTime

getAsRequiredZonedDateTime

getAsRequiredSettingsList

getAsSettingsListOrEmpty

getAsRequiredSettingsMap

getChildName

setOriginatorName

getOriginatorName

getAsTimeValue

getAsRequiredTimeValue

overrideWith

putUsingDottedPath

putUsingSlashPath

removeUsingDottedPath

removeUsingSlashPath

asJsonString

asJsonString

asFlatValuesMap

asKvString

asFlatValuesMap

asFlatValuesMapIgnoreSettingsList

asListFlatValuesMapIgnoreSettingsList

childAsJson

childAsTarGz

childIsFile

childIsDir

childAsRawContent

getMapOrEmpty

getCreateMap

childFileAsMap

setPropertyIfMissing

getNewInstance

setJsonDecoding

getTimeValueMs

getAsMsDuration

setNestedProperty