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

Direct Known Subclasses:

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

ResourceProperties.MutableResoureProperties, ResourceProperties.ResourcePropertiesBuilder

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

DEFAULT_COMMENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.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.saveTo(File)).
File	saveTo(File aFile, String aComment, char aDelimiter) Saves the properties to the given File using the provided delimiter as the destination's path delimiter.
void	saveTo(OutputStream aOutputStream, String aComment, char aDelimiter) Saves the properties to the given OutputStream using the provided delimiter as the destination's path delimiter.

Methods inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

containsKey, get, getDelimiter, isEmpty, keySet, retrieveFrom, retrieveTo, 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.ResourceProperties

fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, fileTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, toSerialized, toSerialized

Methods inherited from interface org.refcodes.configuration.Properties

containsValue, getType, retrieve, retrieveFrom, retrieveTo, 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, 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

Constructor Detail

AbstractResourcePropertiesDecorator

protected AbstractResourcePropertiesDecorator()

Make sure to set the _properties 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

saveTo

public void saveTo(OutputStream aOutputStream,
                   String aComment,
                   char aDelimiter)
            throws IOException

Saves the properties to the given OutputStream using the provided delimiter as the destination's path delimiter. Load them via ResourceProperties.MutableResoureProperties.loadFrom(InputStream, char...) This is the hook-method of the default implementation for writing (saving) the properties. In case you want to implement ResourceProperties which support other notations than the properties notation (path=value), then you overwrite this method in your implementation accordingly.

Specified by:

saveTo in interface ResourceProperties

Parameters:

aOutputStream - The OutputStream to which to save the properties to.

aComment - The description for the properties file.

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

Throws:

IOException - thrown in case saving the properties failed

reload

public Properties reload()
                  throws IOException,
                         IllegalStateException,
                         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.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:

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

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

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

reload

public Properties reload(ReloadMode aReloadMode)
                  throws IOException,
                         IllegalStateException,
                         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.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:

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

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

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

saveTo

public File saveTo(File aFile,
                   String aComment,
                   char aDelimiter)
            throws IOException

Saves the properties to the given File using the provided delimiter as the destination's path delimiter. Load them via ResourceProperties.MutableResoureProperties.loadFrom(File, char...). The default implementation uses the hook method ResourceProperties.saveTo(OutputStream, String, char) to finally format and write the properties.

Specified by:

saveTo in interface ResourceProperties

Parameters:

aFile - The File from which to load the properties.

aComment - The description for the properties file.

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

Returns:

The File representing the actual location where the properties have been saved to.

Throws:

IOException - thrown in case saving the properties failed