Package org.refcodes.configuration

Interface Properties.MutableProperties

All Superinterfaces:

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

All Known Subinterfaces:

ProfileProperties.MutableProfileProperties, ProfileProperties.ProfilePropertiesBuilder, Properties.PropertiesBuilder, ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder, ScheduledResourceProperties.ScheduledMuableResourceProperties, ScheduledResourceProperties.ScheduledResourcePropertiesBuilder, StrictProperties.MutableStrictProperties, StrictProperties.StrictPropertiesBuilder

All Known Implementing Classes:

AbstractPropertiesBuilderDecorator, AbstractResourcePropertiesBuilder, AbstractResourcePropertiesBuilderDecorator, JavaPropertiesBuilder, JsonPropertiesBuilder, PolyglotPropertiesBuilder, PropertiesBuilderImpl, ScheduledResourcePropertiesBuilderDecorator, TomlPropertiesBuilder, XmlPropertiesBuilder, YamlPropertiesBuilder

Enclosing interface:

Properties

public static interface Properties.MutableProperties
extends Properties, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

The interface Properties.MutableProperties defines "dirty" methods allowing to modify ("mutate") the properties.

Nested Class Summary

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

org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

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

org.refcodes.structure.Dictionary.MutableDictionary<K extends java.lang.Object,V extends java.lang.Object>

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

org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K extends java.lang.Object,V extends java.lang.Object,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

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

org.refcodes.structure.Keys.MutableKeys<K extends java.lang.Object,V extends java.lang.Object>, org.refcodes.structure.Keys.MutableValues<K extends java.lang.Object,V extends java.lang.Object>

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

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

org.refcodes.structure.PathMap.MutablePathMap<T extends java.lang.Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends java.lang.Object>

Nested classes/interfaces inherited from interface org.refcodes.configuration.Properties

Properties.MutableProperties, Properties.PropertiesBuilder

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

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends java.lang.Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

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

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

Field Summary

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method	Description
Properties.MutableProperties	childrenOf(java.lang.String aParentPath)
default boolean	containsValue(java.lang.Object value)
default java.lang.String	delete(java.lang.String aKey)
default java.lang.String	delete(org.refcodes.structure.Property aProperty)	Removes a property identified by the key of the provided Property (the value of the Property is ignored).
default Properties	getIndexed(int aIndex)
default Properties	getIndexed(java.lang.String aPath, int aIndex)
default void	insert(java.lang.String aToPath, Properties aFrom, java.lang.String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insert(Properties aFrom)	Method to semantically emphasize that we support our own types.
default void	insertFrom(Properties aFrom, java.lang.String aFromPath)	Method to semantically emphasize that we support our own types.
default void	insertTo(java.lang.String aToPath, Properties aFrom)	Method to semantically emphasize that we support our own types.
default java.lang.String	put(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aRelation)
default void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)
default void	putAll(java.util.Properties aProperties)	This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
default void	putAll(Properties aProperties)	This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
default Properties.MutableProperties	retrieve(java.lang.String aFromPath, java.lang.String aToPath)
Properties.MutableProperties	retrieveFrom(java.lang.String aFromPath)
Properties.MutableProperties	retrieveTo(java.lang.String aToPath)

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

insert, insert, insertFrom, insertTo, putAll, toDump, toSourceCode, toSourceCode

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

toDump

Methods inherited from interface org.refcodes.structure.Keys

containsKey, 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, 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.PathMap

directories, directories, entries, entries, fromExternalKey, get, get, getArray, getArray, getIndexes, getIndexes, getRootPath, hasIndexed, hasIndexed, hasParentPath, isArray, isArray, isDirectory, isEntry, isIndexed, isIndexed, isPath, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toPath

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

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

Methods inherited from interface org.refcodes.configuration.Properties

getDelimiter, getType, toMap, toProperties, toPropertyPath

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.PropertiesAccessorMixin.PropertiesMutatorMixin

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

Method Detail

retrieveFrom

Properties.MutableProperties retrieveFrom(java.lang.String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

retrieveFrom in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

retrieveFrom in interface Properties

retrieveTo

Properties.MutableProperties retrieveTo(java.lang.String aToPath)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

retrieveTo in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

retrieveTo in interface Properties

childrenOf

Properties.MutableProperties childrenOf(java.lang.String aParentPath)

Specified by:

childrenOf in interface org.refcodes.structure.CanonicalMap

Specified by:

childrenOf in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

childrenOf in interface Properties

retrieve

default Properties.MutableProperties retrieve(java.lang.String aFromPath,
                                              java.lang.String aToPath)

Specified by:

retrieve in interface org.refcodes.structure.CanonicalMap

Specified by:

retrieve in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

retrieve in interface Properties

put

default java.lang.String put(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aRelation)

Specified by:

put in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

put in interface org.refcodes.structure.Dictionary.MutableDictionary<java.lang.String,java.lang.String>

Specified by:

put in interface org.refcodes.structure.PathMap.MutablePathMap<java.lang.String>

delete

default java.lang.String delete(java.lang.String aKey)

Specified by:

delete in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

delete in interface org.refcodes.structure.Keys.MutableKeys<java.lang.String,java.lang.String>

Specified by:

delete in interface org.refcodes.structure.PathMap.MutablePathMap<java.lang.String>

delete

default java.lang.String delete(org.refcodes.structure.Property aProperty)

Removes a property identified by the key of the provided Property (the value of the Property is ignored).

Parameters:

aProperty - The Property which's key is to be removed.

Returns:

The removed value of the key or null if there was not such a key.

containsValue

default boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface org.refcodes.structure.CanonicalMap

Specified by:

containsValue in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

containsValue in interface org.refcodes.structure.Keys<java.lang.String,java.lang.String>

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

Specified by:

containsValue in interface Properties

putAll

default void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)

Specified by:

putAll in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

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(java.util.Properties aProperties)

This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.

Specified by:

putAll in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Parameters:

aProperties - A Properties containing the key/value-pairs to be inserted.

insert

default void insert(Properties aFrom)

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

Parameters:

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

insertFrom

default void insertFrom(Properties 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 Properties 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,
                      Properties 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 Properties which is to be inspected with the therein contained values being added with their according determined paths.

insert

default void insert(java.lang.String aToPath,
                    Properties aFrom,
                    java.lang.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 Properties 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.

getIndexed

default Properties getIndexed(int aIndex)

Specified by:

getIndexed in interface org.refcodes.structure.CanonicalMap

Specified by:

getIndexed in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

getIndexed in interface Properties

getIndexed

default Properties getIndexed(java.lang.String aPath,
                              int aIndex)

Specified by:

getIndexed in interface org.refcodes.structure.CanonicalMap

Specified by:

getIndexed in interface org.refcodes.structure.PathMap<java.lang.String>

Specified by:

getIndexed in interface Properties