Package org.refcodes.structure
Interface CanonicalMap.MutableCanonicalMap
-
- All Superinterfaces:
CanonicalMap
,Clearable
,Containable
,org.refcodes.mixin.DelimiterAccessor
,Dictionary<java.lang.String,T>
,Dictionary.MutableDictionary<java.lang.String,T>
,org.refcodes.mixin.Dumpable
,Keys<java.lang.String,T>
,Keys.MutableKeys<java.lang.String,T>
,Keys.MutableValues<java.lang.String,T>
,java.util.Map<java.lang.String,T>
,PathMap<java.lang.String>
,PathMap.MutablePathMap<java.lang.String>
,PropertiesAccessorMixin
,PropertiesAccessorMixin.PropertiesMutatorMixin
,org.refcodes.mixin.TypeAccessor<java.lang.String>
- All Known Subinterfaces:
CanonicalMap.CanonicalMapBuilder
- All Known Implementing Classes:
CanonicalMapBuilderImpl
- Enclosing interface:
- CanonicalMap
public static interface CanonicalMap.MutableCanonicalMap extends CanonicalMap, PathMap.MutablePathMap<java.lang.String>, PropertiesAccessorMixin.PropertiesMutatorMixin, java.util.Map<java.lang.String,java.lang.String>
The Interface MutableCanonicalMap.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap
CanonicalMap.CanonicalMapBuilder, CanonicalMap.MutableCanonicalMap
-
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.structure.Dictionary
Dictionary.MutableDictionary<K,V>
-
Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary
Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>
-
Nested classes/interfaces inherited from interface org.refcodes.structure.Keys
Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>
-
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>
-
Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap
PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>
-
Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin
PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin
-
-
Field Summary
-
Fields inherited from interface org.refcodes.structure.CanonicalMap
DEFAULT_COMMENT
-
Fields inherited from interface org.refcodes.structure.PathMap
DEFAULT_DELIMITER
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default boolean
containsValue(java.lang.Object value)
This method is defined for the sake ofMap
conformity.default java.lang.String
delete(java.lang.String aKey)
Removes an element identified by the given key.default void
insert(CanonicalMap aFrom)
Method to semantically emphasize that we support our own types.default void
insertBetween(java.lang.String aToPath, CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types.default void
insertFrom(CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types.default void
insertTo(java.lang.String aToPath, CanonicalMap aFrom)
Method to semantically emphasize that we support our own types.default java.lang.String
put(java.lang.Object[] aPathElements, java.lang.String aValue)
Sets the value for the property referred to by the path elements representing the addressed path.default java.lang.String
put(java.lang.String[] aPathElements, java.lang.String aValue)
Sets the value for the property referred to by the path elements representing the addressed path.default java.lang.String
put(Relation<java.lang.String,java.lang.String> aRelation)
Adds the given element related to the given key.default void
putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)
default void
putAll(java.util.Properties aProperties)
This method inserts all elements (key/value-pairs) found in the providedProperties
instances of interoperability reasons.default void
putAll(CanonicalMap aProperties)
This method inserts all elements (key/value-pairs) found in the providedCanonicalMap
instances of interoperability reasons.default java.lang.String
putBoolean(java.lang.Object[] aPathElements, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putBoolean(java.lang.String[] aPathElements, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putByte(java.lang.Object[] aPathElements, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putByte(java.lang.String[] aPathElements, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the path elements representing the addressed path.default CanonicalMap
putDirAt(int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.Object[] aPathElements, int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.Object[] aPathElements, int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.Object aPath, int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.Object aPath, int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.String[] aPathElements, int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.String[] aPathElements, int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.String aPath, int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.lang.String aPath, int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.util.Collection<?> aPathElements, int aIndex, java.lang.Object aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
putDirAt(java.util.Collection<?> aPathElements, int aIndex, PathMap<java.lang.String> aDir)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default java.lang.String
putDouble(java.lang.Object[] aPathElements, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putDouble(java.lang.String[] aPathElements, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putFloat(java.lang.Object[] aPathElements, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putFloat(java.lang.String[] aPathElements, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putInteger(java.lang.Object[] aPathElements, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putInteger(java.lang.String[] aPathElements, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putLong(java.lang.Object[] aPathElements, java.lang.Long aValue)
Sets theLong
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putLong(java.lang.String[] aPathElements, java.lang.Long aValue)
Sets theLong
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putShort(java.lang.Object[] aPathElements, java.lang.Short aValue)
Sets theShort
value for the property referred to by the path elements representing the addressed path.default java.lang.String
putShort(java.lang.String[] aPathElements, java.lang.Short aValue)
Sets theShort
value for the property referred to by the path elements representing the addressed path.default CanonicalMap
removeAll(java.lang.String aPathQuery)
Removes all elements which's keys match the provided path query.default CanonicalMap
removeAll(java.util.Set<java.lang.String> aPaths)
Removes the paths contained in the provided collection.default CanonicalMap
removeDirAt(int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
removeDirAt(java.lang.Object[] aPathElements, int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
removeDirAt(java.lang.Object aPath, int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
removeDirAt(java.lang.String[] aPathElements, int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
removeDirAt(java.lang.String aPath, int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
removeFrom(java.lang.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 CanonicalMap
removeFrom(java.lang.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 CanonicalMap
removeFrom(java.lang.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 CanonicalMap
removeFrom(java.lang.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 CanonicalMap
removeFrom(java.util.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 java.util.Map<java.lang.String,java.lang.String>
toDump(java.util.Map<java.lang.String,java.lang.String> aDump)
default java.lang.String
toSourceCode()
Beta, don't know whether to keep this or not: Creates a class (aString
text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.default java.lang.String
toSourceCode(java.lang.String aClassName, java.lang.String aPackage)
Beta, don't know whether to keep this or not: Creates a class (aString
text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.-
Methods inherited from interface org.refcodes.structure.CanonicalMap
getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDirAt, getDirAt, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo, retrieveTo, toInstance, toInstance, toMap, toProperties, toType, toType
-
Methods inherited from interface org.refcodes.structure.Containable
isEmpty, size
-
Methods inherited from interface org.refcodes.structure.Keys
containsKey, get, getOr, keySet, use, values
-
Methods inherited from interface org.refcodes.structure.Keys.MutableValues
put
-
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
Methods inherited from interface org.refcodes.structure.PathMap
children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getDirAt, getDirAt, getDirAt, getDirAt, 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, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, 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, toDataStructure, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements, toPathList, toPropertyPath
-
Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap
appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, 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, put, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, remove, remove, removeValueAt, removeValueAt, removeValueAt, removeValueAt, removeValueAt
-
Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin
asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr
-
Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort
-
-
-
-
Method Detail
-
containsValue
default boolean containsValue(java.lang.Object value)
This method is defined for the sake ofMap
conformity. Tests whether the provided value has a key assigned.- Specified by:
containsValue
in interfaceCanonicalMap
- Specified by:
containsValue
in interfaceKeys<java.lang.String,T>
- Specified by:
containsValue
in interfacejava.util.Map<java.lang.String,T>
- Parameters:
value
- The value to test if a key references this value.- Returns:
- True in case the given value is referenced by a key.
-
delete
default java.lang.String delete(java.lang.String aKey)
Removes an element identified by the given key.- Specified by:
delete
in interfaceKeys.MutableKeys<java.lang.String,T>
- Specified by:
delete
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aKey
- The key which's element is to be removed.- Returns:
- The value being removed.
-
insert
default void insert(CanonicalMap aFrom)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insert(Object)
.- Parameters:
aFrom
- TheCanonicalMap
which is to be inspected with the therein contained values being added with their according determined paths.
-
insertBetween
default void insertBetween(java.lang.String aToPath, CanonicalMap aFrom, java.lang.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
- TheCanonicalMap
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(CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertFrom(Object, String)
.- Parameters:
aFrom
- TheCanonicalMap
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(java.lang.String aToPath, CanonicalMap 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
- TheCanonicalMap
which is to be inspected with the therein contained values being added with their according determined paths.
-
put
default java.lang.String put(java.lang.Object[] aPathElements, java.lang.String aValue)
Sets the value for the property referred to by the path elements representing the addressed path.- Specified by:
put
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
put
default java.lang.String put(Relation<java.lang.String,java.lang.String> aRelation)
Adds the given element related to the given key.- Specified by:
put
in interfaceDictionary.MutableDictionary<java.lang.String,T>
- Specified by:
put
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aRelation
- the relation- Returns:
- The value being replaced by the provided value or null if none value has been replaced.
-
put
default java.lang.String put(java.lang.String[] aPathElements, java.lang.String aValue)
Sets the value for the property referred to by the path elements representing the addressed path.- Specified by:
put
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putAll
default void putAll(CanonicalMap aProperties)
This method inserts all elements (key/value-pairs) found in the providedCanonicalMap
instances of interoperability reasons.- Parameters:
aProperties
- ACanonicalMap
containing the key/value pairs to be inserted.
-
putAll
default void putAll(java.util.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(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)
- Specified by:
putAll
in interfacejava.util.Map<java.lang.String,T>
-
putBoolean
default java.lang.String putBoolean(java.lang.Object[] aPathElements, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theBoolean
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueBoolean
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putBoolean
default java.lang.String putBoolean(java.lang.String[] aPathElements, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theBoolean
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheBoolean
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putByte
default java.lang.String putByte(java.lang.Object[] aPathElements, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theByte
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueByte
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putByte
default java.lang.String putByte(java.lang.String[] aPathElements, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theByte
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheByte
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putDirAt
default CanonicalMap putDirAt(java.util.Collection<?> aPathElements, int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.util.Collection<?> aPathElements, int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.Object aPath, int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.Object aPath, int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.Object[] aPathElements, int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.Object[] aPathElements, int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.String aPath, int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.String aPath, int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.String[] aPathElements, int aIndex, java.lang.Object aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDirAt
default CanonicalMap putDirAt(java.lang.String[] aPathElements, int aIndex, PathMap<java.lang.String> aDir) throws java.lang.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<java.lang.String>
- 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:
java.lang.IllegalArgumentException
- in case the path does not represent indexed elements as ofPathMap.isDirIndex(String)
.
-
putDouble
default java.lang.String putDouble(java.lang.Object[] aPathElements, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theDouble
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueDouble
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putDouble
default java.lang.String putDouble(java.lang.String[] aPathElements, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theDouble
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheDouble
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putFloat
default java.lang.String putFloat(java.lang.Object[] aPathElements, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theFloat
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueFloat
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putFloat
default java.lang.String putFloat(java.lang.String[] aPathElements, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theFloat
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheFloat
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putInteger
default java.lang.String putInteger(java.lang.Object[] aPathElements, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theInteger
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueInteger
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putInteger
default java.lang.String putInteger(java.lang.String[] aPathElements, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theInteger
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheInteger
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putLong
default java.lang.String putLong(java.lang.Object[] aPathElements, java.lang.Long aValue)
Sets theLong
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theLong
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueLong
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putLong
default java.lang.String putLong(java.lang.String[] aPathElements, java.lang.Long aValue)
Sets theLong
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theLong
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheLong
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putShort
default java.lang.String putShort(java.lang.Object[] aPathElements, java.lang.Short aValue)
Sets theShort
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theShort
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- The valueShort
to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
putShort
default java.lang.String putShort(java.lang.String[] aPathElements, java.lang.Short aValue)
Sets theShort
value for the property referred to by the path elements representing the addressed path. As property keys and values are of typeString
, theShort
value is converted accordingly.- Parameters:
aPathElements
- The path elements of the path addressing the value.aValue
- TheShort
value to be associated with the path.- Returns:
- the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)
-
removeAll
default CanonicalMap removeAll(java.util.Set<java.lang.String> aPaths)
Removes the paths contained in the provided collection.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aPaths
- The paths to be removed.- Returns:
- The removed properties.
-
removeAll
default CanonicalMap removeAll(java.lang.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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.- Specified by:
removeAll
in interfacePathMap.MutablePathMap<java.lang.String>
- Parameters:
aPathQuery
- The path query including your wildcards.- Returns:
- The removed properties.
-
removeDirAt
default CanonicalMap 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<java.lang.String>
- Parameters:
aIndex
- The index which to use.- Returns:
- The indexed elements without the indexed path "prefixes".
-
removeDirAt
default CanonicalMap removeDirAt(java.lang.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<java.lang.String>
- 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 CanonicalMap removeDirAt(java.lang.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<java.lang.String>
- 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 CanonicalMap removeDirAt(java.lang.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<java.lang.String>
- 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 CanonicalMap removeDirAt(java.lang.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<java.lang.String>
- 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 CanonicalMap removeFrom(java.util.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<java.lang.String>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default CanonicalMap removeFrom(java.lang.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<java.lang.String>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default CanonicalMap removeFrom(java.lang.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<java.lang.String>
- Parameters:
aPath
- The path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default CanonicalMap removeFrom(java.lang.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<java.lang.String>
- Parameters:
aPath
- The path from where to remove all properties.- Returns:
- The removed properties.
-
removeFrom
default CanonicalMap removeFrom(java.lang.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<java.lang.String>
- Parameters:
aPathElements
- The path elements for the path from where to remove all properties.- Returns:
- The removed properties.
-
toDump
default java.util.Map<java.lang.String,java.lang.String> toDump(java.util.Map<java.lang.String,java.lang.String> aDump)
- Specified by:
toDump
in interfaceorg.refcodes.mixin.Dumpable
-
toSourceCode
default java.lang.String toSourceCode()
Beta, don't know whether to keep this or not: Creates a class (aString
text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.- Returns:
- The text representing the source code to be copy'n'pasted.
-
toSourceCode
default java.lang.String toSourceCode(java.lang.String aClassName, java.lang.String aPackage)
Beta, don't know whether to keep this or not: Creates a class (aString
text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.- Parameters:
aClassName
- The class name for the class to be generated.aPackage
- The package to which the class is to belong.- Returns:
- The text representing the source code to be copy'n'pasted.
-
-