Module org.refcodes.struct

Package org.refcodes.struct

Interface ClassStructMap.MutableClassStructMap

All Superinterfaces:

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

All Known Subinterfaces:

ClassStructMap.ClassStructMapBuilder

All Known Implementing Classes:

ClassStructMapBuilderImpl

Enclosing interface:

ClassStructMap

public static interface ClassStructMap.MutableClassStructMap
extends ClassStructMap, PathMap.MutablePathMap<Class<?>>, Map<String,Class<?>>

The Interface MutableClassStructMap.

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.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.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.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,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

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

Method Summary

Modifier and Type	Method	Description
default boolean	containsValue(Object value)	This method is defined for the sake of Map conformity.
default void	insert(ClassStructMap aFrom)	Method to semantically emphasize that we support our own types.
default void	insertBetween(String aToPath, ClassStructMap aFrom, String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insertFrom(ClassStructMap aFrom, String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insertTo(String aToPath, ClassStructMap aFrom)	Method to semantically emphasize that we support our own types.
default Class<?>	put(Object[] aPathElements, Class<?> aValue)	Puts the given value into the child's path, relative to the given parent's path.
default String	put(Object aKey, String aValue)	Adds the given element related to the given key.
default Class<?>	put(String[] aPathElements, Class<?> aValue)	Puts the given value into the child's path, relative to the given parent's path.
default String	put(Property aProperty)	Puts the key/value-pair from the provided Property.
default Class<?>	put(Relation<String,Class<?>> aRelation)	Adds the given element related to the given key.
default void	putAll(Map<? extends String,? extends Class<?>> aProperties)
default void	putAll(Properties aProperties)	This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
default void	putAll(ClassStructMap aProperties)	This method inserts all elements (key/value-pairs) found in the provided ClassStructMap instances of interoperability reasons.
default ClassStructMap	putDirAt(int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Object[] aPathElements, int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Object[] aPathElements, int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Object aPath, int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Object aPath, int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(String[] aPathElements, int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(String[] aPathElements, int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(String aPath, int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(String aPath, int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Collection<?> aPathElements, int aIndex, Object aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	putDirAt(Collection<?> aPathElements, int aIndex, PathMap<Class<?>> aDir)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeAll(Object aPathQuery)	Removes all elements which's keys match the provided path query.
default ClassStructMap	removeAll(Object... aPathQueryElements)	Removes all elements which's keys match the provided path query.
default ClassStructMap	removeAll(String aPathQuery)	Removes all elements which's keys match the provided path query.
default ClassStructMap	removeAll(String... aPathQueryElements)	Removes all elements which's keys match the provided path query.
default ClassStructMap	removeAll(Collection<?> aPathQueryElements)	Removes all elements which's keys match the provided path query.
default ClassStructMap	removeAll(Pattern aRegExp)	Removes all elements which's keys match the provided regular expression: Queries the keys of the instance using the provided Pattern.
default ClassStructMap	removeDirAt(int aIndex)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeDirAt(Object[] aPathElements, int aIndex)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeDirAt(Object aPath, int aIndex)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeDirAt(String[] aPathElements, int aIndex)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeDirAt(String aPath, int aIndex)	An indexed directory represents all elements which begin with a path which's last path element represents an index.
default ClassStructMap	removeFrom(Object aPath)	Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
default ClassStructMap	removeFrom(Object... aPathElements)	Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
default ClassStructMap	removeFrom(String aPath)	Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
default ClassStructMap	removeFrom(String... aPathElements)	Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
default ClassStructMap	removeFrom(Collection<?> aPathElements)	Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
default ClassStructMap	removePaths(String... aPaths)	Removes the paths contained in the provided collection.
default ClassStructMap	removePaths(Collection<?> aPaths)	Removes the paths contained in the provided collection.
default Map<String,String>	toDump(Map<String,String> aDump)

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, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo, retrieveTo, toMap, toProperties

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

Methods inherited from interface org.refcodes.struct.TypeModeAccessor

getTypeMode

Method Details

containsValue

default boolean containsValue(Object value)

This method is defined for the sake of Map conformity. Tests whether the provided value has a key assigned.

Specified by:

containsValue in interface ClassStructMap

Specified by:

containsValue in interface Keys<String,Class<?>>

Specified by:

containsValue in interface Map<String,Class<?>>

Parameters:

value - The value to test if a key references this value.

Returns:

True in case the given value is referenced by a key.

insert

default void insert(ClassStructMap aFrom)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(Object).

Parameters:

aFrom - The ClassStructMap which is to be inspected with the therein contained values being added with their according determined paths.

insertBetween

default void insertBetween(String aToPath,
 ClassStructMap aFrom,
 String aFromPath)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).

Parameters:

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

aFrom - The ClassStructMap which is to be inspected with the therein contained values being added with their according determined paths.

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

insertFrom

default void insertFrom(ClassStructMap aFrom,
 String aFromPath)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertFrom(Object, String).

Parameters:

aFrom - The ClassStructMap which is to be inspected with the therein contained values being added with their according determined paths.

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

insertTo

default void insertTo(String aToPath,
 ClassStructMap aFrom)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertTo(String, Object).

Parameters:

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

aFrom - The ClassStructMap which is to be inspected with the therein contained values being added with their according determined paths.

put

default String put(Object aKey,
 String aValue)

Adds the given element related to the given key. As the key passed is an enumeration, the Enum.toString() method is used on the enumeration to resolve the enumeration to a {link String} key.

Parameters:

aKey - The key for which to add the element.

aValue - The value to be related with the given key.

Returns:

The value being replaced by the provided value or null if none value has been replaced.

put

default Class<?> put(Object[] aPathElements,
 Class<?> aValue)

Puts the given value into the child's path, relative to the given parent's path.

Specified by:

put in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path relative to which to put the value.

aValue - The value to be added.

Returns:

The replaced value in case a value has already been set for the resulting path, or null.

put

default String put(Property aProperty)

Puts the key/value-pair from the provided Property.

Parameters:

aProperty - The property's key/value to be inserted.

Returns:

The property value overwritten by the provided property.

put

default Class<?> put(Relation<String,Class<?>> aRelation)

Adds the given element related to the given key.

Specified by:

put in interface PathMap.MutablePathMap<Class<?>>

Specified by:

put in interface Table.TableDictionary<String,Class<?>>

Parameters:

aRelation - the relation

Returns:

The value being replaced by the provided value or null if none value has been replaced.

put

default Class<?> put(String[] aPathElements,
 Class<?> aValue)

Puts the given value into the child's path, relative to the given parent's path.

Specified by:

put in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path relative to which to put the value.

aValue - The value to be added.

Returns:

The replaced value in case a value has already been set for the resulting path, or null.

putAll

default void putAll(ClassStructMap aProperties)

This method inserts all elements (key/value-pairs) found in the provided ClassStructMap instances of interoperability reasons.

Parameters:

aProperties - A ClassStructMap containing the key/value pairs to be inserted.

putAll

default void putAll(Properties aProperties)

This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.

Parameters:

aProperties - A Properties containing the key/value-pairs to be inserted.

putAll

default void putAll(Map<? extends String,? extends Class<?>> aProperties)

Specified by:

putAll in interface Map<String,Class<?>>

putDirAt

default ClassStructMap putDirAt(Collection<?> aPathElements,
 int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(Collection<?> aPathElements,
 int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(Object aPath,
 int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(Object aPath,
 int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(Object[] aPathElements,
 int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(Object[] aPathElements,
 int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(String aPath,
 int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(String aPath,
 int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(String[] aPathElements,
 int aIndex,
 Object aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

putDirAt

default ClassStructMap putDirAt(String[] aPathElements,
 int aIndex,
 PathMap<Class<?>> aDir)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.

Specified by:

putDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements of the path where to put the indexed element.

aIndex - The index of the indexed element.

aDir - The values to be put at the index.

Returns:

The directory which has been replaced by the given directory.

removeAll

default ClassStructMap removeAll(Collection<?> aPathQueryElements)

Removes all elements which's keys match the provided path query. Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathQueryElements - The elements representing your path query including your wildcards.

Returns:

The removed properties.

removeAll

default ClassStructMap removeAll(Object... aPathQueryElements)

Removes all elements which's keys match the provided path query. Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathQueryElements - The elements representing your path query including your wildcards.

Returns:

The removed properties.

removeAll

default ClassStructMap removeAll(Object aPathQuery)

Removes all elements which's keys match the provided path query. Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathQuery - The path query including your wildcards.

Returns:

The removed properties.

removeAll

default ClassStructMap removeAll(Pattern aRegExp)

Removes all elements which's keys match the provided regular expression: Queries the keys of the instance using the provided Pattern.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aRegExp - The regular expression to be used for the query.

Returns:

The removed properties.

removeAll

default ClassStructMap removeAll(String... aPathQueryElements)

Removes all elements which's keys match the provided path query. Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathQueryElements - The elements representing your path query including your wildcards.

Returns:

The removed properties.

removeAll

default ClassStructMap removeAll(String aPathQuery)

Removes all elements which's keys match the provided path query. Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.

Specified by:

removeAll in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathQuery - The path query including your wildcards.

Returns:

The removed properties.

removeDirAt

default ClassStructMap removeDirAt(int aIndex)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the root path. Given the following paths and index = 1: /0/0aaa /0/0bbb /0/0bbb /1/1aaa /1/1bbb /1/1bbb You will get a result containing all the elements which's keys begin with "/1/". The keys of the result will exclude the path "prefix" "/1".

Specified by:

removeDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aIndex - The index which to use.

Returns:

The indexed elements without the indexed path "prefixes".

removeDirAt

default ClassStructMap removeDirAt(Object aPath,
 int aIndex)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/". The keys of the result will exclude the path "prefix" "/root/child/1".

Specified by:

removeDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path from which to remove the indexed elements.

aIndex - The index which to use.

Returns:

The indexed elements without the indexed path "prefixes".

removeDirAt

default ClassStructMap removeDirAt(Object[] aPathElements,
 int aIndex)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".

Specified by:

removeDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The elements of the path from which to remove the indexed elements.

aIndex - The index which to use.

Returns:

The indexed elements without the indexed path "prefixes".

removeDirAt

default ClassStructMap removeDirAt(String aPath,
 int aIndex)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".

Specified by:

removeDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path from which to remove the indexed elements.

aIndex - The index which to use.

Returns:

The indexed elements without the indexed path "prefixes".

removeDirAt

default ClassStructMap removeDirAt(String[] aPathElements,
 int aIndex)

An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".

Specified by:

removeDirAt in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The elements of the path from which to remove the indexed elements.

aIndex - The index which to use.

Returns:

The indexed elements without the indexed path "prefixes".

removeFrom

default ClassStructMap removeFrom(Collection<?> aPathElements)

Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.

Specified by:

removeFrom in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements for the path from where to remove all properties.

Returns:

The removed properties.

removeFrom

default ClassStructMap removeFrom(Object... aPathElements)

Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.

Specified by:

removeFrom in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements for the path from where to remove all properties.

Returns:

The removed properties.

removeFrom

default ClassStructMap removeFrom(Object aPath)

Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.

Specified by:

removeFrom in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path from where to remove all properties.

Returns:

The removed properties.

removeFrom

default ClassStructMap removeFrom(String aPath)

Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.

Specified by:

removeFrom in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPath - The path from where to remove all properties.

Returns:

The removed properties.

removeFrom

default ClassStructMap removeFrom(String... aPathElements)

Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.

Specified by:

removeFrom in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPathElements - The path elements for the path from where to remove all properties.

Returns:

The removed properties.

removePaths

default ClassStructMap removePaths(Collection<?> aPaths)

Removes the paths contained in the provided collection.

Specified by:

removePaths in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPaths - The paths to be removed.

Returns:

The removed properties.

removePaths

default ClassStructMap removePaths(String... aPaths)

Removes the paths contained in the provided collection.

Specified by:

removePaths in interface PathMap.MutablePathMap<Class<?>>

Parameters:

aPaths - The paths to be removed.

Returns:

The removed properties.

toDump

default Map<String,String> toDump(Map<String,String> aDump)

Specified by:

toDump in interface org.refcodes.mixin.Dumpable