Module org.refcodes.struct

Package org.refcodes.struct

Class ClassStructMapBuilderImpl

java.lang.Object

org.refcodes.struct.PathMapBuilderImpl<Class<?>>

org.refcodes.struct.ClassStructMapBuilderImpl

All Implemented Interfaces:

Serializable, Map<String,Class<?>>, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.Clearable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<Class<?>>, ClassStructMap, ClassStructMap.ClassStructMapBuilder, ClassStructMap.MutableClassStructMap, Containable, Keys<String,Class<?>>, Keys.MutableKeys<String,Class<?>>, Keys.MutableValues<String,Class<?>>, PathMap<Class<?>>, PathMap.MutablePathMap<Class<?>>, PathMap.PathMapBuilder<Class<?>>, Table<String,Class<?>>, Table.TableDictionary<String,Class<?>>, Table.TableDictionary.TableBuilder<String,Class<?>,PathMap.PathMapBuilder<Class<?>>>, TypeModeAccessor

public class ClassStructMapBuilderImpl
extends PathMapBuilderImpl<Class<?>>
implements ClassStructMap.ClassStructMapBuilder

The Class ClassStructBuilderImpl.

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.struct.ClassStructMap

ClassStructMap.ClassStructMapBuilder, ClassStructMap.MutableClassStructMap

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.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

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 extends Object,V extends Object>

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

PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>

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

Table.TableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.struct.Table.TableDictionary

Table.TableDictionary.TableBuilder<K,V,B extends Table.TableDictionary.TableBuilder<K,V,B>>

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

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

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

TypeModeAccessor.TypeModeBuilder<B extends TypeModeAccessor.TypeModeBuilder<B>>, TypeModeAccessor.TypeModeMutator, TypeModeAccessor.TypeModeProperty

Field Summary

Fields inherited from interface org.refcodes.struct.ClassStructMap

ARRAY_SELECTOR

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Constructor Summary

Constructors

Constructor	Description
ClassStructMapBuilderImpl()	Create an empty ClassStructMap.ClassStructMapBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(char aDelimiter)	Create a ClassStructMap.ClassStructMapBuilder instance using the provided path delimiter for the path declarations.
ClassStructMapBuilderImpl(char aDelimiter, SimpleType aTypeMode)	Create a ClassStructMap.ClassStructMapBuilder instance using the provided path delimiter for the path declarations.
ClassStructMapBuilderImpl(Object aObj)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(Object aObj, char aDelimiter)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(Object aObj, char aDelimiter, SimpleType aTypeMode)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(Object aObj, String aFromPath)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(Object aObj, String aFromPath, char aDelimiter)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(Object aObj, String aFromPath, char aDelimiter, SimpleType aTypeMode)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(Object aObj, String aFromPath, SimpleType aTypeMode)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(Object aObj, SimpleType aTypeMode)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(String aToPath, Object aObj)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(String aToPath, Object aObj, char aDelimiter)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(String aToPath, Object aObj, char aDelimiter, SimpleType aTypeMode)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(String aToPath, Object aObj, String aFromPath)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.
ClassStructMapBuilderImpl(String aToPath, Object aObj, String aFromPath, char aDelimiter)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(String aToPath, Object aObj, String aFromPath, char aDelimiter, SimpleType aTypeMode)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
ClassStructMapBuilderImpl(String aToPath, Object aObj, String aFromPath, SimpleType aTypeMode)	Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.
ClassStructMapBuilderImpl(String aToPath, Object aObj, SimpleType aTypeMode)	Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
ClassStructMapBuilderImpl(SimpleType aTypeMode)	Create an empty ClassStructMap.ClassStructMapBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Method Summary

Modifier and Type	Method	Description
protected Class<?>	fromInstance(Object aValue)	Hook method when introspecting an object to help conversion of that object to the target types.
protected PathMap<Class<?>>	fromObject(Object aFrom)	Hook method when internally creating PathMap sub-types in the according PathMap sub-type implementations.
protected void	fromValue(String aToPath, Object aObj)	Hook method for intercepting or modifying the process of object introspection.
SimpleType	getTypeMode()	Retrieves the type mode from the type mode property.
ClassStructMap.ClassStructMapBuilder	retrieveFrom(String aFromPath)	Extracts a new PathMap from the elements of this PathMap found below the "from-path".
ClassStructMap.ClassStructMapBuilder	retrieveTo(String aToPath)	Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path".
ClassStructMap.ClassStructMapBuilder	withPut(String aKey, Class<?> aValue)	Builder method for Keys.MutableValues.put(Object, Object).

Methods inherited from class org.refcodes.struct.PathMapBuilderImpl

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, createBackingMap, entrySet, equals, forEach, 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, toInstance, toType, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.AnnotatorAccessor

getAnnotator

Methods inherited from interface org.refcodes.struct.ClassStructMap

