org.thales.punch.settings.impl

Class NamedSettingsMapImpl

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.thales.punch.settings.impl.SettingsMapImpl

org.thales.punch.settings.impl.NamedSettingsMapImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonSettingsMapImpl, YamlSettingsMapImpl

public class NamedSettingsMapImpl
extends SettingsMapImpl

This implementation provides hierarchical naming context of settings when displaying a log or throwing an exception.

This is useful to provide feedback to a final user on the location of a missing/invalid parameter not as HashMap : the constructor taking a map as parameter works by deep copy (internal sub-settings objects are NOT shared with the original).

This is required in order to provide separate naming context for errors

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 inherited from class org.thales.punch.settings.impl.SettingsMapImpl

originatorName

Constructor Summary

Constructors

Constructor and Description
NamedSettingsMapImpl(Map<String,Object> map, String name) Does Deep copy of settings, to avoid changing the naming of a setting already including in an other settings tree
NamedSettingsMapImpl(String originatorName) Public Ctor

Method Summary

Modifier and Type	Method and Description
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
Object	put(String key, Object object)
void	putAll(Map<? extends String,? extends Object> map)
Object	putWithNoCloning(String key, Object object) Put the object as reference.
ISettingsMap	setOriginatorName(String name) SettingsMap can be associated with a name referencing the original file (typically0.

Methods inherited from class org.thales.punch.settings.impl.SettingsMapImpl

asFlatValuesMap, asFlatValuesMap, asFlatValuesMapIgnoreSettingsList, asHjsonString, asJsonString, asJsonString, asKvString, asListFlatValuesMapIgnoreSettingsList, asYamlString, childAsJson, childAsRawContent, childAsTarGz, childFileAsMap, childIsDir, childIsFile, getAsBoolean, getAsBoolean, getAsDouble, getAsInteger, getAsInteger, getAsIsoDateTime, getAsLong, getAsLong, getAsMsDuration, getAsRequiredBoolean, getAsRequiredDouble, getAsRequiredInteger, getAsRequiredIsoDateTime, getAsRequiredLong, getAsRequiredObject, getAsRequiredObjectOfClass, getAsRequiredSettingsList, getAsRequiredSettingsMap, getAsRequiredString, getAsRequiredTimeValue, getAsRequiredZonedDateTime, getAsSettingsList, getAsSettingsList, getAsSettingsListOrEmpty, getAsSettingsMap, getAsSettingsMap, getAsString, getAsString, getAsTimeValue, getChildName, getCreateMap, getDeepCopy, getMapOrEmpty, getNestedProperty, getNewInstance, getOrCreateNestedSettingsMap, getOriginatorName, getRequiredNestedProperty, getStringOrFail, getStringOrFail, getTimeValueMs, newSettingsMapChild, overrideWith, putUsingDottedPath, putUsingSlashPath, removeUsingDottedPath, removeUsingSlashPath, setJsonDecoding, setNestedProperty, setPropertyIfMissing

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, 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, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

NamedSettingsMapImpl

public NamedSettingsMapImpl(String originatorName)

Public Ctor

Parameters:

originatorName - the (typically file) name associated to this settings map

NamedSettingsMapImpl

public NamedSettingsMapImpl(Map<String,Object> map,
                            String name)

Does Deep copy of settings, to avoid changing the naming of a setting already including in an other settings tree

Parameters:

map - The settings map to deep copy

name - The name context to tag all logs/exceptions concerning properties of this map

Method Detail

newSettingsMapChild

protected ISettingsMap newSettingsMapChild(Map<String,Object> map,
                                           String name)

Description copied from class: SettingsMapImpl

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

Overrides:

newSettingsMapChild in class SettingsMapImpl

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)

Description copied from class: SettingsMapImpl

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

Overrides:

newSettingsListChild in class SettingsMapImpl

Parameters:

list - a list of of type object

name - a name

Returns:

return an ISettingsList

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

Overrides:

setOriginatorName in class SettingsMapImpl

Parameters:

name - the name to associate

Returns:

this settings map

put

public Object put(String key,
                  Object object)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class HashMap<String,Object>

putWithNoCloning

public Object putWithNoCloning(String key,
                               Object object)

Put the object as reference. Use this method only for json parsing object initialization.

Parameters:

key - the property key

object - the value

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)

putAll

public void putAll(Map<? extends String,? extends Object> map)

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class HashMap<String,Object>