Package org.refcodes.structure

Interface CanonicalMap.MutableCanonicalMap

    • Method Detail

      • containsValue

        default boolean containsValue​(java.lang.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 CanonicalMap
        Specified by:
        containsValue in interface Keys<java.lang.String,T>
        Specified by:
        containsValue in interface java.util.Map<java.lang.String,T>
        Parameters:
        value - The value to test if a key references this value.
        Returns:
        True in case the given value is referenced by a key.

      • delete

        default java.lang.String delete​(java.lang.String aKey)
        Removes an element identified by the given key.
        Specified by:
        delete in interface Keys.MutableKeys<java.lang.String,T>
        Specified by:
        delete in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aKey - The key which's element is to be removed.
        Returns:
        The value being removed.

      • insert

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

      • insertBetween

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

      • insertFrom

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

      • insertTo

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

      • put

        default java.lang.String put​(java.lang.Object[] aPathElements,
                             java.lang.String aValue)
        Sets the value for the property referred to by the path elements representing the addressed path.
        Specified by:
        put in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • put

        default java.lang.String put​(Relation<java.lang.String,java.lang.String> aRelation)
        Adds the given element related to the given key.
        Specified by:
        put in interface Dictionary.MutableDictionary<java.lang.String,T>
        Specified by:
        put in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aRelation - the relation
        Returns:
        The value being replaced by the provided value or null if none value has been replaced.

      • put

        default java.lang.String put​(java.lang.String[] aPathElements,
                             java.lang.String aValue)
        Sets the value for the property referred to by the path elements representing the addressed path.
        Specified by:
        put in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putAll

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

      • putAll

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

      • putAll

        default void putAll​(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)
        Specified by:
        putAll in interface java.util.Map<java.lang.String,T>

      • putBoolean

        default java.lang.String putBoolean​(java.lang.Object[] aPathElements,
                                    java.lang.Boolean aValue)
        Sets the Boolean value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Boolean value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Boolean to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putBoolean

        default java.lang.String putBoolean​(java.lang.String[] aPathElements,
                                    java.lang.Boolean aValue)
        Sets the Boolean value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Boolean value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Boolean value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putByte

        default java.lang.String putByte​(java.lang.Object[] aPathElements,
                                 java.lang.Byte aValue)
        Sets the Byte value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Byte value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Byte to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putByte

        default java.lang.String putByte​(java.lang.String[] aPathElements,
                                 java.lang.Byte aValue)
        Sets the Byte value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Byte value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Byte value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDirAt

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

      • putDouble

        default java.lang.String putDouble​(java.lang.Object[] aPathElements,
                                   java.lang.Double aValue)
        Sets the Double value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Double value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Double to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putDouble

        default java.lang.String putDouble​(java.lang.String[] aPathElements,
                                   java.lang.Double aValue)
        Sets the Double value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Double value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Double value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putFloat

        default java.lang.String putFloat​(java.lang.Object[] aPathElements,
                                  java.lang.Float aValue)
        Sets the Float value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Float value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Float to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putFloat

        default java.lang.String putFloat​(java.lang.String[] aPathElements,
                                  java.lang.Float aValue)
        Sets the Float value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Float value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Float value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putInteger

        default java.lang.String putInteger​(java.lang.Object[] aPathElements,
                                    java.lang.Integer aValue)
        Sets the Integer value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Integer value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Integer to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putInteger

        default java.lang.String putInteger​(java.lang.String[] aPathElements,
                                    java.lang.Integer aValue)
        Sets the Integer value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Integer value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Integer value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putLong

        default java.lang.String putLong​(java.lang.Object[] aPathElements,
                                 java.lang.Long aValue)
        Sets the Long value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Long value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Long to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putLong

        default java.lang.String putLong​(java.lang.String[] aPathElements,
                                 java.lang.Long aValue)
        Sets the Long value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Long value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Long value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putShort

        default java.lang.String putShort​(java.lang.Object[] aPathElements,
                                  java.lang.Short aValue)
        Sets the Short value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Short value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Short to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • putShort

        default java.lang.String putShort​(java.lang.String[] aPathElements,
                                  java.lang.Short aValue)
        Sets the Short value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Short value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Short value to be associated with the path.
        Returns:
        the previous value associated with path, or null if there was no mapping for the path. (A null return can also indicate that the map previously associated null with the path, if the implementation supports null values.)

      • removePaths

        default CanonicalMap removePaths​(java.util.Collection<?> aPaths)
        Removes the paths contained in the provided collection.
        Specified by:
        removePaths in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPaths - The paths to be removed.
        Returns:
        The removed properties.

      • removePaths

        default CanonicalMap removePaths​(java.lang.String... aPaths)
        Removes the paths contained in the provided collection.
        Specified by:
        removePaths in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPaths - The paths to be removed.
        Returns:
        The removed properties.

      • removeAll

        default CanonicalMap removeAll​(java.lang.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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.
        Specified by:
        removeAll in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default CanonicalMap removeAll​(java.lang.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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.
        Specified by:
        removeAll in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default CanonicalMap removeAll​(java.util.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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.
        Specified by:
        removeAll in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathQueryElements - The elements representing your path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default CanonicalMap removeAll​(java.lang.String aPathQuery)
        Removes all elements which's keys match the provided path query. Queries the keys of the instance using 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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.
        Specified by:
        removeAll in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathQuery - The path query including your wildcards.
        Returns:
        The removed properties.

      • removeAll

        default CanonicalMap removeAll​(java.lang.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 ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards.
        Specified by:
        removeAll in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aPathQuery - The path query including your wildcards.
        Returns:
        The removed properties.

      • removeDirAt

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

      • removeDirAt

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

      • removeDirAt

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

      • removeDirAt

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

      • removeDirAt

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

      • removeFrom

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

      • removeFrom

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

      • removeFrom

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

      • removeFrom

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

      • removeFrom

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

      • toDump

        default java.util.Map<java.lang.String,java.lang.String> toDump​(java.util.Map<java.lang.String,java.lang.String> aDump)
        Specified by:
        toDump in interface org.refcodes.mixin.Dumpable

      • toSourceCode

        default java.lang.String toSourceCode​()
        Beta, don't know whether to keep this or not: Creates a class (a String text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.
        Returns:
        The text representing the source code to be copy'n'pasted.

      • toSourceCode

        default java.lang.String toSourceCode​(java.lang.String aClassName,
                                      java.lang.String aPackage)
        Beta, don't know whether to keep this or not: Creates a class (a String text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.
        Parameters:
        aClassName - The class name for the class to be generated.
        aPackage - The package to which the class is to belong.
        Returns:
        The text representing the source code to be copy'n'pasted.