-
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,Containable
,org.refcodes.mixin.DelimiterAccessor
,Dictionary<String,String>
,org.refcodes.mixin.Dumpable
,org.refcodes.mixin.EmptyAccessor
,InterOperableMap<String>
,Keys<String,String>
,PathMap<String>
,org.refcodes.mixin.TypeAccessor<String>
- All Known Subinterfaces:
CanonicalMap.CanonicalMapBuilder
,CanonicalMap.MutableCanonicalMap
- All Known Implementing Classes:
CanonicalMapBuilderImpl
,CanonicalMapImpl
public interface CanonicalMap extends InterOperableMap<String>
TheCanonicalMap
is an "intermediate" type adding type and Data-Structure related functionality to any implementing class.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
CanonicalMap.CanonicalMapBuilder
The Interface CanonicalMapBuilder.static interface
CanonicalMap.MutableCanonicalMap
The Interface MutableCanonicalMap.-
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.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 org.refcodes.struct.PathMap
PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>
-
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 Abstract Methods Default Methods Modifier and Type Method Description default String[]
asArray(Object aKey)
Same asasArray(String, char)
using a comma (',') as delimiter.default String[]
asArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as an array with its elements being the elements of the value separated by the given delimiter char.default String[]
asArray(String aKey)
Same asasArray(String, char)
using a comma (',') as delimiter.default String[]
asArray(String aKey, char aDelimiter)
Treats the value associated with the given key as an array with its elements being the elements of the value separated by the given delimiter char.default boolean[]
asBooleanArray(Object aKey)
Same asasBooleanArray(String, char)
using a comma (',') as delimiter.default boolean[]
asBooleanArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a boolean array with its elements being the elements of the value separated by the given delimiter char.default boolean[]
asBooleanArray(String aKey)
Same asasBooleanArray(String, char)
using a comma (',') as delimiter.default boolean[]
asBooleanArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a boolean array with its elements being the elements of the value separated by the given delimiter char.default byte[]
asByteArray(Object aKey)
Same asasByteArray(String, char)
using a comma (',') as delimiter.default byte[]
asByteArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a byte array with its elements being the elements of the value separated by the given delimiter char.default byte[]
asByteArray(String aKey)
Same asasByteArray(String, char)
using a comma (',') as delimiter.default byte[]
asByteArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a byte array with its elements being the elements of the value separated by the given delimiter char.default char[]
asCharArray(Object aKey)
Same asasCharArray(String, char)
using a comma (',') as delimiter.default char[]
asCharArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a char array with its elements being the elements of the value separated by the given delimiter char.default char[]
asCharArray(String aKey)
Same asasCharArray(String, char)
using a comma (',') as delimiter.default char[]
asCharArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a char array with its elements being the elements of the value separated by the given delimiter char.default double[]
asDoubleArray(Object aKey)
Same asasDoubleArray(String, char)
using a comma (',') as delimiter.default double[]
asDoubleArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a double array with its elements being the elements of the value separated by the given delimiter double.default double[]
asDoubleArray(String aKey)
Same asasDoubleArray(String, char)
using a comma (',') as delimiter.default double[]
asDoubleArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a double array with its elements being the elements of the value separated by the given delimiter double.default float[]
asFloatArray(Object aKey)
Same asasFloatArray(String, char)
using a comma (',') as delimiter.default float[]
asFloatArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a float array with its elements being the elements of the value separated by the given delimiter float.default float[]
asFloatArray(String aKey)
Same asasFloatArray(String, char)
using a comma (',') as delimiter.default float[]
asFloatArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a float array with its elements being the elements of the value separated by the given delimiter float.default int[]
asIntArray(Object aKey)
Same asasIntArray(String, char)
using a comma (',') as delimiter.default int[]
asIntArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a integer array with its elements being the elements of the value separated by the given delimiter char.default int[]
asIntArray(String aKey)
Same asasIntArray(String, char)
using a comma (',') as delimiter.default int[]
asIntArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a integer array with its elements being the elements of the value separated by the given delimiter char.default long[]
asLongArray(Object aKey)
Same asasLongArray(String, char)
using a comma (',') as delimiter.default long[]
asLongArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a longeger array with its elements being the elements of the value separated by the given delimiter char.default long[]
asLongArray(String aKey)
Same asasLongArray(String, char)
using a comma (',') as delimiter.default long[]
asLongArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a longeger array with its elements being the elements of the value separated by the given delimiter char.default short[]
asShortArray(Object aKey)
Same asasShortArray(String, char)
using a comma (',') as delimiter.default short[]
asShortArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as a shorteger array with its elements being the elements of the value separated by the given delimiter char.default short[]
asShortArray(String aKey)
Same asasShortArray(String, char)
using a comma (',') as delimiter.default short[]
asShortArray(String aKey, char aDelimiter)
Treats the value associated with the given key as a shorteger array with its elements being the elements of the value separated by the given delimiter char.default boolean
containsValue(Object value)
This method is defined for the sake ofMap
conformity.default CanonicalMap
getDir(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default CanonicalMap
getDir(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
getDir(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
getDir(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
getDir(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
getDirAt(int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap
getDirAt(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
getDirAt(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
getDirAt(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
getDirAt(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
getDirAt(Collection<?> aPathElements, int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default CanonicalMap[]
getDirs(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default CanonicalMap[]
getDirs(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap[]
getDirs(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap[]
getDirs(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap[]
getDirs(Collection<?> aPathElements)
Gets the children elements of the provided parent's path, excluding the parent's path.default CanonicalMap
query(Object... aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
query(String aPathQuery)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
query(String... aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
query(Collection<?> aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
query(Pattern aRegExp)
Queries the keys of the instance using a regular expression as of the providedPattern
instance.default CanonicalMap
queryBetween(Object[] aFromPath, Object[] aPathQuery, Object[] aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryBetween(Object aFromPath, Object aPathQuery, Object aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryBetween(String[] aFromPath, String[] aPathQuery, String[] aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryBetween(String aFromPath, String aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryBetween(String aFromPath, Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default CanonicalMap
queryBetween(Collection<?> aFromPath, Collection<?> aPathQuery, Collection<?> aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(Object[] aPathQuery, Object[] aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(Object aPathQuery, Object aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(String[] aPathQuery, String[] aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(String aPathQuery, String aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(Collection<?> aPathQuery, Collection<?> aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryFrom(Pattern aRegExp, String aFromPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default CanonicalMap
queryTo(Object[] aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryTo(Object aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryTo(String[] aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryTo(String aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryTo(Collection<?> aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default CanonicalMap
queryTo(Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default CanonicalMap
retrieveBetween(Object[] aFromPath, Object[] aToPath)
default CanonicalMap
retrieveBetween(Object aFromPath, Object aToPath)
default CanonicalMap
retrieveBetween(String[] aFromPath, String[] aToPath)
default CanonicalMap
retrieveBetween(String aFromPath, String aToPath)
default CanonicalMap
retrieveBetween(Collection<?> aFromPath, Collection<?> aToPath)
default CanonicalMap
retrieveFrom(Object aParentPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default CanonicalMap
retrieveFrom(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.CanonicalMap
retrieveFrom(String aFromPath)
default CanonicalMap
retrieveFrom(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
retrieveFrom(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default CanonicalMap
retrieveTo(Object aToPath)
default CanonicalMap
retrieveTo(Object... aToPathElements)
CanonicalMap
retrieveTo(String aToPath)
default CanonicalMap
retrieveTo(String... aToPathElements)
default CanonicalMap
retrieveTo(Collection<?> aToPathElements)
default Map<String,String>
toMap()
This method creates aMap
instance from thisCanonicalMap
instance's elements (key/value-pairs) as of interoperability reasons.default Properties
toProperties()
This method creates aProperties
instance from thisProperties
instance's elements (key/value-pairs) as of interoperability reasons.-
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.Keys
containsKey, get, getOr, keySet, use, 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, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, 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
-
-
-
-
Method Detail
-
asArray
default String[] asArray(Object aKey)
Same asasArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
-
asArray
default String[] asArray(Object aKey, char aDelimiter)
Treats the value associated with the given key as an array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "1, 2, 3, 4, 5", then the corresponding array, when using the comma (',') char as delimiter, will be { "1", "2", "3", "4", "5" }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
-
asArray
default String[] asArray(String aKey)
Same asasArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
-
asArray
default String[] asArray(String aKey, char aDelimiter)
Treats the value associated with the given key as an array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "1, 2, 3, 4, 5", then the corresponding array, when using the comma (',') char as delimiter, will be { "1", "2", "3", "4", "5" }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
-
asBooleanArray
default boolean[] asBooleanArray(Object aKey) throws NumberFormatException
Same asasBooleanArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asBooleanArray
default boolean[] asBooleanArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a boolean array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asBooleanArray
default boolean[] asBooleanArray(String aKey) throws NumberFormatException
Same asasBooleanArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asBooleanArray
default boolean[] asBooleanArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a boolean array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asByteArray
default byte[] asByteArray(Object aKey) throws NumberFormatException
Same asasByteArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asByteArray
default byte[] asByteArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a byte array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asByteArray
default byte[] asByteArray(String aKey) throws NumberFormatException
Same asasByteArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asByteArray
default byte[] asByteArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a byte array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asCharArray
default char[] asCharArray(Object aKey) throws NumberFormatException
Same asasCharArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asCharArray
default char[] asCharArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a char array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asCharArray
default char[] asCharArray(String aKey) throws NumberFormatException
Same asasCharArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asCharArray
default char[] asCharArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a char array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asDoubleArray
default double[] asDoubleArray(Object aKey) throws NumberFormatException
Same asasDoubleArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asDoubleArray
default double[] asDoubleArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a double array with its elements being the elements of the value separated by the given delimiter double. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') double as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asDoubleArray
default double[] asDoubleArray(String aKey) throws NumberFormatException
Same asasDoubleArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asDoubleArray
default double[] asDoubleArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a double array with its elements being the elements of the value separated by the given delimiter double. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') double as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asFloatArray
default float[] asFloatArray(Object aKey) throws NumberFormatException
Same asasFloatArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asFloatArray
default float[] asFloatArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a float array with its elements being the elements of the value separated by the given delimiter float. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') float as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asFloatArray
default float[] asFloatArray(String aKey) throws NumberFormatException
Same asasFloatArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asFloatArray
default float[] asFloatArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a float array with its elements being the elements of the value separated by the given delimiter float. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') float as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asIntArray
default int[] asIntArray(Object aKey) throws NumberFormatException
Same asasIntArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asIntArray
default int[] asIntArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a integer array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asIntArray
default int[] asIntArray(String aKey) throws NumberFormatException
Same asasIntArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asIntArray
default int[] asIntArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a integer array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asLongArray
default long[] asLongArray(Object aKey) throws NumberFormatException
Same asasLongArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asLongArray
default long[] asLongArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a longeger array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asLongArray
default long[] asLongArray(String aKey) throws NumberFormatException
Same asasLongArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asLongArray
default long[] asLongArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a longeger array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asShortArray
default short[] asShortArray(Object aKey) throws NumberFormatException
Same asasShortArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asShortArray
default short[] asShortArray(Object aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a shorteger array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
asShortArray
default short[] asShortArray(String aKey) throws NumberFormatException
Same asasShortArray(String, char)
using a comma (',') as delimiter.- Parameters:
aKey
- The key, which's value is to be converted to an array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
-
asShortArray
default short[] asShortArray(String aKey, char aDelimiter) throws NumberFormatException
Treats the value associated with the given key as a shorteger array with its elements being the elements of the value separated by the given delimiter char. Let the value associated to the given key be "true, false, true, false, true", then the corresponding array, when using the comma (',') char as delimiter, will be { true, false, true, false, true }.- Parameters:
aKey
- The key, which's value is to be converted to an array.aDelimiter
- The delimiter to be used to identify the elements of the future array.- Returns:
- The according array or null if no (or a null) value has been associated to the key.
- Throws:
NumberFormatException
- thrown in case conversion fails.
-
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 interfaceKeys<String,String>
- Parameters:
value
- The value to test if a key references this value.- Returns:
- True in case the given value is referenced by a key.
-
getDirAt
default CanonicalMap getDirAt(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. Returns the elements of the given index below the path of the path "array" 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".
-
getDirAt
default CanonicalMap getDirAt(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. Returns the elements of the given index below the path of the root "array" 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".
-
getDirAt
default CanonicalMap getDirAt(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. Returns the elements of the given index below the path of the path "array" 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".
-
getDirAt
default CanonicalMap getDirAt(Collection<?> 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. Returns the elements of the given index below the path of the path "array" 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".
-
getDirAt
default CanonicalMap getDirAt(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. Returns the elements of the given index below the path of the path "array" 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".
-
getDirAt
default CanonicalMap getDirAt(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. Returns the elements of the given index below the path of the path "array" 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".
-
query
default CanonicalMap query(Collection<?> aQueryElements)
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.
-
query
default CanonicalMap query(Object... aQueryElements)
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.
-
query
default CanonicalMap query(Pattern aRegExp)
Queries the keys of the instance using a regular expression as of the providedPattern
instance.
-
query
default CanonicalMap query(String aPathQuery)
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.
-
query
default CanonicalMap query(String... aQueryElements)
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.
-
queryBetween
default CanonicalMap queryBetween(Collection<?> aFromPath, Collection<?> aPathQuery, Collection<?> aToPath)
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:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aPathQuery
- The path query including your wildcards.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryBetween
default CanonicalMap queryBetween(Object aFromPath, Object aPathQuery, Object aToPath)
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:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aPathQuery
- The path query including your wildcards.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryBetween
default CanonicalMap queryBetween(Object[] aFromPath, Object[] aPathQuery, Object[] aToPath)
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:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aPathQuery
- The path query including your wildcards.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryBetween
default CanonicalMap queryBetween(String aFromPath, Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.- Specified by:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aRegExp
- The regular expression to be used for the query.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryBetween
default CanonicalMap queryBetween(String aFromPath, String aPathQuery, String aToPath)
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:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aPathQuery
- The path query including your wildcards.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryBetween
default CanonicalMap queryBetween(String[] aFromPath, String[] aPathQuery, String[] aToPath)
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:
queryBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start querying and extracting the paths.aPathQuery
- The path query including your wildcards.aToPath
- The path where to relocate the result to.- Returns:
- The result contains the matching paths (with respect to the from-path and the to-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(Collection<?> aPathQuery, Collection<?> aFromPath)
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:
queryFrom
in interfacePathMap<String>
- Parameters:
aPathQuery
- The path query including your wildcards.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(Object aPathQuery, Object aFromPath)
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:
queryFrom
in interfacePathMap<String>
- Parameters:
aPathQuery
- The path query including your wildcards.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(Object[] aPathQuery, Object[] aFromPath)
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:
queryFrom
in interfacePathMap<String>
- Parameters:
aPathQuery
- The path query including your wildcards.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(Pattern aRegExp, String aFromPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.- Specified by:
queryFrom
in interfacePathMap<String>
- Parameters:
aRegExp
- The regular expression to be used for the query.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(String aPathQuery, String aFromPath)
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:
queryFrom
in interfacePathMap<String>
- Parameters:
aPathQuery
- The path query including your wildcards.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryFrom
default CanonicalMap queryFrom(String[] aPathQuery, String[] aFromPath)
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:
queryFrom
in interfacePathMap<String>
- Parameters:
aPathQuery
- The path query including your wildcards.aFromPath
- The path from where to start querying and extracting the paths.- Returns:
- The result contains the matching paths (with respect to the from-path) with the according values.
-
queryTo
default CanonicalMap queryTo(Collection<?> aPathQuery, String aToPath)
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.
-
queryTo
default CanonicalMap queryTo(Object aPathQuery, String aToPath)
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.
-
queryTo
default CanonicalMap queryTo(Object[] aPathQuery, String aToPath)
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.
-
queryTo
default CanonicalMap queryTo(Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.
-
queryTo
default CanonicalMap queryTo(String aPathQuery, String aToPath)
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.
-
queryTo
default CanonicalMap queryTo(String[] aPathQuery, String aToPath)
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.
-
retrieveBetween
default CanonicalMap retrieveBetween(Collection<?> aFromPath, Collection<?> aToPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be relocated to the provided "to-path".- Specified by:
retrieveBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.aToPath
- The path where to relocate the extracted paths to.- Returns:
- The
PathMap
with the elements below the provided path "from-path" relocated to the given "to-path".
-
retrieveBetween
default CanonicalMap retrieveBetween(Object aFromPath, Object aToPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be relocated to the provided "to-path".- Specified by:
retrieveBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.aToPath
- The path where to relocate the extracted paths to.- Returns:
- The
PathMap
with the elements below the provided path "from-path" relocated to the given "to-path".
-
retrieveBetween
default CanonicalMap retrieveBetween(Object[] aFromPath, Object[] aToPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be relocated to the provided "to-path".- Specified by:
retrieveBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.aToPath
- The path where to relocate the extracted paths to.- Returns:
- The
PathMap
with the elements below the provided path "from-path" relocated to the given "to-path".
-
retrieveBetween
default CanonicalMap retrieveBetween(String aFromPath, String aToPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be relocated to the provided "to-path".- Specified by:
retrieveBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.aToPath
- The path where to relocate the extracted paths to.- Returns:
- The
PathMap
with the elements below the provided path "from-path" relocated to the given "to-path".
-
retrieveBetween
default CanonicalMap retrieveBetween(String[] aFromPath, String[] aToPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be relocated to the provided "to-path".- Specified by:
retrieveBetween
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.aToPath
- The path where to relocate the extracted paths to.- Returns:
- The
PathMap
with the elements below the provided path "from-path" relocated to the given "to-path".
-
retrieveFrom
default CanonicalMap retrieveFrom(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
default CanonicalMap retrieveFrom(Object aParentPath)
Gets the children elements of the provided parent's path, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<String>
- Parameters:
aParentPath
- The path from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
default CanonicalMap retrieveFrom(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
CanonicalMap retrieveFrom(String aFromPath)
Extracts a newPathMap
from the elements of thisPathMap
found below the "from-path". The sub-paths will be the root paths for the newPathMap
. Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveFrom(String)
with "/dog", then the resultingPathMap
will contain the path "/cat" for that value.- Specified by:
retrieveFrom
in interfacePathMap<String>
- Parameters:
aFromPath
- The path from where to start extracting the paths.- Returns:
- The
PathMap
with the elements below the provided path which are root elements in the newPathMap
.
-
retrieveFrom
default CanonicalMap retrieveFrom(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveTo
default CanonicalMap retrieveTo(Collection<?> aToPathElements)
Extracts a newPathMap
from thisPathMap
's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveTo(String)
with "/animals", then the resultingPathMap
will contain the path "/animals/dog/cat" for that value.
-
retrieveTo
default CanonicalMap retrieveTo(Object aToPath)
Extracts a newPathMap
from thisPathMap
's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveTo(String)
with "/animals", then the resultingPathMap
will contain the path "/animals/dog/cat" for that value.
-
retrieveTo
default CanonicalMap retrieveTo(Object... aToPathElements)
Extracts a newPathMap
from thisPathMap
's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveTo(String)
with "/animals", then the resultingPathMap
will contain the path "/animals/dog/cat" for that value.
-
retrieveTo
CanonicalMap retrieveTo(String aToPath)
Extracts a newPathMap
from thisPathMap
's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveTo(String)
with "/animals", then the resultingPathMap
will contain the path "/animals/dog/cat" for that value.
-
retrieveTo
default CanonicalMap retrieveTo(String... aToPathElements)
Extracts a newPathMap
from thisPathMap
's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in thePathMap
and we callPathMap.retrieveTo(String)
with "/animals", then the resultingPathMap
will contain the path "/animals/dog/cat" for that value.
-
getDir
default CanonicalMap getDir(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default CanonicalMap getDir(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.
-
getDir
default CanonicalMap getDir(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default CanonicalMap getDir(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default CanonicalMap getDir(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDirs
default CanonicalMap[] getDirs(Collection<?> aPathElements)
Gets the children elements of the provided parent's path, excluding the parent's path. If the parent pointes to a directory index (as ofPathMap.isIndexDir()
and the like methods), then the indexed directories are returned with their directory index corresponding to the returned array's index. parent's path.- Specified by:
getDirs
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: Ff the path points to an indexed directory (as of
PathMap.isIndexDir()
or the like), then each indexed directory is represented by an element of the array at the according index. If the path does not point to an indexed directory, then the directory itself is returned as the only element in the returned array.
-
getDirs
default CanonicalMap[] getDirs(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path. If the parent pointes to a directory index (as ofPathMap.isIndexDir()
and the like methods), then the indexed directories are returned with their directory index corresponding to the returned array's index. parent's path.- Specified by:
getDirs
in interfacePathMap<String>
- Parameters:
aPath
- The path from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: Ff the path points to an indexed directory (as of
PathMap.isIndexDir()
or the like), then each indexed directory is represented by an element of the array at the according index. If the path does not point to an indexed directory, then the directory itself is returned as the only element in the returned array.
-
getDirs
default CanonicalMap[] getDirs(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent pointes to a directory index (as ofPathMap.isIndexDir()
and the like methods), then the indexed directories are returned with their directory index corresponding to the returned array's index. parent's path.- Specified by:
getDirs
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: Ff the path points to an indexed directory (as of
PathMap.isIndexDir()
or the like), then each indexed directory is represented by an element of the array at the according index. If the path does not point to an indexed directory, then the directory itself is returned as the only element in the returned array.
-
getDirs
default CanonicalMap[] getDirs(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent pointes to a directory index (as ofPathMap.isIndexDir()
and the like methods), then the indexed directories are returned with their directory index corresponding to the returned array's index. parent's path.- Specified by:
getDirs
in interfacePathMap<String>
- Parameters:
aPath
- The path from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: Ff the path points to an indexed directory (as of
PathMap.isIndexDir()
or the like), then each indexed directory is represented by an element of the array at the according index. If the path does not point to an indexed directory, then the directory itself is returned as the only element in the returned array.
-
getDirs
default CanonicalMap[] getDirs(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent pointes to a directory index (as ofPathMap.isIndexDir()
and the like methods), then the indexed directories are returned with their directory index corresponding to the returned array's index. parent's path.- Specified by:
getDirs
in interfacePathMap<String>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: Ff the path points to an indexed directory (as of
PathMap.isIndexDir()
or the like), then each indexed directory is represented by an element of the array at the according index. If the path does not point to an indexed directory, then the array. directory itself is returned as the only element in the returned
-
toMap
default Map<String,String> toMap()
This method creates aMap
instance from thisCanonicalMap
instance's elements (key/value-pairs) as of interoperability reasons.
-
toProperties
default Properties toProperties()
This method creates aProperties
instance from thisProperties
instance's elements (key/value-pairs) as of interoperability reasons.- Returns:
- A
Properties
object from the herein contained key/value-pairs .
-
-