org.refcodes.structure

Interface CanonicalMap.MutableCanonicalMap

All Superinterfaces:

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

All Known Subinterfaces:

CanonicalMap.CanonicalMapBuilder

All Known Implementing Classes:

CanonicalMapBuilderImpl

Enclosing interface:

CanonicalMap

public static interface CanonicalMap.MutableCanonicalMap
extends CanonicalMap, PathMap.MutablePathMap<String>, PropertiesAccessorMixin.PropertiesMutatorMixin, Map<String,String>

The Interface MutableCanonicalMap.

Nested Class Summary

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

CanonicalMap.CanonicalMapBuilder, CanonicalMap.MutableCanonicalMap

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

PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin

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.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.mixin.TypeAccessor

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

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.Dictionary

Dictionary.MutableDictionary<K,V>

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,V>

Field Summary

Fields inherited from interface org.refcodes.structure.CanonicalMap

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method and Description
default boolean	containsValue(Object value) This method is defined for the sake of Map conformity.
default String	delete(String aKey) Removes an element identified by the given key.
default void	insert(CanonicalMap aFrom) Method to semantically emphasize that we support our own types.
default void	insert(String aToPath, CanonicalMap aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default void	insertFrom(CanonicalMap aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default void	insertTo(String aToPath, CanonicalMap aFrom) Method to semantically emphasize that we support our own types.
default String	put(Relation<String,String> aRelation) Adds the given element related to the given key.
default void	putAll(CanonicalMap aProperties) This method inserts all elements (key/value-pairs) found in the provided CanonicalMap instances of interoperability reasons.
default void	putAll(Map<? extends String,? extends String> aProperties)
default void	putAll(Properties aProperties) This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
default Map<String,String>	toDump(Map<String,String> aDump)
default String	toSourceCode(String aClassName, 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.

Methods inherited from interface org.refcodes.structure.CanonicalMap

retrieve, retrieveFrom, retrieveTo, toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, fromExternalKey, getArray, getArray, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toRootPath

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

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

put

Methods inherited from interface org.refcodes.structure.Keys

containsKey, get, keySet, use, values

Methods inherited from interface org.refcodes.structure.Clearable

clear

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Method Detail

put

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

Adds the given element related to the given key.

Specified by:

put in interface Dictionary.MutableDictionary<String,String>

Specified by:

put in interface PathMap.MutablePathMap<String>

Parameters:

aRelation - the a relation

Returns:

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

delete

default String delete(String aKey)

Removes an element identified by the given key.

Specified by:

delete in interface Keys.MutableKeys<String,String>

Specified by:

delete in interface PathMap.MutablePathMap<String>

Parameters:

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

Returns:

The value being removed.

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 CanonicalMap

Specified by:

containsValue in interface Keys<String,String>

Specified by:

containsValue in interface Map<String,String>

Parameters:

value - The value to test if a key references this value.

Returns:

True in case the given value is referenced by a key.

putAll

default void putAll(Map<? extends String,? extends String> aProperties)

Specified by:

putAll in interface Map<String,String>

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(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.

toSourceCode

default String toSourceCode(String aClassName,
                            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.

toDump

default Map<String,String> toDump(Map<String,String> aDump)

Specified by:

toDump in interface org.refcodes.mixin.Dumpable

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.

insertFrom

default void insertFrom(CanonicalMap aFrom,
                        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(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.

insert

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

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(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.