ISettingsMap (Punch Common Core Library 6.4.5 API)

All Superinterfaces:

Map<String,Object>

All Known Subinterfaces:

IBook, IChannel, IEntity, IPunchPlatformProperties, ITopic, ITopology

All Known Implementing Classes:

BookImpl, ChannelImpl, DirHandle, EntityImpl, JsonSettingsMapImpl, KafkaClusterImpl, NamedSettingsMapImpl, PunchPlatformPropertiesImpl, ResolverImpl, SettingsMapImpl, TopicImpl, YamlSettingsMapImpl
```
public interface ISettingsMap
extends Map<String,Object>
```
SettingsMap are just maps, with an extra facility for loading Json configuration files, in a way to report useful errors should a item be missing. What we need is an easy way to tell the user "hey, the property 'timeoout' is missing from your configuration file, in the expected section 'storm_settings'".
This is especiallly important because the punchplatform relies heavily on configuration files, not transformed into pojos but used with a dynamic API. It would be way too tedious to create tons of pojos corresponding to the various json or yml files we deal with.

Author:

dimi

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated 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 key)` Whatever be the type of the child, return a json representation of it.
`default List<String>`	`childAsListOfString(String key)` Return a child node of your map, expecting a list of string.
`default List<Map.Entry<String,ISettingsMap>>`	`childAsMapEntries(String key)` Make it easier to iterate over child map entries.
`default List<ISettingsMap>`	`childAsMapValues(String key)` Make it easier to iterate over child map values.
`byte[]`	`childAsRawContent(String key)` Retrieve the content of a file node.
`default List<String>`	`childAsRequiredListOfString(String key)` Return a required child node of your map, expecting a list of string.
`default String`	`childAsRequiredString(String key)` Return a child node of your map, expecting a String.
`default String`	`childAsString(String key)` Return a child node of your map, expecting a String.
`default String`	`childAsStringContent(String key)` Retrieve the content of a file node as a String.
`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<? extends Object> 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
`default List<ISettingsMap>`	`getCreateAsListOfMap(String key)` Return a child node of your map, expecting a list of map.
`ISettingsMap`	`getCreateMap(String key)` Deprecated. use instead getMapOrEmpty
`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
`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.
`void`	`overrideWith(ISettingsMap otherSettings)` Recursively import/override settings in this map with settings from another map.
`ISettingsMap`	`putUsingDottedPath(String path, 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 path)` Remove a leaf node using a dotted path.
`ISettingsMap`	`removeUsingSlashPath(String path)` Remove a leaf node using a dotted path.
`ISettingsMap`	`setNestedProperty(Object value, String... keys)` Add a nested property.
`ISettingsMap`	`setOriginatorName(String originatorName)` 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 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

- Method Detail
  - getAsMsDuration
```
long getAsMsDuration(String key,
                     long defaultValue)
```
    Return a duration. The user enters "2ms" "3d" "6h" and you a retunr with the equivalent duration in milliseconds
    
    Parameters:
    
    key - the property key
    
    defaultValue - the default value
    
    Returns:
    
    the duration
  - getAsBoolean
