Class MapCanonicalTable

java.lang.Object

org.refcodes.struct.MapPathTable<String>

org.refcodes.struct.MapCanonicalTable

All Implemented Interfaces:

Serializable, Map<String,String>, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.Clearable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<String>, 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>>

public class MapCanonicalTable
extends MapPathTable<String>
implements CanonicalTable

The MapCanonicalTable class implements the CanonicalTable using a backing Map instance.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.EmptyAccessor

org.refcodes.mixin.EmptyAccessor.EmptyBuilder<B extends org.refcodes.mixin.EmptyAccessor.EmptyBuilder<B>>, org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.ImmutableCanonicalTable

ImmutableCanonicalTable.MutableCanonicalTable

Nested classes/interfaces inherited from interface org.refcodes.struct.ImmutableInterOperableTable

ImmutableInterOperableTable.MutableInterOperableTable<T>

Nested classes/interfaces inherited from interface org.refcodes.struct.ImmutablePathTable

ImmutablePathTable.MutablePathTable<T>

Nested classes/interfaces inherited from interface org.refcodes.struct.ImmutableTable

ImmutableTable.MutableTable<K,V>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

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

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

Map.Entry<K,V>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Field Summary

Fields inherited from class org.refcodes.struct.MapPathTable

_backingMap

Fields inherited from interface org.refcodes.struct.ImmutablePathTable

ANNOTATOR, DELIMITER

Constructor Summary

Constructors

Constructor	Description
MapCanonicalTable()	Create an empty CanonicalTable instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(char aDelimiter)	Create a CanonicalTable instance using the provided path delimiter for the path declarations.
MapCanonicalTable(char aDelimiter, Map<String,String> aBackingMap)	Create a CanonicalTable instance using the provided path delimiter for the path declarations.
MapCanonicalTable(Object aObj)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(Object aObj, char aDelimiter)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(Object aObj, char aDelimiter, Map<String,String> aBackingMap)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(Object aObj, String aFromPath)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(Object aObj, String aFromPath, char aDelimiter)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(Object aObj, String aFromPath, char aDelimiter, Map<String,String> aBackingMap)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(Object aObj, String aFromPath, Map<String,String> aBackingMap)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(Object aObj, Map<String,String> aBackingMap)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(String aToPath, Object aObj)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(String aToPath, Object aObj, char aDelimiter)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(String aToPath, Object aObj, char aDelimiter, Map<String,String> aBackingMap)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(String aToPath, Object aObj, String aFromPath)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.
MapCanonicalTable(String aToPath, Object aObj, String aFromPath, char aDelimiter)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(String aToPath, Object aObj, String aFromPath, char aDelimiter, Map<String,String> aBackingMap)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).
MapCanonicalTable(String aToPath, Object aObj, String aFromPath, Map<String,String> aBackingMap)	Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.
MapCanonicalTable(String aToPath, Object aObj, Map<String,String> aBackingMap)	Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
MapCanonicalTable(Map<String,String> aBackingMap)	Create an empty CanonicalTable instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Method Summary

Modifier and Type	Method	Description
protected String	fromInstance(Object aValue)	Hook method when introspecting an object to help conversion of that object to the target types.
protected ImmutablePathTable<String>	fromObject(Object aFrom)	Hook method when internally creating ImmutablePathTable sub-types in the according ImmutablePathTable sub-type implementations.
CanonicalTable	retrieveFrom(String aFromPath)	Extracts a new PathTable from the elements of this instance found below the "from-path".
CanonicalTable	retrieveTo(String aToPath)	Extracts a new PathTable from this instance's elements with the paths relocated to the provided "to-path".
protected <TYPE> TYPE	toInstance(String aValue, Class<TYPE> aType)	Hook method when reconstructing an object, opposite of MapPathTable.fromInstance(Object), tries to convert the given value to the desired type.
CanonicalTable	withPut(String aKey, String aValue)	Builder method for Keys.MutableValues.put(Object, Object).

Methods inherited from class org.refcodes.struct.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 java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.AnnotatorAccessor

getAnnotator

Methods inherited from interface org.refcodes.struct.CanonicalTable

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

Methods inherited from interface org.refcodes.mixin.Clearable

clear

Methods inherited from interface org.refcodes.struct.Containable

size

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

Methods inherited from interface org.refcodes.struct.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, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, query, query, query, query, query, queryBetween, 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, toMap, toProperties

Methods inherited from interface org.refcodes.struct.ImmutableCanonicalTable.MutableCanonicalTable

containsValue, insert, insertBetween, insertFrom, insertTo, put, put, put, put, put, 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, removeFrom, removePaths, removePaths

Methods inherited from interface org.refcodes.struct.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 org.refcodes.struct.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 org.refcodes.struct.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 org.refcodes.struct.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, 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 org.refcodes.struct.Keys

containsKey, get, getOr, keySet, use, values

Methods inherited from interface org.refcodes.struct.Keys.MutableValues

put

Methods inherited from interface java.util.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 org.refcodes.mixin.TypeAccessor

getType

Constructor Details

MapCanonicalTable

public MapCanonicalTable()

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

MapCanonicalTable

public MapCanonicalTable(char aDelimiter)

Create a CanonicalTable instance using the provided path delimiter for the path declarations.

