Package org.refcodes.configuration

Interface Properties

All Superinterfaces:

org.refcodes.structure.CanonicalMap, org.refcodes.structure.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.structure.Dictionary<java.lang.String,T>, org.refcodes.mixin.Dumpable, org.refcodes.structure.Keys<java.lang.String,T>, org.refcodes.structure.PathMap<java.lang.String>, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.mixin.TypeAccessor<java.lang.String>

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractPropertiesBuilderDecorator, AbstractPropertiesDecorator, AbstractResourceProperties, AbstractResourcePropertiesBuilder, AbstractResourcePropertiesBuilderDecorator, AbstractResourcePropertiesDecorator, ArgsProperties, EnvironmentProperties, JavaProperties, JavaPropertiesBuilder, JsonProperties, JsonPropertiesBuilder, NormalizedPropertiesDecorator, PolyglotProperties, PolyglotPropertiesBuilder, ProfilePropertiesDecorator, ProfilePropertiesProjection, PropertiesBuilderImpl, PropertiesImpl, PropertiesPrecedenceBuilderComposite, PropertiesPrecedenceComposite, ScheduledResourcePropertiesBuilderDecorator, ScheduledResourcePropertiesDecorator, StrictPropertiesDecorator, SystemProperties, TomlProperties, TomlPropertiesBuilder, XmlProperties, XmlPropertiesBuilder, YamlProperties, YamlPropertiesBuilder

public interface Properties
extends org.refcodes.structure.CanonicalMap

The Properties are a specialization of the Dictionary. Properties represent a collection of String key and String value pairs as properties usually occur in pure text form, to be converted to the required data types. For this reason, the Properties interface provides additional conversion methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Properties.MutableProperties	The interface Properties.MutableProperties defines "dirty" methods allowing to modify ("mutate") the properties.
static interface	Properties.PropertiesBuilder	The interface Properties.PropertiesBuilder defines builder functionality on top of the properties .

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

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_COMMENT

Method Summary

Modifier and Type	Method	Description
default boolean	containsValue(java.lang.Object value)
default char	getDelimiter()	Returns the default path delimiter as of Delimiter.PATH.
default Properties	getDirAt(int aIndex)
default Properties	getDirAt(java.lang.String aPath, int aIndex)
default java.lang.Class<java.lang.String>	getType()
default Properties	query(java.lang.String aPathQuery)
default Properties	query(java.lang.String aPathQuery, java.lang.String aFromPath, java.lang.String aToPath)
default Properties	queryFrom(java.lang.String aPathQuery, java.lang.String aFromPath)
default Properties	queryTo(java.lang.String aPathQuery, java.lang.String aToPath)
default Properties	retrieve(java.lang.String aFromPath, java.lang.String aToPath)
default Properties	retrieveFrom(java.lang.Object aParentPath)
default Properties	retrieveFrom(java.lang.Object... aPathElements)
Properties	retrieveFrom(java.lang.String aFromPath)
default Properties	retrieveFrom(java.lang.String... aPathElements)
default Properties	retrieveTo(java.lang.Object aToPath)
default Properties	retrieveTo(java.lang.Object... aToPathElements)
Properties	retrieveTo(java.lang.String aToPath)
default Properties	retrieveTo(java.lang.String... aToPathElements)
default java.util.Map<java.lang.String,java.lang.String>	toMap()	This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
default java.util.Properties	toProperties()	This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
default java.lang.String	toPropertyPath(java.lang.String aPath)	Converts the properties for saving; that when saved, them properties will not start with a delimiter, making them (when there are no sub-paths for the properties) look just like normal well known properties, enabling interchangeability with other systems reading the properties.

Methods inherited from interface org.refcodes.structure.CanonicalMap

getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, toInstance, toInstance, toType, toType

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.structure.Keys

containsKey, get, keySet, use, values

Methods inherited from interface org.refcodes.structure.PathMap

children, children, children, children, children, dirs, dirs, dirs, dirs, dirs, fromExternalPath, get, get, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getDirAt, getDirAt, getDirAt, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDirectory, isDirectory, isDirectory, isDirectory, isRecord, isRecord, isRecord, isRecord, isRootPath, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, queryPaths, records, records, records, records, records, toDataStructure, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

asArray, asArray, asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asLongArray, asLongArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, asShortArray, asShortArray, containsKey, get, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getShort, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Field Detail

DEFAULT_COMMENT

static final java.lang.String DEFAULT_COMMENT

Method Detail

getDelimiter

default char getDelimiter()

Returns the default path delimiter as of Delimiter.PATH.

Specified by:

getDelimiter in interface org.refcodes.mixin.DelimiterAccessor

getType

default java.lang.Class<java.lang.String> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor<java.lang.String>

toProperties

default java.util.Properties toProperties()

This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.

Returns:

A Properties object from the herein contained key/value-pairs .

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.Keys<java.lang.String,T extends java.lang.Object>

toMap

default java.util.Map<java.lang.String,java.lang.String> toMap()

This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.

Specified by:

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

Returns:

A Map object from the herein contained key/value-pairs .

toPropertyPath

default java.lang.String toPropertyPath(java.lang.String aPath)

Converts the properties for saving; that when saved, them properties will not start with a delimiter, making them (when there are no sub-paths for the properties) look just like normal well known properties, enabling interchangeability with other systems reading the properties.

Parameters:

aPath - The path to be normalized.

Returns:

The normalized path; afterwards it does not start with a delimiter any more.

retrieveTo

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

retrieveTo

default Properties retrieveTo(java.lang.Object aToPath)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieveTo

default Properties retrieveTo(java.lang.String... aToPathElements)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieveTo

default Properties retrieveTo(java.lang.Object... aToPathElements)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieveFrom

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

retrieveFrom

default Properties retrieveFrom(java.lang.Object aParentPath)

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieveFrom

default Properties retrieveFrom(java.lang.String... aPathElements)

Specified by:

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

retrieveFrom

default Properties retrieveFrom(java.lang.Object... aPathElements)

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieve

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

getDirAt

default Properties getDirAt(int aIndex)

Specified by:

getDirAt in interface org.refcodes.structure.CanonicalMap

Specified by:

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

getDirAt

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

Specified by:

getDirAt in interface org.refcodes.structure.CanonicalMap

Specified by:

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

query

default Properties query(java.lang.String aPathQuery)

Specified by:

query in interface org.refcodes.structure.CanonicalMap

Specified by:

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

queryTo

default Properties queryTo(java.lang.String aPathQuery,
                           java.lang.String aToPath)

Specified by:

queryTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

queryFrom

default Properties queryFrom(java.lang.String aPathQuery,
                             java.lang.String aFromPath)

Specified by:

queryFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

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

query

default Properties query(java.lang.String aPathQuery,
                         java.lang.String aFromPath,
                         java.lang.String aToPath)

Specified by:

query in interface org.refcodes.structure.CanonicalMap

Specified by:

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