Package org.refcodes.structure

Interface PathMap.MutablePathMap<T>

Type Parameters:

T - The type of the terminating elements.

All Superinterfaces:

Clearable, Containable, org.refcodes.mixin.DelimiterAccessor, Dictionary<String,T>, Dictionary.MutableDictionary<String,T>, org.refcodes.mixin.Dumpable, Keys<String,T>, Keys.MutableKeys<String,T>, Keys.MutableValues<String,T>, Map<String,T>, PathMap<T>, org.refcodes.mixin.TypeAccessor<T>

All Known Subinterfaces:

CanonicalMap.CanonicalMapBuilder, CanonicalMap.MutableCanonicalMap, PathMap.PathMapBuilder<T>

All Known Implementing Classes:

CanonicalMapBuilderImpl, PathMapBuilderImpl

Enclosing interface:

PathMap<T>

public static interface PathMap.MutablePathMap<T>
extends PathMap<T>, Dictionary.MutableDictionary<String,T>, Map<String,T>

Extends the PathMap with mutator functionality.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary

Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.structure.Keys

Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Method Summary

Modifier and Type	Method	Description
default T	delete(String aKey)	Removes an element identified by the given key.
default void	insert(Object aFrom)	Inspects the given object and adds all elements found in the given object.
default void	insert(String aToPath, Object aFrom, String aFromPath)	Same as insert(Object) though starting insertion of object's introspected values at the given "to-path" and starting object introspection at the given "from-path", e.g. ignoring all paths not starting with the given path during the introspection process.
default void	insert(String aToPath, PathMap<T> aFrom, String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insert(PathMap<T> aFrom)	Method to semantically emphasize that we support our own types.
default void	insertFrom(Object aFrom, String aFromPath)	Same as insert(Object) though starting object introspection at the given "path", e.g. ignoring all paths not starting with the given path during the introspection process.
default void	insertFrom(PathMap<T> aFrom, String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insertTo(String aToPath, Object aFrom)	Same as insert(Object) though starting insertion of object's introspected values at the given "path".
default void	insertTo(String aToPath, PathMap<T> aFrom)	Method to semantically emphasize that we support our own types.
default T	put(String aParentPath, String aChildPath, T aValue)	Puts the given value into the child's path, relative to the given parent's path.
default T	put(Relation<String,T> aRelation)	Adds the given element related to the given key.
default T[]	putArray(String aPath, T[] aValues)	Sets the records below the given path in an array and replaces any existing array.
default T[]	putArray(T[] aValues)	Applies the putArray(Object[]) method for the root path "/".
default void	removeAll(String aPath)	Removes all properties below the provided path.

Methods inherited from interface org.refcodes.structure.Clearable

clear

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.structure.Keys

containsKey, containsValue, get, get, keySet, use, values

Methods inherited from interface org.refcodes.structure.Keys.MutableValues

put

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.refcodes.structure.PathMap

childrenOf, directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, retrieve, retrieveFrom, retrieveTo, toDataStructure, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Method Detail

put

default T put(Relation<String,T> aRelation)

Adds the given element related to the given key.

Specified by:

put in interface Dictionary.MutableDictionary<String,T>

Parameters:

aRelation - the relation

Returns:

The value being replaced by the provided value or null if none value has been replaced.

putArray

default T[] putArray(T[] aValues)

Applies the putArray(Object[]) method for the root path "/".

Parameters:

aValues - The values to be put.

Returns:

An array of the records being replaced by the provided elements.

putArray

default T[] putArray(String aPath,
                     T[] aValues)

Sets the records below the given path in an array and replaces any existing array. Records in a PathMap are reckoned to be part of an array when they belong to the same hierarchy level and when their keys represent integer numbers. Given the below example, the elements below "/animals/dogs" can be represented as an array with five elements (the path is denoted at the left hand side of the assignment ":=" operator and the value at the right and side accordingly):

• "/animals/dogs/0" := "ace"
• "/animals/dogs/1" := "bandit"
• "/animals/dogs/2" := "radar"
• "/animals/dogs/3" := "echo"
• "/animals/dogs/4" := "snoopy"

The resulting array when calling PathMap.getArray(String) for the path "/animals/dogs" would contain {"ace", "bandit", "radar", "echo", "snoopy"}. Calling isArray("/animals/dogs") would return true whereas calling isArray("/animals") would return false.

Parameters:

aPath - the path

aValues - The values to be put.

Returns:

An array of the records being replaced by the provided elements.

delete

default T delete(String aKey)

Removes an element identified by the given key.

Specified by:

delete in interface Keys.MutableKeys<String,T>

Parameters:

aKey - The key which's element is to be removed.

Returns:

The value being removed.

removeAll

default void removeAll(String aPath)

Removes all properties below the provided path.

Parameters:

aPath - The path from where to remove all properties.

put

default T put(String aParentPath,
              String aChildPath,
              T aValue)

Puts the given value into the child's path, relative to the given parent's path.

Parameters:

aParentPath - The parent's path relative to which to put the value.

aChildPath - The child's path, targets the value relative to the parent's path.

aValue - The value to be added.

Returns:

The replaced value in case a value has already been set for the resulting path, or null.

insert

default void insert(Object aFrom)

Inspects the given object and adds all elements found in the given object. Elements of type Map, Collection and arrays are identified and handled as of their type: The path for each value in a Map is appended with its according key. The path for each value in a Collection or array is appended with its according index of occurrence (in case of a List or an array, its actual index). In case of reflection, the path for each member is appended with its according mamber's name. All elements (e.g. the members and values) are inspected recursively which results in the according paths of the terminating values.

Parameters:

aFrom - The object which is to be inspected with the therein contained values being added with their according determined paths.

insertFrom

default void insertFrom(Object aFrom,
                        String aFromPath)

Same as insert(Object) though starting object introspection at the given "path", e.g. ignoring all paths not starting with the given path during the introspection process. The resulting paths do not start with the provided path.

Parameters:

aFrom - The object 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,
                      Object aFrom)

Same as insert(Object) though starting insertion of object's introspected values at the given "path".

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aFrom - The object which is to be inspected with the therein contained values being added with their according determined paths.

insert

default void insert(String aToPath,
                    Object aFrom,
                    String aFromPath)

Same as insert(Object) though starting insertion of object's introspected values at the given "to-path" and starting object introspection at the given "from-path", e.g. ignoring all paths not starting with the given path during the introspection process. The resulting paths do not start with the "from-path" path, them start with the given "to-path".

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aFrom - The object 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.

insert

default void insert(PathMap<T> aFrom)

Method to semantically emphasize that we support our own types. Actually delegates to insert(Object).

Parameters:

aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.

insertFrom

default void insertFrom(PathMap<T> aFrom,
                        String aFromPath)

Method to semantically emphasize that we support our own types. Actually delegates to insertFrom(Object, String).

Parameters:

aFrom - The PathMap 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,
                      PathMap<T> aFrom)

Method to semantically emphasize that we support our own types. Actually delegates to insertTo(String, Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.

insert

default void insert(String aToPath,
                    PathMap<T> aFrom,
                    String aFromPath)

Method to semantically emphasize that we support our own types. Actually delegates to insert(String, Object, String).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aFrom - The PathMap 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.