-
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,org.refcodes.mixin.Clearable
,Containable
,org.refcodes.mixin.DelimiterAccessor
,Dictionary<String,Object>
,Dictionary.MutableDictionary<String,Object>
,org.refcodes.mixin.Dumpable
,org.refcodes.mixin.EmptyAccessor
,InterOperableMap<Object>
,InterOperableMap.MutableInterOperableMap<Object>
,Keys<String,Object>
,Keys.MutableKeys<String,Object>
,Keys.MutableValues<String,Object>
,Map<String,Object>
,PathMap<Object>
,PathMap.MutablePathMap<Object>
,SimpleTypeMap
,org.refcodes.mixin.TypeAccessor<Object>
- All Known Subinterfaces:
SimpleTypeMap.SimpleTypeMapBuilder
- All Known Implementing Classes:
SimpleTypeMapBuilderImpl
- Enclosing interface:
- SimpleTypeMap
public static interface SimpleTypeMap.MutableSimpleTypeMap extends SimpleTypeMap, InterOperableMap.MutableInterOperableMap<Object>, Map<String,Object>
TheSimpleTypeMap.MutableSimpleTypeMap
adds functionality for manipulating the internal state to theSimpleTypeMap
.
-
-
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.struct.Dictionary
Dictionary.MutableDictionary<K,V>
-
Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary.MutableDictionary
Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>
-
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.InterOperableMap
InterOperableMap.InterOperableMapBuilder<T>, InterOperableMap.MutableInterOperableMap<T>
-
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.SimpleTypeMap
SimpleTypeMap.MutableSimpleTypeMap, SimpleTypeMap.SimpleTypeMapBuilder
-
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>
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default boolean
containsValue(Object value)
This method is defined for the sake ofMap
conformity.default void
insert(SimpleTypeMap aFrom)
Method to semantically emphasize that we support our own types.default void
insertBetween(String aToPath, SimpleTypeMap aFrom, String aFromPath)
Method to semantically emphasize that we support our own types.default void
insertFrom(SimpleTypeMap aFrom, String aFromPath)
Method to semantically emphasize that we support our own types.default void
insertTo(String aToPath, SimpleTypeMap aFrom)
Method to semantically emphasize that we support our own types.default Object
put(Object[] aPathElements, Object aValue)
Puts the given value into the child's path, relative to the given parent's path.default Object
put(String[] aPathElements, Object aValue)
Puts the given value into the child's path, relative to the given parent's path.default Object
put(Relation<String,Object> aRelation)
Adds the given element related to the given key.default void
putAll(Map<? extends String,? extends Object> aProperties)
default void
putAll(Properties aProperties)
This method inserts all elements (key/value-pairs) found in the providedProperties
instances of interoperability reasons.default void
putAll(SimpleTypeMap aProperties)
This method inserts all elements (key/value-pairs) found in the providedSimpleTypeMap
instances of interoperability reasons.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(Object[] aPathElements, int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(Object aPath, int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(String[] aPathElements, int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(String aPath, int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
putDirAt(Collection<?> aPathElements, int aIndex, PathMap<Object> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
removeAll(Object aPathQuery)
Removes all elements which's keys match the provided path query.default SimpleTypeMap
removeAll(Object... aPathQueryElements)
Removes all elements which's keys match the provided path query.default SimpleTypeMap
removeAll(String aPathQuery)
Removes all elements which's keys match the provided path query.default SimpleTypeMap
removeAll(String... aPathQueryElements)
Removes all elements which's keys match the provided path query.default SimpleTypeMap
removeAll(Collection<?> aPathQueryElements)
Removes all elements which's keys match the provided path query.default SimpleTypeMap
removeAll(Pattern aRegExp)
Removes all elements which's keys match the provided regular expression: Queries the keys of the instance using the providedPattern
default SimpleTypeMap
removeDirAt(int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
removeFrom(Object aPath)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.default SimpleTypeMap
removeFrom(Object... aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.default SimpleTypeMap
removeFrom(String aPath)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.default SimpleTypeMap
removeFrom(String... aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.default SimpleTypeMap
removeFrom(Collection<?> aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.default SimpleTypeMap
removePaths(String... aPaths)
Removes the paths contained in the provided collection.default SimpleTypeMap
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.struct.Containable
size
-
Methods inherited from interface org.refcodes.struct.InterOperableMap
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.InterOperableMap.MutableInterOperableMap
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.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, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, 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, 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, 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, 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.SimpleTypeMap
getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, 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
-
-
-
-
Method Detail
-
containsValue
default boolean containsValue(Object value)
This method is defined for the sake ofMap
conformity. Tests whether the provided value has a key assigned.- Specified by:
containsValue
in interfaceInterOperableMap.MutableInterOperableMap<Object>
- Specified by:
containsValue
in interfaceKeys<String,Object>
- Specified by:
containsValue
in interfaceMap<String,Object>
- Specified by:
containsValue
in interfaceSimpleTypeMap
- 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(SimpleTypeMap aFrom)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insert(Object)
.- Parameters:
aFrom
- TheSimpleTypeMap
which is to be inspected with the therein contained values being added with their according determined paths.
-
insertBetween
default void insertBetween(String aToPath, SimpleTypeMap aFrom, String aFromPath)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertBetween(String, Object, String)
.- Parameters:
aToPath
- The sub-path where to insert the object's introspected values to.aFrom
- TheSimpleTypeMap
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(SimpleTypeMap aFrom, String aFromPath)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertFrom(Object, String)
.- Parameters:
aFrom
- TheSimpleTypeMap
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, SimpleTypeMap aFrom)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertTo(String, Object)
.- Parameters:
aToPath
- The sub-path where to insert the object's introspected values to.aFrom
- TheSimpleTypeMap
which is to be inspected with the therein contained values being added with their according determined paths.
-
put
default Object put(Object[] aPathElements, Object aValue)
Puts the given value into the child's path, relative to the given parent's path.- Specified by:
put
in interfacePathMap.MutablePathMap<Object>
- 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 Object put(Relation<String,Object> aRelation)
Adds the given element related to the given key.- Specified by:
put
in interfaceDictionary.MutableDictionary<String,Object>
- Specified by:
put
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aRelation
- the relation- Returns:
- The value being replaced by the provided value or null if none value has been replaced.
-
put
default Object put(String[] aPathElements, Object aValue)
Puts the given value into the child's path, relative to the given parent's path.- Specified by:
put
in interfacePathMap.MutablePathMap<Object>
- 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(Properties aProperties)
This method inserts all elements (key/value-pairs) found in the providedProperties
instances of interoperability reasons.- Parameters:
aProperties
- AProperties
containing the key/value-pairs to be inserted.
-
putAll
default void putAll(SimpleTypeMap aProperties)
This method inserts all elements (key/value-pairs) found in the providedSimpleTypeMap
instances of interoperability reasons.- Parameters:
aProperties
- ASimpleTypeMap
containing the key/value pairs to be inserted.
-
putDirAt
default SimpleTypeMap putDirAt(Collection<?> aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(Collection<?> aPathElements, int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(Object aPath, int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(Object aPath, int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(Object[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(Object[] aPathElements, int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(String aPath, int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(String aPath, int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(String[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
putDirAt
default SimpleTypeMap putDirAt(String[] aPathElements, int aIndex, PathMap<Object> aDir) throws IllegalArgumentException
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 interfacePathMap.MutablePathMap<Object>
- 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.
- Throws:
IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isIndexDir(String)
.
-
removeAll
default SimpleTypeMap removeAll(Collection<?> aPathQueryElements)
Removes all elements which's keys match the provided path query. Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: ThePathMatcher
applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as ofWildcard.FILE
) matches zero or more characters within a path name. A double asterisk ("**" as ofWildcard.PATH
) matches zero or more characters across directory levels. A question mark ("?" as ofWildcard.CHAR
) matches exactly one character within a path name. The single asterisk ("*" as ofWildcard.FILE
), the double asterisk ("**" as ofWildcard.PATH
) and the question mark ("?" as ofWildcard.CHAR
) we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathQueryElements
- The elements representing your path query including your wildcards.- Returns:
- The removed properties.
-
removeAll
default SimpleTypeMap removeAll(Object... aPathQueryElements)
Removes all elements which's keys match the provided path query. Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: ThePathMatcher
applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as ofWildcard.FILE
) matches zero or more characters within a path name. A double asterisk ("**" as ofWildcard.PATH
) matches zero or more characters across directory levels. A question mark ("?" as ofWildcard.CHAR
) matches exactly one character within a path name. The single asterisk ("*" as ofWildcard.FILE
), the double asterisk ("**" as ofWildcard.PATH
) and the question mark ("?" as ofWildcard.CHAR
) we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathQueryElements
- The elements representing your path query including your wildcards.- Returns:
- The removed properties.
-
removeAll
default SimpleTypeMap removeAll(Object aPathQuery)
Removes all elements which's keys match the provided path query. Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: ThePathMatcher
applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as ofWildcard.FILE
) matches zero or more characters within a path name. A double asterisk ("**" as ofWildcard.PATH
) matches zero or more characters across directory levels. A question mark ("?" as ofWildcard.CHAR
) matches exactly one character within a path name. The single asterisk ("*" as ofWildcard.FILE
), the double asterisk ("**" as ofWildcard.PATH
) and the question mark ("?" as ofWildcard.CHAR
) we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathQuery
- The path query including your wildcards.- Returns:
- The removed properties.
-
removeAll
default SimpleTypeMap removeAll(Pattern aRegExp)
Removes all elements which's keys match the provided regular expression: Queries the keys of the instance using the providedPattern
- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aRegExp
- The regular expression to be used for the query.- Returns:
- The removed properties.
-
removeAll
default SimpleTypeMap removeAll(String... aPathQueryElements)
Removes all elements which's keys match the provided path query. Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: ThePathMatcher
applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as ofWildcard.FILE
) matches zero or more characters within a path name. A double asterisk ("**" as ofWildcard.PATH
) matches zero or more characters across directory levels. A question mark ("?" as ofWildcard.CHAR
) matches exactly one character within a path name. The single asterisk ("*" as ofWildcard.FILE
), the double asterisk ("**" as ofWildcard.PATH
) and the question mark ("?" as ofWildcard.CHAR
) we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathQueryElements
- The elements representing your path query including your wildcards.- Returns:
- The removed properties.
-
removeAll
default SimpleTypeMap removeAll(String aPathQuery)
Removes all elements which's keys match the provided path query. Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: ThePathMatcher
applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as ofWildcard.FILE
) matches zero or more characters within a path name. A double asterisk ("**" as ofWildcard.PATH
) matches zero or more characters across directory levels. A question mark ("?" as ofWildcard.CHAR
) matches exactly one character within a path name. The single asterisk ("*" as ofWildcard.FILE
), the double asterisk ("**" as ofWildcard.PATH
) and the question mark ("?" as ofWildcard.CHAR
) we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathQuery
- The path query including your wildcards.- Returns:
- The removed properties.
-
removeDirAt
default SimpleTypeMap 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 interfacePathMap.MutablePathMap<Object>
- Parameters:
aIndex
- The index which to use.- Returns:
- The indexed elements without the indexed path "prefixes".
-
removeDirAt
default SimpleTypeMap 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 interfacePathMap.MutablePathMap<Object>
- 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 SimpleTypeMap 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 interfacePathMap.MutablePathMap<Object>
- 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 SimpleTypeMap 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 interfacePathMap.MutablePathMap<Object>
- 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 SimpleTypeMap 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 interfacePathMap.MutablePathMap<Object>
- 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 SimpleTypeMap removeFrom(Collection<?> aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.- Specified by:
removeFrom
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default SimpleTypeMap removeFrom(Object... aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.- Specified by:
removeFrom
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default SimpleTypeMap removeFrom(Object aPath)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.- Specified by:
removeFrom
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPath
- The path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default SimpleTypeMap removeFrom(String aPath)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.- Specified by:
removeFrom
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPath
- The path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default SimpleTypeMap removeFrom(String... aPathElements)
Removes all properties below the provided path and returns thePathMap
with the removed elements, by which the paths exclude the parent's path.- Specified by:
removeFrom
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
removePaths
default SimpleTypeMap removePaths(Collection<?> aPaths)
Removes the paths contained in the provided collection.- Specified by:
removePaths
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPaths
- The paths to be removed.- Returns:
- The removed properties.
-
removePaths
default SimpleTypeMap removePaths(String... aPaths)
Removes the paths contained in the provided collection.- Specified by:
removePaths
in interfacePathMap.MutablePathMap<Object>
- Parameters:
aPaths
- The paths to be removed.- Returns:
- The removed properties.
-
-