getArraySelector, getCompositeArrayDir, getCompositeArrayDir, getCompositeArrayDir, getCompositeArrayDir, getCompositeArrayDir, getCompositeArrayDir, getCompositeDir, getCompositeDir, getCompositeDir, getCompositeDir, getCompositeDir, getCompositeDir, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getPrimitiveArrayType, getPrimitiveArrayType, getPrimitiveArrayType, getPrimitiveArrayType, getPrimitiveArrayType, getPrimitiveArrayType, getPrimitiveType, getPrimitiveType, getPrimitiveType, getPrimitiveType, getPrimitiveType, getPrimitiveType, getSimpleArrayType, getSimpleArrayType, getSimpleArrayType, getSimpleArrayType, getSimpleArrayType, getSimpleArrayType, getSimpleType, getSimpleType, getSimpleType, getSimpleType, getSimpleType, getSimpleType, getWrapperArrayType, getWrapperArrayType, getWrapperArrayType, getWrapperArrayType, getWrapperArrayType, getWrapperArrayType, getWrapperType, getWrapperType, getWrapperType, getWrapperType, getWrapperType, getWrapperType, isArrayType, isArrayType, isArrayType, isArrayType, isArrayType, isArrayType, isCompositeArrayDir, isCompositeArrayDir, isCompositeArrayDir, isCompositeArrayDir, isCompositeArrayDir, isCompositeArrayDir, isCompositeDir, isCompositeDir, isCompositeDir, isCompositeDir, isCompositeDir, isCompositeDir, isPrimitiveArrayType, isPrimitiveArrayType, isPrimitiveArrayType, isPrimitiveArrayType, isPrimitiveArrayType, isPrimitiveArrayType, isPrimitiveType, isPrimitiveType, isPrimitiveType, isPrimitiveType, isPrimitiveType, isPrimitiveType, isSimpleArrayType, isSimpleArrayType, isSimpleArrayType, isSimpleArrayType, isSimpleArrayType, isSimpleArrayType, isSimpleType, isSimpleType, isSimpleType, isSimpleType, isSimpleType, isSimpleType, isWrapperArrayType, isWrapperArrayType, isWrapperArrayType, isWrapperArrayType, isWrapperArrayType, isWrapperArrayType, isWrapperType, isWrapperType, isWrapperType, isWrapperType, isWrapperType, isWrapperType, 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.ClassStructMap.ClassStructMapBuilder

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, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withPutDirAt, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemoveFrom, withRemovePaths

Methods inherited from interface org.refcodes.struct.ClassStructMap.MutableClassStructMap

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, toDump

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.Dumpable

toDump

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

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.struct.PathMap

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.PathMap.MutablePathMap

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.mixin.TypeAccessor

getType

Constructor Details

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl()

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

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(char aDelimiter)

Create a ClassStructMap.ClassStructMapBuilder instance using the provided path delimiter for the path declarations.

Parameters:

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

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj)

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(String aToPath,
 Object aObj)

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 String aFromPath)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

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

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 char aDelimiter)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

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

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

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

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

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

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(SimpleType aTypeMode)

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

Parameters:

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(char aDelimiter,
 SimpleType aTypeMode)

Create a ClassStructMap.ClassStructMapBuilder instance using the provided path delimiter for the path declarations.

Parameters:

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

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 SimpleType aTypeMode)

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(String aToPath,
 Object aObj,
 SimpleType aTypeMode)

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 String aFromPath,
 SimpleType aTypeMode)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(String aToPath,
 Object aObj,
 String aFromPath,
 SimpleType aTypeMode)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 char aDelimiter,
 SimpleType aTypeMode)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(String aToPath,
 Object aObj,
 char aDelimiter,
 SimpleType aTypeMode)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(Object aObj,
 String aFromPath,
 char aDelimiter,
 SimpleType aTypeMode)

Creates a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

ClassStructMapBuilderImpl

public ClassStructMapBuilderImpl(String aToPath,
 Object aObj,
 String aFromPath,
 char aDelimiter,
 SimpleType aTypeMode)

Create a ClassStructMap.ClassStructMapBuilder instance containing the elements as of PathMap.MutablePathMap.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.

aTypeMode - The SimpleType to use when processing primitive types, wrapper types or complex types.

Method Details

getTypeMode

public SimpleType getTypeMode()

Retrieves the type mode from the type mode property.

Specified by:

getTypeMode in interface TypeModeAccessor

Returns:

The type mode stored by the type mode property.

retrieveFrom

public ClassStructMap.ClassStructMapBuilder retrieveFrom(String aFromPath)

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

Specified by:

retrieveFrom in interface ClassStructMap

Specified by:

retrieveFrom in interface PathMap<Class<?>>

Overrides:

retrieveFrom in class PathMapBuilderImpl<Class<?>>

Parameters:

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

Returns:

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

retrieveTo

public ClassStructMap.ClassStructMapBuilder retrieveTo(String aToPath)

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

Specified by:

retrieveTo in interface ClassStructMap

Specified by:

retrieveTo in interface PathMap<Class<?>>

Overrides:

retrieveTo in class PathMapBuilderImpl<Class<?>>

Parameters:

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

Returns:

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

withPut

public ClassStructMap.ClassStructMapBuilder withPut(String aKey,
 Class<?> aValue)

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

Specified by:

withPut in interface Table.TableDictionary.TableBuilder<String,Class<?>,PathMap.PathMapBuilder<Class<?>>>

Overrides:

withPut in class PathMapBuilderImpl<Class<?>>

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.

fromValue

protected void fromValue(String aToPath,
 Object aObj)

Hook method for intercepting or modifying the process of object introspection.

Overrides:

fromValue in class PathMapBuilderImpl<Class<?>>

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.

fromObject

protected PathMap<Class<?>> fromObject(Object aFrom)

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

Overrides:

fromObject in class PathMapBuilderImpl<Class<?>>

Parameters:

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

Returns:

The according PathMap (sub-type) instance.

fromInstance

protected Class<?> 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 PathMapBuilderImpl.getType().

Overrides:

fromInstance in class PathMapBuilderImpl<Class<?>>

Parameters:

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

Returns:

The converted type or null if conversion is not possible.