-
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,Containable
,org.refcodes.mixin.DelimiterAccessor
,Dictionary<String,Object>
,org.refcodes.mixin.Dumpable
,org.refcodes.mixin.EmptyAccessor
,InterOperableMap<Object>
,Keys<String,Object>
,PathMap<Object>
,org.refcodes.mixin.TypeAccessor<Object>
- All Known Subinterfaces:
SimpleTypeMap.MutableSimpleTypeMap
,SimpleTypeMap.SimpleTypeMapBuilder
- All Known Implementing Classes:
SimpleTypeMapBuilderImpl
,SimpleTypeMapImpl
public interface SimpleTypeMap extends InterOperableMap<Object>
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
SimpleTypeMap.MutableSimpleTypeMap
TheSimpleTypeMap.MutableSimpleTypeMap
adds functionality for manipulating the internal state to theSimpleTypeMap
.static interface
SimpleTypeMap.SimpleTypeMapBuilder
ASimpleTypeMap.SimpleTypeMapBuilder
sets builder functionality (as of the builder pattern) on top of theSimpleTypeMap.MutableSimpleTypeMap
.-
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 boolean
containsValue(Object value)
This method is defined for the sake ofMap
conformity.default SimpleTypeMap
getDir(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default SimpleTypeMap
getDir(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
getDir(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
getDir(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
getDir(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
getDirAt(int aIndex)
An indexed directory represents all elements which begin with a path which's last path element represents an index.default SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap
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 SimpleTypeMap[]
getDirs(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default SimpleTypeMap[]
getDirs(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap[]
getDirs(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap[]
getDirs(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap[]
getDirs(Collection<?> aPathElements)
Gets the children elements of the provided parent's path, excluding the parent's path.default SimpleTypeMap
query(Object... aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
query(String aPathQuery)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
query(String... aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
query(Collection<?> aQueryElements)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
query(Pattern aRegExp)
Queries the keys of the instance using a regular expression as of the providedPattern
instance.default SimpleTypeMap
queryBetween(Object[] aFromPath, Object[] aPathQuery, Object[] aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryBetween(Object aFromPath, Object aPathQuery, Object aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryBetween(String[] aFromPath, String[] aPathQuery, String[] aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryBetween(String aFromPath, String aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryBetween(String aFromPath, Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default SimpleTypeMap
queryBetween(Collection<?> aFromPath, Collection<?> aPathQuery, Collection<?> aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(Object[] aPathQuery, Object[] aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(Object aPathQuery, Object aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(String[] aPathQuery, String[] aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(String aPathQuery, String aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(Collection<?> aPathQuery, Collection<?> aFromPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryFrom(Pattern aRegExp, String aFromPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default SimpleTypeMap
queryTo(Object[] aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryTo(Object aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryTo(String[] aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryTo(String aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryTo(Collection<?> aPathQuery, String aToPath)
Queries the keys of the instance using thePathMatcher
' matching patterns, similar to the wildcards '*', '?'default SimpleTypeMap
queryTo(Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.default SimpleTypeMap
retrieveBetween(Object[] aFromPath, Object[] aToPath)
default SimpleTypeMap
retrieveBetween(Object aFromPath, Object aToPath)
default SimpleTypeMap
retrieveBetween(String[] aFromPath, String[] aToPath)
default SimpleTypeMap
retrieveBetween(String aFromPath, String aToPath)
default SimpleTypeMap
retrieveBetween(Collection<?> aFromPath, Collection<?> aToPath)
default SimpleTypeMap
retrieveFrom(Object aParentPath)
Gets the children elements of the provided parent's path, excluding the parent's path.default SimpleTypeMap
retrieveFrom(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.SimpleTypeMap
retrieveFrom(String aFromPath)
default SimpleTypeMap
retrieveFrom(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
retrieveFrom(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.default SimpleTypeMap
retrieveTo(Object aToPath)
default SimpleTypeMap
retrieveTo(Object... aToPathElements)
SimpleTypeMap
retrieveTo(String aToPath)
default SimpleTypeMap
retrieveTo(String... aToPathElements)
default SimpleTypeMap
retrieveTo(Collection<?> aToPathElements)
default Map<String,Object>
toMap()
This method creates aMap
instance from thisSimpleTypeMap
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
-
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,Object>
- 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 SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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".
-
getDirAt
default SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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".
-
query
default SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap query(Pattern aRegExp)
Queries the keys of the instance using a regular expression as of the providedPattern
instance.
-
query
default SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap queryFrom(Pattern aRegExp, String aFromPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.- Specified by:
queryFrom
in interfacePathMap<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap queryTo(Pattern aRegExp, String aToPath)
Queries the keys of the instance using a regular expression as of the providedPattern
.
-
queryTo
default SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap 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<Object>
- 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 SimpleTypeMap retrieveFrom(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
default SimpleTypeMap retrieveFrom(Object aParentPath)
Gets the children elements of the provided parent's path, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<Object>
- Parameters:
aParentPath
- The path from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
default SimpleTypeMap retrieveFrom(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
retrieveFrom
SimpleTypeMap 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<Object>
- 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 SimpleTypeMap retrieveFrom(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.- Specified by:
retrieveFrom
in interfacePathMap<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- The children of the given parent's path.
-
getDir
default SimpleTypeMap getDir(Collection<?> aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default SimpleTypeMap getDir(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path.
-
getDir
default SimpleTypeMap getDir(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default SimpleTypeMap getDir(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDir
default SimpleTypeMap getDir(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path.
-
getDirs
default SimpleTypeMap[] getDirs(Collection<?> aPathElements)
Gets the children elements of the provided parent's path, excluding the parent's path. If the parent points 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<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: If 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 SimpleTypeMap[] getDirs(Object aPath)
Gets the children elements of the provided parent's path, excluding the parent's path. If the parent points 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<Object>
- Parameters:
aPath
- The path from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: If 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 SimpleTypeMap[] getDirs(Object... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent points 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<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: If 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 SimpleTypeMap[] getDirs(String aPath)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent points 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<Object>
- Parameters:
aPath
- The path from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: If 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 SimpleTypeMap[] getDirs(String... aPathElements)
Gets the children elements of the provided parent's path elements, excluding the parent's path. If the parent points 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<Object>
- Parameters:
aPathElements
- The path elements from where to retrieve the children.- Returns:
- An array with the children directories of the given parent's
path: If 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
-
retrieveTo
default SimpleTypeMap 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 SimpleTypeMap 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 SimpleTypeMap 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
SimpleTypeMap 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 SimpleTypeMap 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.
-
-