Parameters:

aDelimiter - The path delimiter to be used for the path declarations.

MapCanonicalTable

public MapCanonicalTable(Object aObj)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

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

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 String aFromPath)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

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

aFromPath - The path from where to start adding elements of the provided object.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 String aFromPath)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aFromPath - The path from where to start adding elements of the provided object.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 char aDelimiter)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

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

aDelimiter - The path delimiter to be used for the path declarations.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 char aDelimiter)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aDelimiter - The path delimiter to be used for the path declarations.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 String aFromPath,
 char aDelimiter)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

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

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 String aFromPath,
 char aDelimiter)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

MapCanonicalTable

public MapCanonicalTable(Map<String,String> aBackingMap)

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

Parameters:

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(char aDelimiter,
 Map<String,String> aBackingMap)

Create a CanonicalTable instance using the provided path delimiter for the path declarations.

Parameters:

aDelimiter - The path delimiter to be used for the path declarations.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 Map<String,String> aBackingMap)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

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

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 Map<String,String> aBackingMap)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 String aFromPath,
 Map<String,String> aBackingMap)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

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

aFromPath - The path from where to start adding elements of the provided object.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 String aFromPath,
 Map<String,String> aBackingMap)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aFromPath - The path from where to start adding elements of the provided object.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 char aDelimiter,
 Map<String,String> aBackingMap)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

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

aDelimiter - The path delimiter to be used for the path declarations.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 char aDelimiter,
 Map<String,String> aBackingMap)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aDelimiter - The path delimiter to be used for the path declarations.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(Object aObj,
 String aFromPath,
 char aDelimiter,
 Map<String,String> aBackingMap)

Creates a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

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

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

aBackingMap - The backing map used as underlying Map instance.

MapCanonicalTable

public MapCanonicalTable(String aToPath,
 Object aObj,
 String aFromPath,
 char aDelimiter,
 Map<String,String> aBackingMap)

Create a CanonicalTable instance containing the elements as of ImmutablePathTable.MutablePathTable.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

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

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

aBackingMap - The backing map used as underlying Map instance.

Method Details

retrieveFrom

public CanonicalTable retrieveFrom(String aFromPath)

Extracts a new PathTable from the elements of this instance found below the "from-path". The sub-paths will be the root paths for the new PathTable. Given we have a value for path "/dog/cat" in the PathTable and we call ImmutablePathTable.retrieveFrom(String) with "/dog", then the resulting PathTable will contain the path "/cat" for that value.

Specified by:

retrieveFrom in interface ImmutableCanonicalTable

Specified by:

retrieveFrom in interface ImmutablePathTable<String>

Overrides:

retrieveFrom in class MapPathTable<String>

Parameters:

aFromPath - The path from where to start extracting the paths.

Returns:

The PathTable with the elements below the provided path which are root elements in the new PathTable.

retrieveTo

public CanonicalTable retrieveTo(String aToPath)

Extracts a new PathTable from this instance's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathTable and we call ImmutablePathTable.retrieveTo(String) with "/animals", then the resulting PathTable will contain the path "/animals/dog/cat" for that value.

Specified by:

retrieveTo in interface ImmutableCanonicalTable

Specified by:

retrieveTo in interface ImmutablePathTable<String>

Overrides:

retrieveTo in class MapPathTable<String>

Parameters:

aToPath - The path where to relocate the paths of this PathTable to.

Returns:

The PathTable with the elements from the provided PathTable with accordingly relocated paths.

withPut

public CanonicalTable withPut(String aKey,
 String aValue)

Builder method for Keys.MutableValues.put(Object, Object).

Specified by:

withPut in interface InterOperableTable<String>

Specified by:

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

Overrides:

withPut in class MapPathTable<String>

Parameters:

aKey - the key for the property to be put.

aValue - the value for the property to be put.

Returns:

The implementing instance as of the builder pattern.

fromObject

protected ImmutablePathTable<String> fromObject(Object aFrom)

Hook method when internally creating ImmutablePathTable sub-types in the according ImmutablePathTable sub-type implementations.

Overrides:

fromObject in class MapPathTable<String>

Parameters:

aFrom - The Object from which to create a ImmutablePathTable (sub-type) instance.

Returns:

The according ImmutablePathTable (sub-type) instance.

fromInstance

protected String fromInstance(Object aValue)

Hook method when introspecting an object to help conversion of that object to the target types. By default this methods just tests for assignment conformity as of Class.isAssignableFrom(Class) with the type retrieved by MapPathTable.getType().

Overrides:

fromInstance in class MapPathTable<String>

Parameters:

aValue - The value which is to be transformed to the expected type as of MapPathTable.getType().

Returns:

The converted type or null if conversion is not possible.

toInstance

protected <TYPE> TYPE toInstance(String aValue,
 Class<TYPE> aType)

Hook method when reconstructing an object, opposite of MapPathTable.fromInstance(Object), tries to convert the given value to the desired type.

Overrides:

toInstance in class MapPathTable<String>

Type Parameters:

TYPE - The type to which to convert to.

Parameters:

aValue - The value to by converted from this instance's type as of MapPathTable.getType() to the desired type.

aType - The type to which to convert to.

Returns:

The converted type or null if conversion is not possible.