org.refcodes.configuration

Class NormalizedPropertiesDecorator

java.lang.Object

org.refcodes.configuration.AbstractPropertiesDecorator<Properties>

org.refcodes.configuration.NormalizedPropertiesDecorator

All Implemented Interfaces:

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

public class NormalizedPropertiesDecorator
extends AbstractPropertiesDecorator<Properties>
implements Properties

The NormalizedPropertiesDecorator type decorates a Properties instance and converts a path delimiter such as the full-stop (".") to the Properties properties' path delimiter slash ("/", as of AbstractPropertiesDecorator.getDelimiter()). E.g. you get a projection of your Properties using "." as the path delimiter as if them had a "/" as path delimiter. Invoking NormalizedPropertiesDecorator(Properties, char[]) the constructor, you can define the delimiters to be projected to the default "/" delimiter (as of AbstractPropertiesDecorator.getDelimiter()). Upon accessing a key, the implementation first tests whether the decorated (underlying) Properties contain this key, then the decorated (underlying) Properties' keys are tested by converting the keys using the first provided delimiter to be replaced by the "/" delimiter". If we have a match, then this property is processed, else the procedure continues with the next delimiter. This means that the first match wins, if we have succeeding matches with succeeding delimiters then an AmbigousKeyRuntimeException is thrown In case of accessing the keySet(), all keys are converted by replacing all the provided delimiters (or the full-stop ("."), depending on the constructor you called) to the default delimiter "/". In case we have a key collision then an AmbigousKeyRuntimeException is thrown.

Nested Class Summary

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

Properties.MutableProperties, Properties.PropertiesBuilder

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 inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

_properties

Fields inherited from interface org.refcodes.configuration.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor and Description
NormalizedPropertiesDecorator(Properties aProperties) Decorates the provided Properties with additional behavior by normalizing the key representing the path pointing to the according value.
NormalizedPropertiesDecorator(Properties aProperties, char[] aDelimiters) Decorates the provided Properties with additional behavior by normalizing the key representing the path pointing to the according value.

Method Summary

Modifier and Type	Method and Description
Properties	childrenOf(String aParentPath)
boolean	containsKey(Object aKey)
protected static String	fromNormalized(String aKey, char aFromDelimiter, char aToDelimiter)
String	get(Object aKey)
Set<String>	keySet()
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
protected String	toDelimiters()
protected static String	toNormalized(String aKey, char aToDelimiter, char... aFromDelimiters)

Methods inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

getDelimiter, isEmpty, size, toDataStructure, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.configuration.Properties

containsValue, getType, retrieve, toMap, toProperties, toPropertyPath

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

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

Constructor Detail

NormalizedPropertiesDecorator

public NormalizedPropertiesDecorator(Properties aProperties)

Decorates the provided Properties with additional behavior by normalizing the key representing the path pointing to the according value. You provide Properties with a path delimiter different from the default delimiter and you get Properties which act as if the delimiter was the default delimiter: Paths containing the namespace delimiter "." (as of Delimiter.NAMESPACE are converted to paths' with delimiter "/" (as of Delimiter.PATH. Changes applied to the provided Properties affect the decorator.

Parameters:

aProperties - The Properties to be decorated.

NormalizedPropertiesDecorator

public NormalizedPropertiesDecorator(Properties aProperties,
                                     char[] aDelimiters)

Decorates the provided Properties with additional behavior by normalizing the key representing the path pointing to the according value. You provide Properties with a path delimiter different from the default delimiter and you get Properties which act as if the delimiter was the default delimiter: Paths containing the provided delimiters are converted to the paths' with delimiter "/" (as of Delimiter.PATH. Changes applied to the provided Properties affect the decorator.

Parameters:

aProperties - The Properties to be decorated.

aDelimiters - The delimiters to be converted forth and back

Method Detail

containsKey

public boolean containsKey(Object aKey)

Specified by:

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

Overrides:

containsKey in class AbstractPropertiesDecorator<Properties>

get

public String get(Object aKey)

Specified by:

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

Overrides:

get in class AbstractPropertiesDecorator<Properties>

keySet

public Set<String> keySet()

Specified by:

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

Overrides:

keySet in class AbstractPropertiesDecorator<Properties>

retrieveFrom

public Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface Properties

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap

Specified by:

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

Overrides:

retrieveFrom in class AbstractPropertiesDecorator<Properties>

retrieveTo

public Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface Properties

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap

Specified by:

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

Overrides:

retrieveTo in class AbstractPropertiesDecorator<Properties>

childrenOf

public Properties childrenOf(String aParentPath)

Specified by:

childrenOf in interface Properties

Specified by:

childrenOf in interface org.refcodes.structure.CanonicalMap

Specified by:

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

Overrides:

childrenOf in class AbstractPropertiesDecorator<Properties>

toDelimiters

protected String toDelimiters()

fromNormalized

protected static String fromNormalized(String aKey,
                                       char aFromDelimiter,
                                       char aToDelimiter)

toNormalized

protected static String toNormalized(String aKey,
                                     char aToDelimiter,
                                     char... aFromDelimiters)