Package org.refcodes.configuration

Interface Properties.PropertiesBuilder

All Superinterfaces:

org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, 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.structure.Dictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,org.refcodes.structure.PathMap.PathMapBuilder<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>, org.refcodes.structure.PathMap.PathMapBuilder<java.lang.String>, Properties, Properties.MutableProperties, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin, org.refcodes.mixin.TypeAccessor<java.lang.String>

All Known Subinterfaces:

ProfileProperties.ProfilePropertiesBuilder, ResourceProperties.ResourcePropertiesBuilder, ScheduledResourceProperties.ScheduledResourcePropertiesBuilder, StrictProperties.StrictPropertiesBuilder

All Known Implementing Classes:

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

Enclosing interface:

Properties

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

The interface Properties.PropertiesBuilder defines builder functionality on top of 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.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.PropertiesBuilder	childrenOf(java.lang.String aParentPath)
default Properties	getIndexed(int aIndex)
default Properties	getIndexed(java.lang.String aPath, int aIndex)
default Properties.PropertiesBuilder	retrieve(java.lang.String aFromPath, java.lang.String aToPath)
Properties.PropertiesBuilder	retrieveFrom(java.lang.String aFromPath)
Properties.PropertiesBuilder	retrieveTo(java.lang.String aToPath)
default Properties.PropertiesBuilder	withInsert(java.lang.Object aObj)
default Properties.PropertiesBuilder	withInsert(java.lang.String aToPath, java.lang.Object aFrom, java.lang.String aFromPath)
default Properties.PropertiesBuilder	withInsert(java.lang.String aToPath, Properties aFrom, java.lang.String aFromPath)	Method to semantically emphasize that we support our own types.
default Properties.PropertiesBuilder	withInsert(Properties aFrom)	Method to semantically emphasize that we support our own types.
default Properties.PropertiesBuilder	withInsertFrom(java.lang.Object aFrom, java.lang.String aFromPath)
default Properties.PropertiesBuilder	withInsertFrom(Properties aFrom, java.lang.String aFromPath)	Method to semantically emphasize that we support our own types.
default Properties.PropertiesBuilder	withInsertTo(java.lang.String aToPath, java.lang.Object aFrom)
default Properties.PropertiesBuilder	withInsertTo(java.lang.String aToPath, Properties aFrom)	Method to semantically emphasize that we support our own types.
default Properties.PropertiesBuilder	withPut(java.lang.String aKey, java.lang.String aValue)
default Properties.PropertiesBuilder	withPut(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)
default Properties.PropertiesBuilder	withPutBoolean(java.lang.String aKey, java.lang.Boolean aValue)
default Properties.PropertiesBuilder	withPutByte(java.lang.String aKey, java.lang.Byte aValue)
default Properties.PropertiesBuilder	withPutDouble(java.lang.String aKey, java.lang.Double aValue)
default Properties.PropertiesBuilder	withPutFloat(java.lang.String aKey, java.lang.Float aValue)
default Properties.PropertiesBuilder	withPutInteger(java.lang.String aKey, java.lang.Integer aValue)
default Properties.PropertiesBuilder	withPutLong(java.lang.String aKey, java.lang.Long aValue)
default Properties.PropertiesBuilder	withPutShort(java.lang.String aKey, java.lang.Short aValue)
default Properties.PropertiesBuilder	withRemoveFrom(java.lang.String aPath)

Methods inherited from interface org.refcodes.structure.CanonicalMap

toInstance, toInstance, toType, toType

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

withInsert, withInsert, withInsertFrom, withInsertTo

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

put

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.structure.PathMap.PathMapBuilder

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.configuration.Properties

getDelimiter, getType, toMap, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.configuration.Properties.MutableProperties

containsValue, delete, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll

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

withPut

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

Specified by:

retrieveFrom in interface Properties.MutableProperties

retrieveTo

Properties.PropertiesBuilder 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

Specified by:

retrieveTo in interface Properties.MutableProperties

childrenOf

Properties.PropertiesBuilder 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

Specified by:

childrenOf in interface Properties.MutableProperties

retrieve

default Properties.PropertiesBuilder 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

Specified by:

retrieve in interface Properties.MutableProperties

withPut

default Properties.PropertiesBuilder withPut(java.lang.String aKey,
                                             java.lang.String aValue)

Specified by:

withPut in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,org.refcodes.structure.PathMap.PathMapBuilder<java.lang.String>>

Specified by:

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

Specified by:

withPut in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPut

default Properties.PropertiesBuilder withPut(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)

Specified by:

withPut in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,org.refcodes.structure.PathMap.PathMapBuilder<java.lang.String>>

Specified by:

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

withPutInteger

default Properties.PropertiesBuilder withPutInteger(java.lang.String aKey,
                                                    java.lang.Integer aValue)

Specified by:

withPutInteger in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutInteger in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutShort

default Properties.PropertiesBuilder withPutShort(java.lang.String aKey,
                                                  java.lang.Short aValue)

Specified by:

withPutShort in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutShort in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutByte

default Properties.PropertiesBuilder withPutByte(java.lang.String aKey,
                                                 java.lang.Byte aValue)

Specified by:

withPutByte in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutByte in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutDouble

default Properties.PropertiesBuilder withPutDouble(java.lang.String aKey,
                                                   java.lang.Double aValue)

Specified by:

withPutDouble in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutDouble in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutFloat

default Properties.PropertiesBuilder withPutFloat(java.lang.String aKey,
                                                  java.lang.Float aValue)

Specified by:

withPutFloat in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutFloat in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutBoolean

default Properties.PropertiesBuilder withPutBoolean(java.lang.String aKey,
                                                    java.lang.Boolean aValue)

Specified by:

withPutBoolean in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutBoolean in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutLong

default Properties.PropertiesBuilder withPutLong(java.lang.String aKey,
                                                 java.lang.Long aValue)

Specified by:

withPutLong in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutLong in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withInsert

default Properties.PropertiesBuilder withInsert(java.lang.Object aObj)

Specified by:

withInsert in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

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

withInsertFrom

default Properties.PropertiesBuilder withInsertFrom(java.lang.Object aFrom,
                                                    java.lang.String aFromPath)

Specified by:

withInsertFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

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

withInsertTo

default Properties.PropertiesBuilder withInsertTo(java.lang.String aToPath,
                                                  java.lang.Object aFrom)

Specified by:

withInsertTo in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

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

withInsert

default Properties.PropertiesBuilder withInsert(java.lang.String aToPath,
                                                java.lang.Object aFrom,
                                                java.lang.String aFromPath)

Specified by:

withInsert in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

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

withRemoveFrom

default Properties.PropertiesBuilder withRemoveFrom(java.lang.String aPath)

Specified by:

withRemoveFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

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

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

Specified by:

getIndexed in interface Properties.MutableProperties

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

Specified by:

getIndexed in interface Properties.MutableProperties

withInsert

default Properties.PropertiesBuilder withInsert(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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insert(Object)

withInsertFrom

default Properties.PropertiesBuilder withInsertFrom(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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insertFrom(Object, String)

withInsertTo

default Properties.PropertiesBuilder withInsertTo(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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insertTo(String, Object)

withInsert

default Properties.PropertiesBuilder withInsert(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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insert(String, Object, String)