org.refcodes.configuration

Interface Properties

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractPropertiesBuilderDecorator, AbstractPropertiesDecorator, AbstractResourcePropertiesBuilder, AbstractResourcePropertiesBuilderDecorator, AbstractResourcePropertiesDecorator, EnvironmentProperties, JavaProperties, JavaPropertiesBuilder, JsonProperties, JsonPropertiesBuilder, NormalizedPropertiesDecorator, ProfilePropertiesDecorator, ProfilePropertiesProjection, PropertiesBuilderImpl, PropertiesImpl, PropertiesPrecedenceComposite, RuntimePropertiesComposite, 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 and 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.structure.PathMap

org.refcodes.structure.PathMap.MutablePathMap<T>, org.refcodes.structure.PathMap.PathMapBuilder<T>

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

org.refcodes.structure.Dictionary.MutableDictionary<K,V>

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

org.refcodes.structure.Keys.MutableKeys<K,V>, org.refcodes.structure.Keys.MutableValues<K,V>

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

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COMMENT

Method Summary

Modifier and Type	Method and Description
Properties	childrenOf(String aParentPath)
default boolean	containsValue(Object value)
default Class<String>	getType()
default Properties	retrieve(String aFromPath, String aToPath)
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
default Map<String,String>	toMap() This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
default Properties	toProperties() This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
default String	toPropertyPath(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

toInstance, toInstance, toType, toType

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, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toRootPath

Methods inherited from interface org.refcodes.structure.Keys

containsKey, get, keySet, use, values

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

Field Detail

DEFAULT_COMMENT

static final String DEFAULT_COMMENT

Method Detail

getType

default Class<String> getType()

Specified by:

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

toProperties

default 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(Object value)

Specified by:

containsValue in interface org.refcodes.structure.CanonicalMap

Specified by:

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

toMap

default Map<String,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<String>

Returns:

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

toPropertyPath

default String toPropertyPath(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.

retrieveFrom

Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieveTo

Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

childrenOf

Properties childrenOf(String aParentPath)

Specified by:

childrenOf in interface org.refcodes.structure.CanonicalMap

Specified by:

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

retrieve

default Properties retrieve(String aFromPath,
                            String aToPath)

Specified by:

retrieve in interface org.refcodes.structure.CanonicalMap

Specified by:

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