Module org.refcodes.struct
Package org.refcodes.struct

Interface SimpleTypeMap

    • Method Detail

      • containsValue

        default boolean containsValue​(Object value)
        This method is defined for the sake of Map conformity. Tests whether the provided value has a key assigned.
        Specified by:
        containsValue in interface Keys<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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aPathElements - The elements of the path from which to get the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • 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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aPath - The path from which to get the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • 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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aPathElements - The elements of the path from which to get the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • 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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aPathElements - The elements of the path from which to get the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • 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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • 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".
        Specified by:
        getDirAt in interface PathMap<Object>
        Parameters:
        aPath - The path from which to get the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • query

        default SimpleTypeMap query​(Collection<?> aQueryElements)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        query in interface PathMap<Object>
        Parameters:
        aQueryElements - The elements representing the path query including your wildcards.
        Returns:
        The result contains the matching paths with the according values.

      • query

        default SimpleTypeMap query​(Object... aQueryElements)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        query in interface PathMap<Object>
        Parameters:
        aQueryElements - The elements representing the path query including your wildcards.
        Returns:
        The result contains the matching paths with the according values.

      • query

        default SimpleTypeMap query​(Pattern aRegExp)
        Queries the keys of the instance using a regular expression as of the provided Pattern instance.
        Specified by:
        query in interface PathMap<Object>
        Parameters:
        aRegExp - The regular expression to be used for the query.
        Returns:
        The matching properties.

      • query

        default SimpleTypeMap query​(String aPathQuery)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        query in interface PathMap<Object>
        Parameters:
        aPathQuery - The path query including your wildcards.
        Returns:
        The result contains the matching paths with the according values.

      • query

        default SimpleTypeMap query​(String... aQueryElements)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        query in interface PathMap<Object>
        Parameters:
        aQueryElements - The elements representing the path query including your wildcards.
        Returns:
        The result contains the matching paths with the according values.

      • queryBetween

        default SimpleTypeMap queryBetween​(Collection<?> aFromPath,
                                   Collection<?> aPathQuery,
                                   Collection<?> aToPath)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryBetween in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryBetween in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryBetween in interface PathMap<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 provided Pattern.
        Specified by:
        queryBetween in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryBetween in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryBetween in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryFrom in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryFrom in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryFrom in interface PathMap<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 provided Pattern.
        Specified by:
        queryFrom in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryFrom in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryFrom in interface PathMap<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 the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • queryTo

        default SimpleTypeMap queryTo​(Object aPathQuery,
                              String aToPath)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • queryTo

        default SimpleTypeMap queryTo​(Object[] aPathQuery,
                              String aToPath)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • queryTo

        default SimpleTypeMap queryTo​(Pattern aRegExp,
                              String aToPath)
        Queries the keys of the instance using a regular expression as of the provided Pattern.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • queryTo

        default SimpleTypeMap queryTo​(String aPathQuery,
                              String aToPath)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • queryTo

        default SimpleTypeMap queryTo​(String[] aPathQuery,
                              String aToPath)
        Queries the keys of the instance using the PathMatcher' matching patterns, similar to the wildcards '*', '?' and '**' known when querying folders of a filesystem: The PathMatcher applies the following rules from the ANT path pattern to the query provided: A single asterisk ("*" as of Wildcard.FILE) matches zero or more characters within a path name. A double asterisk ("**" as of Wildcard.PATH) matches zero or more characters across directory levels. A question mark ("?" as of Wildcard.CHAR) matches exactly one character within a path name. The single asterisk ("*" as of Wildcard.FILE), the double asterisk ("**" as of Wildcard.PATH) and the question mark ("?" as of Wildcard.CHAR) we refer to as wildcards.
        Specified by:
        queryTo in interface PathMap<Object>
        Parameters:
        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 to-path) with the according values.

      • retrieveBetween

        default SimpleTypeMap retrieveBetween​(Collection<?> aFromPath,
                                      Collection<?> aToPath)
        Extracts a new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be relocated to the provided "to-path".
        Specified by:
        retrieveBetween in interface PathMap<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 new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be relocated to the provided "to-path".
        Specified by:
        retrieveBetween in interface PathMap<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 new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be relocated to the provided "to-path".
        Specified by:
        retrieveBetween in interface PathMap<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 new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be relocated to the provided "to-path".
        Specified by:
        retrieveBetween in interface PathMap<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 new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be relocated to the provided "to-path".
        Specified by:
        retrieveBetween in interface PathMap<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 interface PathMap<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 interface PathMap<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 interface PathMap<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 new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be the root paths for the new PathMap. Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveFrom(String) with "/dog", then the resulting PathMap will contain the path "/cat" for that value.
        Specified by:
        retrieveFrom in interface PathMap<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 new PathMap.

      • 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 interface PathMap<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.
        Specified by:
        getDir in interface PathMap<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​(Object aPath)
        Gets the children elements of the provided parent's path, excluding the parent's path.
        Specified by:
        getDir in interface PathMap<Object>
        Parameters:
        aPath - The path from where to retrieve the children.
        Returns:
        The children of the given 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.
        Specified by:
        getDir in interface PathMap<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​(String aPath)
        Gets the children elements of the provided parent's path elements, excluding the parent's path.
        Specified by:
        getDir in interface PathMap<Object>
        Parameters:
        aPath - The path from where to retrieve the children.
        Returns:
        The children of the given 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.
        Specified by:
        getDir in interface PathMap<Object>
        Parameters:
        aPathElements - The path elements from where to retrieve the children.
        Returns:
        The children of the given 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 pointes to a directory index (as of PathMap.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 interface PathMap<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: 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 SimpleTypeMap[] 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 of PathMap.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 interface PathMap<Object>
        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 SimpleTypeMap[] 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 of PathMap.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 interface PathMap<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: 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 SimpleTypeMap[] 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 of PathMap.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 interface PathMap<Object>
        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 SimpleTypeMap[] 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 of PathMap.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 interface PathMap<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: 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

      • retrieveTo

        default SimpleTypeMap retrieveTo​(Collection<?> aToPathElements)
        Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.
        Specified by:
        retrieveTo in interface PathMap<Object>
        Parameters:
        aToPathElements - The path elements representing the path where to relocate the paths of this PathMap to.
        Returns:
        The PathMap with the elements from the provided PathMap with accordingly relocated paths.

      • retrieveTo

        default SimpleTypeMap retrieveTo​(Object aToPath)
        Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.
        Specified by:
        retrieveTo in interface PathMap<Object>
        Parameters:
        aToPath - The path where to relocate the paths of this PathMap to.
        Returns:
        The PathMap with the elements from the provided PathMap with accordingly relocated paths.

      • retrieveTo

        default SimpleTypeMap retrieveTo​(Object... aToPathElements)
        Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.
        Specified by:
        retrieveTo in interface PathMap<Object>
        Parameters:
        aToPathElements - The path elements representing the path where to relocate the paths of this PathMap to.
        Returns:
        The PathMap with the elements from the provided PathMap with accordingly relocated paths.

      • retrieveTo

        SimpleTypeMap retrieveTo​(String aToPath)
        Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.
        Specified by:
        retrieveTo in interface PathMap<Object>
        Parameters:
        aToPath - The path where to relocate the paths of this PathMap to.
        Returns:
        The PathMap with the elements from the provided PathMap with accordingly relocated paths.

      • retrieveTo

        default SimpleTypeMap retrieveTo​(String... aToPathElements)
        Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.
        Specified by:
        retrieveTo in interface PathMap<Object>
        Parameters:
        aToPathElements - The path elements representing the path where to relocate the paths of this PathMap to.
        Returns:
        The PathMap with the elements from the provided PathMap with accordingly relocated paths.

      • toMap

        default Map<String,​Object> toMap()
        This method creates a Map instance from this SimpleTypeMap instance's elements (key/value-pairs) as of interoperability reasons.
        Specified by:
        toMap in interface PathMap<Object>
        Returns:
        A Map object from the herein contained key/value-pairs .