Class MapProperties

java.lang.Object

org.refcodes.struct.MapPathTable<String>

org.refcodes.struct.MapCanonicalTable

org.refcodes.properties.MapProperties

All Implemented Interfaces:

Serializable, Map<String,String>, AnnotatorAccessor, Clearable, DelimiterAccessor, EmptyAccessor, TypeAccessor<String>, ImmutableProperties, ImmutableProperties.MutableProperties, Properties, CanonicalTable, Containable, ImmutableCanonicalTable, ImmutableCanonicalTable.MutableCanonicalTable, ImmutableInterOperableTable<String>, ImmutableInterOperableTable.MutableInterOperableTable<String>, ImmutablePathTable<String>, ImmutablePathTable.MutablePathTable<String>, ImmutableTable<String,String>, ImmutableTable.MutableTable<String,String>, InterOperableTable<String>, Keys<String,String>, Keys.MutableKeys<String,String>, Keys.MutableValues<String,String>, PathTable<String>, Table<String, String, PathTable<String>>

Direct Known Subclasses:

AbstractResourceProperties, MapImmutableProperties.Builder

public class MapProperties
extends MapCanonicalTable
implements Properties

The MapProperties class implements the Properties using a backing Map instance.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface AnnotatorAccessor

AnnotatorAccessor.AnnotatorBuilder<B>, AnnotatorAccessor.AnnotatorMutator, AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface DelimiterAccessor

DelimiterAccessor.DelimiterBuilder<B>, DelimiterAccessor.DelimiterMutator, DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface EmptyAccessor

EmptyAccessor.EmptyBuilder<B>, EmptyAccessor.EmptyMutator, EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface ImmutableCanonicalTable

ImmutableCanonicalTable.MutableCanonicalTable

Nested classes/interfaces inherited from interface ImmutableInterOperableTable

ImmutableInterOperableTable.MutableInterOperableTable<T>

Nested classes/interfaces inherited from interface ImmutablePathTable

ImmutablePathTable.MutablePathTable<T>

Nested classes/interfaces inherited from interface ImmutableProperties

ImmutableProperties.MutableProperties

Nested classes/interfaces inherited from interface ImmutableTable

ImmutableTable.MutableTable<K,V>

Nested classes/interfaces inherited from interface Keys

Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface TypeAccessor

TypeAccessor.TypeBuilder<T,B>, TypeAccessor.TypeMutator<T>, TypeAccessor.TypeProperty<T>

Field Summary

Fields inherited from class MapPathTable

_backingMap

Fields inherited from interface ImmutablePathTable

ANNOTATOR, DELIMITER

Fields inherited from interface ImmutableProperties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
MapProperties()	Create an empty Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapProperties(Object aObj)	Create a Properties instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object.
MapProperties(Map<?,?> aMap)	Create a Properties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapProperties(ImmutableProperties aProperties)	Create a Properties instance containing the elements of the provided ImmutableProperties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapProperties(Properties aProperties)	Create a Properties instance containing the elements of the provided ImmutableProperties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapProperties(Property... aProperties)	Create a Properties instance containing the provided Property instances' key/value-pairs.

Method Summary

Modifier and Type	Method	Description
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
Properties	withPut(String aKey, String aValue)

Methods inherited from class MapCanonicalTable

fromInstance, fromObject, toInstance

Methods inherited from class MapPathTable

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, createBackingMap, entrySet, equals, forEach, fromValue, fromValue, get, getAnnotator, getDelimiter, getOrDefault, getType, hashCode, insert, insertBetween, insertFrom, insertTo, isEmpty, keySet, merge, merge, mergeBetween, mergeFrom, mergeTo, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toDataStructure, toString, toType, values

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Clearable

clear

Methods inherited from interface Containable

size

Methods inherited from interface EmptyAccessor

isEmpty

Methods inherited from interface ImmutableCanonicalTable

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

Methods inherited from interface ImmutableCanonicalTable.MutableCanonicalTable

containsValue, insert, insertBetween, insertFrom, insertTo, put, put, put, put, putAll, removeFrom

Methods inherited from interface ImmutableInterOperableTable

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface ImmutableInterOperableTable.MutableInterOperableTable

containsValue, insert, insertBetween, insertFrom, insertTo, putBoolean, putBoolean, putBoolean, putBoolean, putBoolean, putByte, putByte, putByte, putByte, putByte, putChar, putChar, putChar, putChar, putChar, putClass, putClass, putClass, putClass, putClass, putDouble, putDouble, putDouble, putDouble, putDouble, putEnum, putEnum, putEnum, putEnum, putEnum, putFloat, putFloat, putFloat, putFloat, putFloat, putInt, putInt, putInt, putInt, putInt, putLong, putLong, putLong, putLong, putLong, putShort, putShort, putShort, putShort, putShort, putString, putString, putString, putString, putString

