org.refcodes.configuration

Class ScheduledResourcePropertiesDecorator

java.lang.Object

org.refcodes.configuration.AbstractPropertiesDecorator<T>

org.refcodes.configuration.AbstractResourcePropertiesDecorator<ResourceProperties>

org.refcodes.configuration.ScheduledResourcePropertiesDecorator

All Implemented Interfaces:

org.refcodes.component.Startable, org.refcodes.component.Stoppable, Properties, ResourceProperties, ScheduledResourceProperties, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Disposable, 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 ScheduledResourcePropertiesDecorator
extends AbstractResourcePropertiesDecorator<ResourceProperties>
implements ScheduledResourceProperties

The ScheduledResourcePropertiesDecorator decorates ResourceProperties from which the properties are to be reloaded periodically via AbstractResourcePropertiesDecorator.reload(ReloadMode). Depending on the invoked constructor, you can define whether orphan removal (see AbstractResourcePropertiesDecorator.reload(ReloadMode)) is to be taken care of and the poll loop time, e.g. in which time interval the properties are to be reloaded.

Nested Class Summary

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

ScheduledResourceProperties.ScheduledMuableResourceProperties, ScheduledResourceProperties.ScheduledResourcePropertiesBuilder

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

Nested classes/interfaces inherited from interface org.refcodes.component.Startable

org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Startable.StartBuilder<B extends org.refcodes.component.Startable.StartBuilder<B>>, org.refcodes.component.Startable.UncheckedStartable

Nested classes/interfaces inherited from interface org.refcodes.component.Stoppable

org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.component.Stoppable.StopBuilder<B extends org.refcodes.component.Stoppable.StopBuilder<B>>, org.refcodes.component.Stoppable.UncheckedStoppable

Nested classes/interfaces inherited from interface org.refcodes.mixin.Disposable

org.refcodes.mixin.Disposable.Disposedable

Field Summary

Fields inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

_properties

Fields inherited from interface org.refcodes.configuration.ResourceProperties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor and Description
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with default settings being a poll loop time of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, int aScheduleTimeInMillis) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode, org.refcodes.mixin.ThreadMode aThreadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, int aScheduleTimeInMillis, org.refcodes.mixin.ThreadMode aThreadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, ReloadMode aReloadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the the default poll loop time of 10 seconds (as of PollLoopTime.NORM and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, ReloadMode aReloadMode, org.refcodes.mixin.ThreadMode aThreadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the the default poll loop time of 10 seconds (as of PollLoopTime.NORM and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument).
ScheduledResourcePropertiesDecorator(ResourceProperties aProperties, org.refcodes.mixin.ThreadMode aThreadMode) Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with default settings being a poll loop time of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true).

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	start()
void	stop()

Methods inherited from class org.refcodes.configuration.AbstractResourcePropertiesDecorator

reload, reload, saveTo, saveTo

Methods inherited from class org.refcodes.configuration.AbstractPropertiesDecorator

childrenOf, 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, reload, reload, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, toSerialized, toSerialized

Methods inherited from interface org.refcodes.configuration.Properties

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

Methods inherited from interface org.refcodes.component.Startable

startUnchecked

Methods inherited from interface org.refcodes.component.Stoppable

stopUnchecked

Constructor Detail

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with default settings being a poll loop time of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true). The scheduling Thread is started as daemon thread (see ThreadMode.DAEMON). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            int aScheduleTimeInMillis)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true). The scheduling Thread is started as daemon thread (see ThreadMode.DAEMON). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

aScheduleTimeInMillis - The time in milliseconds between polling for new properties.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            ReloadMode aReloadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the the default poll loop time of 10 seconds (as of PollLoopTime.NORM and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument). The scheduling Thread is started as daemon thread (see ThreadMode.DAEMON). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

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.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            int aScheduleTimeInMillis,
                                            ReloadMode aReloadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument). The scheduling Thread is started as daemon thread (see ThreadMode.DAEMON). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

aScheduleTimeInMillis - The time in milliseconds between polling for new properties.

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.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            org.refcodes.mixin.ThreadMode aThreadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with default settings being a poll loop time of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

aThreadMode - The ThreadMode mode of operation regarding the Thread doing the scheduling job.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            int aScheduleTimeInMillis,
                                            org.refcodes.mixin.ThreadMode aThreadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and orphan removal (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with true). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

aScheduleTimeInMillis - The time in milliseconds between polling for new properties.

aThreadMode - The ThreadMode mode of operation regarding the Thread doing the scheduling job.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            ReloadMode aReloadMode,
                                            org.refcodes.mixin.ThreadMode aThreadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the the default poll loop time of 10 seconds (as of PollLoopTime.NORM and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

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.

aThreadMode - The ThreadMode mode of operation regarding the Thread doing the scheduling job.

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.

ScheduledResourcePropertiesDecorator

public ScheduledResourcePropertiesDecorator(ResourceProperties aProperties,
                                            int aScheduleTimeInMillis,
                                            ReloadMode aReloadMode,
                                            org.refcodes.mixin.ThreadMode aThreadMode)
                                     throws IOException,
                                            ParseException,
                                            IllegalStateException

Constructs the ScheduledResourcePropertiesDecorator wrapping the given ResourceProperties with setting the given poll loop time and the given orphan removal strategy (as of AbstractResourcePropertiesDecorator.reload(ReloadMode) being called with your argument). Immediately starts polling after construction of this instance for new properties.

Parameters:

aProperties - The properties from which the properties are to be reloaded periodically.

aScheduleTimeInMillis - The time in milliseconds between polling for new properties.

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.

aThreadMode - The ThreadMode mode of operation regarding the Thread doing the scheduling job.

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.

Method Detail

start

public void start()
           throws org.refcodes.component.StartException

Specified by:

start in interface org.refcodes.component.Startable

Throws:

org.refcodes.component.StartException

stop

public void stop()
          throws org.refcodes.component.StopException

Specified by:

stop in interface org.refcodes.component.Stoppable

Throws:

org.refcodes.component.StopException

dispose

public void dispose()

Specified by:

dispose in interface org.refcodes.mixin.Disposable