```
Boolean getAsBoolean(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Boolean class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsString
```
String getAsString(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a String class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsLong
```
Long getAsLong(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Long class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsDouble
```
Double getAsDouble(String key,
                   Double defaultValue)
```
    Parameters:
    
    key - the key
    
    defaultValue - a double default value returned of the key is not found
    
    Returns:
    
    the found or default double value
  - getAsInteger
```
Integer getAsInteger(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed a Long class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsSettingsList
```
ISettingsList getAsSettingsList(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed an extension of List<Object>
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsSettingsMap
```
ISettingsMap getAsSettingsMap(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    null if key is not found, otherwise guaranteed an extension of Map<String,Object>
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsBoolean
```
Boolean getAsBoolean(String key,
                     Boolean defaultValue)
```
    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
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsString
```
String getAsString(String key,
                   String defaultValue)
```
    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
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsLong
```
Long getAsLong(String key,
               Long defaultValue)
```
    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
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsInteger
```
Integer getAsInteger(String key,
                     Integer defaultValue)
```
    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
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsSettingsList
```
ISettingsList getAsSettingsList(String key,
                                ISettingsList defaultValue)
```
    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>
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsSettingsMap
```
ISettingsMap getAsSettingsMap(String key,
                              ISettingsMap defaultValue)
```
    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>
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
  - getAsRequiredBoolean
```
Boolean getAsRequiredBoolean(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Boolean class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredLong
```
Long getAsRequiredLong(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Long class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredDouble
```
Double getAsRequiredDouble(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed a Double class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredInteger
```
Integer getAsRequiredInteger(String key)
```
    Parameters:
    
    key - the key of what you look for
    
    Returns:
    
    fetched value, guaranteed an Integer class
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredString
```
String getAsRequiredString(String key)
```
    Return a mandatory string property.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if the property exists but is not a String.
    
    IllegalArgumentException - runtime exception if the property is missing
  - getStringOrFail
```
String getStringOrFail(String key)
                throws ConfigurationException
```
    Return a mandatory string property.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
    
    Throws:
    
    ConfigurationException - if the property is missing or is not a string
  - getStringOrFail
```
String getStringOrFail(String key,
                       String defaultValue)
                throws ConfigurationException
```
    Return a string property or a default value
    
    Parameters:
    
    key - the property key
    
    defaultValue - the default value
    
    Returns:
    
    the requested value
    
    Throws:
    
    ConfigurationException
  - getAsRequiredObject
```
Object getAsRequiredObject(String key)
```
    Return a mandatory property.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value
    
    Throws:
    
    IllegalArgumentException - runtime exception if the property is missing
  - getAsRequiredObjectOfClass
```
Object getAsRequiredObjectOfClass(String key,
                                  Class<? extends Object> expectedClass)
```
    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
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredSettingsList
```
ISettingsList getAsRequiredSettingsList(String key)
```
    Parameters:
    
    key - the key you look for
    
    Returns:
    
    a target List<Object>
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - getAsRequiredSettingsMap
```
ISettingsMap getAsRequiredSettingsMap(String key)
```
    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.
    
    Parameters:
    
    key - the sub-map key name
    
    Returns:
    
    the sub map, if found
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property
    
    IllegalArgumentException - runtime exception if requested property is missing
  - setOriginatorName
```
ISettingsMap setOriginatorName(String originatorName)
```
    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.
    
    Parameters:
    
    originatorName - the name to associate
    
    Returns:
    
    this settings map
  - getOriginatorName
```
String getOriginatorName()
```
    Returns:
    
    current value of string used to identify naming context in exception/log strings.
  - getAsTimeValue
```
TimeValue getAsTimeValue(String key,
                         TimeValue defaultValue)
```
    Return a TimeValue
    
    Parameters:
    
    key - the timeValue key
    
    defaultValue - a default TimeValue
    
    Returns:
    
    the found TimeValue or null
  - getAsRequiredTimeValue
```
TimeValue getAsRequiredTimeValue(String key)
```
    Return a mandatory TimeValue
    
    Parameters:
    
    key - the timeValue key
    
    Returns:
    
    the required TimeValue
  - getAsRequiredIsoDateTime
```
org.joda.time.DateTime getAsRequiredIsoDateTime(String key)
```
    Parameters:
    
    key - the key of the timestamp
    
    Returns:
    
    an expected timestamp in iso format
  - getAsIsoDateTime
```
org.joda.time.DateTime getAsIsoDateTime(String key,
                                        org.joda.time.DateTime defaultValue)
```
    Parameters:
    
    key - the key of the timestamp
    
    defaultValue - the default value
    
    Returns:
    
    an expected timestamp in iso format
  - getAsRequiredZonedDateTime
```
ZonedDateTime getAsRequiredZonedDateTime(String key)
```
    Parameters:
    
    key - the key of the timestamp
    
    Returns:
    
    an expected timestamp in zone date time format
  - overrideWith
```
void overrideWith(ISettingsMap otherSettings)
```
    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
    
    Parameters:
    
    otherSettings - the new settings
  - putUsingDottedPath
```
ISettingsMap putUsingDottedPath(String path,
                                Object value)
```
    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
    
    Parameters:
    
    path - dot-separated settings path
    
    value - the value
    
    Returns:
    
    this instance
  - putUsingSlashPath
```
ISettingsMap putUsingSlashPath(String path,
                               Object value)
```
    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
    
    Parameters:
    
    dottedPath - dot-separated settings path allowing to navigate in a tree of settings map down to the leaf or node that has to be put
    
    value - the value
    
    Returns:
    
    this instance
  - asJsonString
```
String asJsonString()
```
    Returns:
    
    a Json representation of this settings map.
  - asHjsonString
```
String asHjsonString()
```
    Returns:
    
    a HJson representation of this settings map.
  - asYamlString
```
String asYamlString()
```
    Returns:
    
    a Yaml representation of this settings map.
  - asFlatValuesMap
```
Map<String,Object> asFlatValuesMap()
```
    Returns:
    
    a value map indexed by dotted key path "my"."subsetting"."setting" => value
  - asFlatValuesMap
```
Map<String,Object> asFlatValuesMap(String indexedBy)
```
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a value map indexed by a specified key path "my"."subsetting"."setting" => value
  - asFlatValuesMapIgnoreSettingsList
```
Map<String,Object> asFlatValuesMapIgnoreSettingsList(String indexedBy)
```
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a value map indexed by a specified key path "my"."subsetting"."setting" => value
  - asListFlatValuesMapIgnoreSettingsList
```
List<Map<String,Object>> asListFlatValuesMapIgnoreSettingsList(String indexedBy)
```
    Parameters:
    
    indexedBy - the character to use as seperator
    
    Returns:
    
    a list of value map indexed by a specified key path "my"."subsetting"."setting" => value
  - asJsonString
```
String asJsonString(IJsonSerializer s)
```
    This variant relies on an external serializer to deal with unsupported classes found in the SettingsMap. For example Files.
    
    Parameters:
    
    s - your external serializer
    
    Returns:
    
    a JSON representation of this settings map.
  - childFileAsMap
```
ISettingsMap childFileAsMap(String key)
```
    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.
    
    Parameters:
    
    key - tfile name; relative to where you are.
    
    Returns:
    
    the decoded dictionary
    
    Throws:
    
    IllegalArgumentException - if the child cannot be converted into or is not a map.
  - getCreateMap
```
@Deprecated
ISettingsMap getCreateMap(String key)
```
    Deprecated. use instead getMapOrEmpty
    
    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.
    
    Parameters:
    
    key - the sub map key.
    
    Returns:
  - childAsRawContent
```
byte[] childAsRawContent(String key)
```
    Retrieve the content of a file node. Watchout if the file is not found an empty byte array is returned.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the file node content
    
    Throws:
    
    IllegalArgumentException - if the child node is not of the expected type
  - childIsFile
```
boolean childIsFile(String key)
```
    Parameters:
    
    key - the name of a child property
    
    Returns:
    
    true if the child is a regular file
  - childIsDir
```
boolean childIsDir(String key)
```
    Parameters:
    
    key - the name of a child property
    
    Returns:
    
    true if the child is a regular directory
  - childAsTarGz
```
byte[] childAsTarGz(String dirName)
```
    Assuming the SettingsMap contains a folder, this method returns a tar gz byte array of all its content.
    
    Parameters:
    
    dirName - the child directory name
    
    Returns:
    
    the corresponding compressed archive
  - childAsStringContent
```
default String childAsStringContent(String key)
                             throws IllegalArgumentException
```
    Retrieve the content of a file node as a String. Do not be misleaded by the name of this method. This will not read anything from your local filesystem. It will simply return to you the content of a property that originally comes from a file.
    To speak clearly if your settings map is backed by zookeeper, the content comes from zookeeper.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the file node content
    
    Throws:
    
    IllegalArgumentException - if the child node is not of the expected type
  - childAsMapEntries
```
default List<Map.Entry<String,ISettingsMap>> childAsMapEntries(String key)
```
    Make it easier to iterate over child map entries.
    
    Parameters:
    
    key - the expected child name
    
    Returns:
    
    the child map value or an empty list
  - childAsMapValues
```
default List<ISettingsMap> childAsMapValues(String key)
```
    Make it easier to iterate over child map values.
    
    Parameters:
    
    key - the expected child name
    
    Returns:
    
    the child map value or an empty list
  - getCreateAsListOfMap
```
default List<ISettingsMap> getCreateAsListOfMap(String key)
```
    Return a child node of your map, expecting a list of map. If the child does not exist an empty list is returned.
    
    Parameters:
    
    key - key the expected child name
    
    Returns:
    
    the child list value
  - childAsString
```
default String childAsString(String key)
```
    Return a child node of your map, expecting a String. If the child does not exist null is returned
    
    Parameters:
    
    key - the expected child name
    
    Returns:
    
    the child map value
  - childAsRequiredString
```
default String childAsRequiredString(String key)
```
    Return a child node of your map, expecting a String.
    
    Parameters:
    
    key - the expected child name
    
    Returns:
    
    the child map value
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if the property exists but is not a String.
    
    IllegalArgumentException - runtime exception if the property is missing
  - childAsListOfString
```
default List<String> childAsListOfString(String key)
```
    Return a child node of your map, expecting a list of string. If the child does not exist an empty list is returned.
    
    Parameters:
    
    key - key the expected child name
    
    Returns:
    
    the child list value
  - childAsRequiredListOfString
```
default List<String> childAsRequiredListOfString(String key)
```
    Return a required child node of your map, expecting a list of string.
    
    Parameters:
    
    key - key the expected child name
    
    Returns:
    
    the child list value
    
    Throws:
    
    UnexpectedSettingTypeException - runtime exception if requested child is not actual type of non-null property
  - childAsJson
```
String childAsJson(String key)
```
    Whatever be the type of the child, return a json representation of it.
    
    Parameters:
    
    key - the child key.
    
    Returns:
    
    the child string representation
  - setPropertyIfMissing
```
ISettingsMap setPropertyIfMissing(String key,
                                  Object value)
```
    Set a property only if it does not exists yet.
    
    Parameters:
    
    key - the property key
    
    value - the property value
    
    Returns:
    
    this map
  - getTimeValueMs
```
long getTimeValueMs(String key,
                    long defaultValue)
```
    Given a "100ms" "10m" "1h" "2d" representation, return the corresponding value in ms.
    
    Parameters:
    
    key - the property key
    
    defaultValue - the defaultValue
    
    Returns:
    
    the value in milliseconds
  - setNestedProperty
```
ISettingsMap setNestedProperty(Object value,
                               String... keys)
```
    Add a nested property.
    This lets you add directly an inner property. For example:
```
 map.addNestedProperty(23, "user", "bob", "age");
 
```
    Parameters:
    
    value - the value
    
    keys - the list of keys
    
    Returns:
    
    this builder
  - getNestedProperty
```
Object getNestedProperty(Object defaultValue,
                         String... keys)
```
    Get an optional nested property identified by a succession of keys to navigate into the properties tree
    
    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
```
Object getRequiredNestedProperty(String... keys)
```
    Get a required nested property identified by a succession of keys to navigate into the properties tree
    
    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)
  - getOrCreateNestedSettingsMap
```
ISettingsMap getOrCreateNestedSettingsMap(String... keys)
```
    Get a nested settings map identified by a succession of keys to navigate into the properties tree
    
    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.
  - getDeepCopy
```
ISettingsMap getDeepCopy()
```
    Get a deep copy object of this map. Useful when data encapsulation is required.
    
    Returns:
    
    the SettingMap copy
  - removeUsingDottedPath
```
ISettingsMap removeUsingDottedPath(String path)
```
    Remove a leaf node using a dotted path. This method has no effect if the path does not exist.
    
    Parameters:
    
    string - the dotted path
    
    Returns:
    
    this map without the removerd node.
  - removeUsingSlashPath
```
ISettingsMap removeUsingSlashPath(String path)
```
    Remove a leaf node using a dotted path. This method has no effect if the path does not exist.
    
    Parameters:
    
    string - the dotted path
    
    Returns:
    
    this map without the removerd node.
  - asKvString
```
String asKvString()
```
    Returns:
    
    a simple key value flatten representation, handy for logging.
  - getMapOrEmpty
```
ISettingsMap getMapOrEmpty(String key)
```
    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.
    Parameters:
    
    key - the sub map key
    
    Returns:
    
    the found map or an empty one.
  - getAsSettingsListOrEmpty
```
ISettingsList getAsSettingsListOrEmpty(String key)
```
    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.
    Parameters:
    
    key - the sub list key
    
    Returns:
    
    the found list or an empty one.

Interface ISettingsMap

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.Map

Method Detail

getAsMsDuration

getAsBoolean

getAsString

getAsLong

getAsDouble

getAsInteger

getAsSettingsList

getAsSettingsMap

getAsBoolean

getAsString

getAsLong

getAsInteger

getAsSettingsList

getAsSettingsMap

getAsRequiredBoolean

getAsRequiredLong

getAsRequiredDouble

getAsRequiredInteger

getAsRequiredString

getStringOrFail

getStringOrFail

getAsRequiredObject

getAsRequiredObjectOfClass

getAsRequiredSettingsList

getAsRequiredSettingsMap

setOriginatorName

getOriginatorName

getAsTimeValue

getAsRequiredTimeValue

getAsRequiredIsoDateTime

getAsIsoDateTime

getAsRequiredZonedDateTime

overrideWith

putUsingDottedPath

putUsingSlashPath

asJsonString

asHjsonString

asYamlString

asFlatValuesMap

asFlatValuesMap

asFlatValuesMapIgnoreSettingsList

asListFlatValuesMapIgnoreSettingsList

asJsonString

childFileAsMap

getCreateMap

childAsRawContent

childIsFile

childIsDir

childAsTarGz

childAsStringContent

childAsMapEntries

childAsMapValues

getCreateAsListOfMap

childAsString

childAsRequiredString

childAsListOfString

childAsRequiredListOfString

childAsJson

setPropertyIfMissing

getTimeValueMs

setNestedProperty

getNestedProperty

getRequiredNestedProperty

getOrCreateNestedSettingsMap

getDeepCopy

removeUsingDottedPath

removeUsingSlashPath

asKvString

getMapOrEmpty

getAsSettingsListOrEmpty