Methods inherited from interface ImmutablePathTable

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPrintable, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

Methods inherited from interface ImmutablePathTable.MutablePathTable

add, add, add, add, add, add, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, delete, delete, delete, delete, fromType, fromType, fromType, fromType, fromType, fromType, fromType, fromType, insert, insert, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, merge, merge, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, put, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, remove, remove, remove, removeValueAt, removeValueAt, removeValueAt, removeValueAt, removeValueAt, toSourceCode, toSourceCode

Methods inherited from interface ImmutableProperties

getAnnotator, getDelimiter, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getType, query, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo

Methods inherited from interface ImmutableProperties.MutableProperties

containsValue, delete, insert, insert, insertBetween, insertFrom, insertTo, putAll, putAll, putAll, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, putDirAt, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeDirAt, removeDirAt, removeDirAt, removeDirAt, removeDirAt, removeFrom, removeFrom, removeFrom, removeFrom, removePaths, removePaths

Methods inherited from interface ImmutableTable.MutableTable

put

Methods inherited from interface Keys

containsKey, get, getOr, keySet, values

Methods inherited from interface Keys.MutableValues

put

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface Properties

withInsert, withInsert, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertBetween, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertFrom, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withInsertTo, withMerge, withMerge, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeBetween, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeFrom, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withMergeTo, withPut, withPut, withPut, withPut, withPut, withPutBoolean, withPutBoolean, withPutBoolean, withPutBoolean, withPutBoolean, withPutByte, withPutByte, withPutByte, withPutByte, withPutByte, withPutChar, withPutChar, withPutChar, withPutChar, withPutChar, withPutClass, withPutClass, withPutClass, withPutClass, withPutClass, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDouble, withPutDouble, withPutDouble, withPutDouble, withPutDouble, withPutEnum, withPutEnum, withPutEnum, withPutEnum, withPutEnum, withPutFloat, withPutFloat, withPutFloat, withPutFloat, withPutFloat, withPutInt, withPutInt, withPutInt, withPutInt, withPutInt, withPutLong, withPutLong, withPutLong, withPutLong, withPutLong, withPutShort, withPutShort, withPutShort, withPutShort, withPutShort, withPutString, withPutString, withPutString, withPutString, withPutString, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemovePaths

Constructor Details

MapProperties

public MapProperties()

Create an empty Properties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

MapProperties

public MapProperties(Map<?,?> aMap)

Create a Properties instance containing the elements of the provided Map instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aMap - the properties to be added.

MapProperties

public MapProperties(Object aObj)

Create a Properties instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations: "Inspects the given object and adds all elements found in the given object. Elements of type Map, Collection and arrays are identified and handled as of their type: The path for each value in a Map is appended with its according key. The path for each value in a Collection or array is appended with its according index of occurrence (in case of a List or an array, its actual index). In case of reflection, the path for each member is appended with its according mamber's name. All elements (e.g. the members and values) are inspected recursively which results in the according paths of the terminating values."

Parameters:

aObj - The object from which the elements are to be added.

MapProperties

public MapProperties(ImmutableProperties aProperties)

Create a Properties instance containing the elements of the provided ImmutableProperties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aProperties - the properties to be added.

MapProperties

public MapProperties(Properties aProperties)

Create a Properties instance containing the elements of the provided ImmutableProperties instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aProperties - the properties to be added.

MapProperties

public MapProperties(Property... aProperties)

Create a Properties instance containing the provided Property instances' key/value-pairs.

Parameters:

aProperties - the properties to be added.

Method Details

retrieveFrom

public Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface ImmutableCanonicalTable

Specified by:

retrieveFrom in interface ImmutablePathTable<String>

Specified by:

retrieveFrom in interface ImmutableProperties

Overrides:

retrieveFrom in class MapCanonicalTable

retrieveTo

public Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface ImmutableCanonicalTable

Specified by:

retrieveTo in interface ImmutablePathTable<String>

Specified by:

retrieveTo in interface ImmutableProperties

Overrides:

retrieveTo in class MapCanonicalTable

withPut

public Properties withPut(String aKey,
 String aValue)

Specified by:

withPut in interface InterOperableTable<String>

Specified by:

withPut in interface Properties

Specified by:

withPut in interface Table<String, String, PathTable<String>>

Overrides:

withPut in class MapCanonicalTable