Package org.refcodes.configuration

Class AbstractResourcePropertiesDecorator<T extends ResourceProperties>

java.lang.Object

org.refcodes.configuration.AbstractPropertiesDecorator<T>

org.refcodes.configuration.AbstractResourcePropertiesDecorator<T>

Type Parameters:

T - The actual (sub-) type of the Properties to be decorated.

All Implemented Interfaces:

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

Direct Known Subclasses:

PolyglotProperties, ScheduledResourcePropertiesDecorator

public abstract class AbstractResourcePropertiesDecorator<T extends ResourceProperties>
extends AbstractPropertiesDecorator<T>
implements ResourceProperties

Decorates the provided ResourceProperties and delegates method calls to them ResourceProperties.

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

ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder

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

Fields inherited from interface org.refcodes.configuration.ResourceProperties

VALUE_ATTRIBUTES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResourcePropertiesDecorator()	Make sure to set the getProperties() member variable!
	AbstractResourcePropertiesDecorator(T aProperties)	Decorates the provided ResourceProperties with additional behavior or functionality.

Method Summary

Modifier and Type	Method	Description
Properties	reload()	Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
Properties	reload(ReloadMode aReloadMode)	Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)).
java.lang.String	toSerialized()	Produces the external representation of the properties as of the serialized format supported by the implementing class.
java.lang.String	toSerialized(char aDelimiter)	Produces the external representation of the properties as of the serialized format supported by the implementing class.

Methods inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

containsKey, get, getDelimiter, getProperties, isEmpty, keySet, retrieveFrom, retrieveTo, setProperties, size, toDataStructure, values

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 class java.lang.Object

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

Methods inherited from interface org.refcodes.structure.PathMap

children, children, children, children, children, containsKey, containsKey, 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, hasPath, hasPath, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, queryPaths, toDataStructure, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements

Methods inherited from interface org.refcodes.configuration.Properties

containsValue, getDelimiter, getDirAt, getDirAt, getType, query, query, queryFrom, queryTo, retrieve, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo, toMap, toProperties, toPropertyPath

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

Constructor Detail

AbstractResourcePropertiesDecorator

protected AbstractResourcePropertiesDecorator()

Make sure to set the getProperties() member variable!

AbstractResourcePropertiesDecorator

public AbstractResourcePropertiesDecorator(T aProperties)

Decorates the provided ResourceProperties with additional behavior or functionality. Changes applied to the provided ResourceProperties affect the decorator.

Parameters:

aProperties - The ResourceProperties to be decorated.

Method Detail

reload

public Properties reload()
                  throws java.io.IOException,
                         java.lang.IllegalStateException,
                         java.text.ParseException

Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)). In case the resource (such as an InputStream) does not support reloading, then an IllegalStateException is thrown. Properties existing in the attached resource as well in the Properties itself are replaced. Properties existing in the attached resource but not(!) in the Properties itself are not(!) removed. Use ResourceProperties.reload(ReloadMode) with an argument of true (~ orphan removal) to remove properties not existing in the resource.

Specified by:

reload in interface ResourceProperties

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

java.io.IOException - thrown in case accessing the resource encountered an I/O problem.

java.lang.IllegalStateException - in case the attached resource does not support reloading.

java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

reload

public Properties reload(ReloadMode aReloadMode)
                  throws java.io.IOException,
                         java.lang.IllegalStateException,
                         java.text.ParseException

Reloads the ResourceProperties from the resource to which the ResourceProperties are attached to (such as a File as of ResourceProperties.MutableResoureProperties.loadFrom(File) or ResourceProperties.MutableResoureProperties.saveTo(File)). In case the resource (such as an InputStream) does not support reloading, then an IllegalStateException is thrown. Properties existing in the attached resource as well in the Properties itself are replaced. When "orphan removal" is set to false, then properties existing in the attached resource but not(!) in the Properties itself are not(!) removed. When "orphan removal" is set to true, then properties existing in the attached resource but not(!) in the Properties itself are(!) removed.

Specified by:

reload in interface ResourceProperties

Parameters:

aReloadMode - when set to ReloadMode.ORPHAN_REMOVAL, then properties existing in the attached resource but not(!) in the Properties itself are(!) removed. Else properties not existing in the attached resource are kept.

Returns:

The Properties as loaded from the resource and applied to this instance.

Throws:

java.io.IOException - thrown in case accessing the resource encountered an I/O problem.

java.lang.IllegalStateException - in case the attached resource does not support reloading.

java.text.ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

toSerialized

public java.lang.String toSerialized()

Produces the external representation of the properties as of the serialized format supported by the implementing class.

Specified by:

toSerialized in interface ResourceProperties

Returns:

The external (serialized) representation of the properties.

toSerialized

public java.lang.String toSerialized(char aDelimiter)

Produces the external representation of the properties as of the serialized format supported by the implementing class.

Specified by:

toSerialized in interface ResourceProperties

Parameters:

aDelimiter - The path delimiter to be used when serializing the properties (in case the the serialized format supports / requires the such).

Returns:

The external (serialized) representation of the properties.