Package net.officefloor.cache.constant

Class ConstantCacheManagedObjectSource<K,V>

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

net.officefloor.cache.constant.ConstantCacheManagedObjectSource<K,V>

All Implemented Interfaces:

ManagedObject, ManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

public class ConstantCacheManagedObjectSource<K,V>
extends AbstractManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>
implements ManagedObject

Cache ManagedObjectSource that loads a constant data set.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConstantCacheManagedObjectSource.Flows	Flow keys.

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_RETRIEVER_QUALIFIER	Qualifier for the ConstantCacheDataRetriever dependency.
static final String	POLL_INTERVAL	Property name for the poll interval in milliseconds.

Constructor Summary

Constructors

Constructor	Description
ConstantCacheManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
Cache<K,V>	getCache()	Obtains the Cache.
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
Object	getObject()	Obtains the object being managed.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,ConstantCacheManagedObjectSource.Flows> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	====================== ManagedObjectSource ==========================
void	start(ManagedObjectExecuteContext<ConstantCacheManagedObjectSource.Flows> context)	Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, stop

Methods inherited from class java.lang.Object

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

Field Details

POLL_INTERVAL

public static final String POLL_INTERVAL

Property name for the poll interval in milliseconds.

See Also:

• Constant Field Values

DATA_RETRIEVER_QUALIFIER

public static final String DATA_RETRIEVER_QUALIFIER

Qualifier for the ConstantCacheDataRetriever dependency.

See Also:

• Constant Field Values

Constructor Details

ConstantCacheManagedObjectSource

public ConstantCacheManagedObjectSource()

Method Details

getCache

public Cache<K,V> getCache()

Obtains the Cache.

Returns:

Cache.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

====================== ManagedObjectSource ==========================

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,ConstantCacheManagedObjectSource.Flows> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

start

public void start(ManagedObjectExecuteContext<ConstantCacheManagedObjectSource.Flows> context)
           throws Exception

Description copied from interface: ManagedObjectSource

Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Specified by:

start in interface ManagedObjectSource<K,V>

Overrides:

start in class AbstractAsyncManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

Exception - Should the ManagedObjectSource fail to start execution.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,ConstantCacheManagedObjectSource.Flows>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.

getObject

public Object getObject()
                 throws Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Throwable - Indicating failed to obtain the object for use.