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

Interface SimpleTypeMap.MutableSimpleTypeMap

    • Method Detail

      • insert

        default void insert​(SimpleTypeMap aFrom)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(Object).
        Parameters:
        aFrom - The SimpleTypeMap which is to be inspected with the therein contained values being added with their according determined paths.

      • insertBetween

        default void insertBetween​(String aToPath,
                           SimpleTypeMap aFrom,
                           String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).
        Parameters:
        aToPath - The sub-path where to insert the object's introspected values to.
        aFrom - The SimpleTypeMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPath - The path from where to start adding elements of the provided object.

      • insertFrom

        default void insertFrom​(SimpleTypeMap aFrom,
                        String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertFrom(Object, String).
        Parameters:
        aFrom - The SimpleTypeMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPath - The path from where to start adding elements of the provided object.

      • insertTo

        default void insertTo​(String aToPath,
                      SimpleTypeMap aFrom)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertTo(String, Object).
        Parameters:
        aToPath - The sub-path where to insert the object's introspected values to.
        aFrom - The SimpleTypeMap which is to be inspected with the therein contained values being added with their according determined paths.

      • put

        default Object put​(Object[] aPathElements,
                   Object aValue)
        Puts the given value into the child's path, relative to the given parent's path.
        Specified by:
        put in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path relative to which to put the value.
        aValue - The value to be added.
        Returns:
        The replaced value in case a value has already been set for the resulting path, or null.

      • put

        default Object put​(String[] aPathElements,
                   Object aValue)
        Puts the given value into the child's path, relative to the given parent's path.
        Specified by:
        put in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path relative to which to put the value.
        aValue - The value to be added.
        Returns:
        The replaced value in case a value has already been set for the resulting path, or null.

      • putAll

        default void putAll​(Properties aProperties)
        This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
        Parameters:
        aProperties - A Properties containing the key/value-pairs to be inserted.

      • putAll

        default void putAll​(SimpleTypeMap aProperties)
        This method inserts all elements (key/value-pairs) found in the provided SimpleTypeMap instances of interoperability reasons.
        Parameters:
        aProperties - A SimpleTypeMap containing the key/value pairs to be inserted.

      • putDirAt

        default SimpleTypeMap putDirAt​(Collection<?> aPathElements,
                               int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(Collection<?> aPathElements,
                               int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(Object aPath,
                               int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(Object aPath,
                               int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(Object[] aPathElements,
                               int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(Object[] aPathElements,
                               int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(String aPath,
                               int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(String aPath,
                               int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(String[] aPathElements,
                               int aIndex,
                               Object aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • putDirAt

        default SimpleTypeMap putDirAt​(String[] aPathElements,
                               int aIndex,
                               PathMap<Object> aDir)
                        throws IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        putDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        The directory which has been replaced by the given directory.
        Throws:
        IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isIndexDir(String).

      • removeAll

        default SimpleTypeMap removeAll​(Collection<?> aPathQueryElements)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default SimpleTypeMap removeAll​(Object... aPathQueryElements)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default SimpleTypeMap removeAll​(Object aPathQuery)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathQuery - The path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default SimpleTypeMap removeAll​(Pattern aRegExp)
        Removes all elements which's keys match the provided regular expression: Queries the keys of the instance using the provided Pattern
        Specified by:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aRegExp - The regular expression to be used for the query.
        Returns:
        The removed properties.

      • removeAll

        default SimpleTypeMap removeAll​(String... aPathQueryElements)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default SimpleTypeMap removeAll​(String aPathQuery)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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:
        removeAll in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathQuery - The path query including your wildcards.
        Returns:
        The removed properties.

      • removeDirAt

        default SimpleTypeMap removeDirAt​(int aIndex)
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the root path. Given the following paths and index = 1: /0/0aaa /0/0bbb /0/0bbb /1/1aaa /1/1bbb /1/1bbb You will get a result containing all the elements which's keys begin with "/1/". The keys of the result will exclude the path "prefix" "/1".
        Specified by:
        removeDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • removeDirAt

        default SimpleTypeMap removeDirAt​(Object aPath,
                                  int aIndex)
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/". The keys of the result will exclude the path "prefix" "/root/child/1".
        Specified by:
        removeDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path from which to remove the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • removeDirAt

        default SimpleTypeMap removeDirAt​(Object[] aPathElements,
                                  int aIndex)
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".
        Specified by:
        removeDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The elements of the path from which to remove the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • removeDirAt

        default SimpleTypeMap removeDirAt​(String aPath,
                                  int aIndex)
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".
        Specified by:
        removeDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path from which to remove the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • removeDirAt

        default SimpleTypeMap removeDirAt​(String[] aPathElements,
                                  int aIndex)
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Removes the elements of the given index below the given path. Given the following paths and index = 1 with a queried path "/root/child": /root/child/0/0aaa /root/child/0/0bbb /root/child/0/0bbb /root/child/1/1aaa /root/child/1/1bbb /root/child/1/1bbb You will get a result containing all the elements which's keys begin with "/root/child/1/".The keys of the result will exclude the path "prefix" "/root/child/1".
        Specified by:
        removeDirAt in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The elements of the path from which to remove the indexed elements.
        aIndex - The index which to use.
        Returns:
        The indexed elements without the indexed path "prefixes".

      • removeFrom

        default SimpleTypeMap removeFrom​(Collection<?> aPathElements)
        Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
        Specified by:
        removeFrom in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements for the path from where to remove all properties.
        Returns:
        The removed properties.

      • removeFrom

        default SimpleTypeMap removeFrom​(Object... aPathElements)
        Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
        Specified by:
        removeFrom in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements for the path from where to remove all properties.
        Returns:
        The removed properties.

      • removeFrom

        default SimpleTypeMap removeFrom​(Object aPath)
        Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
        Specified by:
        removeFrom in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path from where to remove all properties.
        Returns:
        The removed properties.

      • removeFrom

        default SimpleTypeMap removeFrom​(String aPath)
        Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
        Specified by:
        removeFrom in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPath - The path from where to remove all properties.
        Returns:
        The removed properties.

      • removeFrom

        default SimpleTypeMap removeFrom​(String... aPathElements)
        Removes all properties below the provided path and returns the PathMap with the removed elements, by which the paths exclude the parent's path.
        Specified by:
        removeFrom in interface PathMap.MutablePathMap<Object>
        Parameters:
        aPathElements - The path elements for the path from where to remove all properties.
        Returns:
        The removed properties.