Package net.officefloor.frame.api.managedobject.source

Interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

All Superinterfaces:

SourceContext, SourceProperties

All Known Implementing Classes:

ManagedObjectSourceContextImpl

public interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>
extends SourceContext

Context for a ManagedObjectSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ManagedObjectFunctionDependency	addFunctionDependency(java.lang.String name, java.lang.Class<?> objectType)	Adds a ManagedObjectFunctionDependency.
<O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f>	addManagedFunction(java.lang.String functionName, ManagedFunctionFactory<O,f> managedFunctionFactory)	Creates the ManagedObjectFunctionBuilder to build a ManagedFunction.
void	addStartupFunction(java.lang.String functionName, java.lang.Object parameter)	Adds a ManagedFunction to invoke on start up of the Office.
ManagedObjectStartupCompletion	createStartupCompletion()	Creates a ManagedObjectStartupCompletion.
ManagedObjectSourceFlow	getFlow(int flowIndex)	Obtains the ManagedObjectSourceFlow.
ManagedObjectSourceFlow	getFlow(F key)	Obtains the ManagedObjectSourceFlow.
<O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f>	getRecycleFunction(ManagedFunctionFactory<O,f> managedFunctionFactory)	Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.
ManagedObjectPoolBuilder	setDefaultManagedObjectPool(ManagedObjectPoolFactory poolFactory)	Specifies the default ManagedObjectPool.

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

setDefaultManagedObjectPool

ManagedObjectPoolBuilder setDefaultManagedObjectPool(ManagedObjectPoolFactory poolFactory)

Specifies the default ManagedObjectPool.

This may be overridden by ManagedObjectBuilder configuration, however allows for a default ManagedObjectPool should one not be configured.

Parameters:

poolFactory - ManagedObjectPoolFactory for the default ManagedObjectPool.

Returns:

ManagedObjectPoolBuilder.

getFlow

ManagedObjectSourceFlow getFlow(F key)

Obtains the ManagedObjectSourceFlow.

Parameters:

key - Key identifying Flow being invoked by the ManagedObjectSource.

Returns:

ManagedObjectSourceFlow for the key.

getFlow

ManagedObjectSourceFlow getFlow(int flowIndex)

Obtains the ManagedObjectSourceFlow.

Parameters:

flowIndex - Index identifying the Flow.

Returns:

ManagedObjectSourceFlow for the index.

getRecycleFunction

<O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f> getRecycleFunction(ManagedFunctionFactory<O,f> managedFunctionFactory)

Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.

The initial ManagedFunction will be used as the recycle starting point for this ManagedObject.

Type Parameters:

O - Dependency key type.

f - Flow key type.

Parameters:

managedFunctionFactory - ManagedFunctionFactory to create the recycle ManagedFunction.

Returns:

ManagedObjectFunctionBuilder to recycle this ManagedObject.

addManagedFunction

<O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f> addManagedFunction(java.lang.String functionName,
                                                                                                                           ManagedFunctionFactory<O,f> managedFunctionFactory)

Creates the ManagedObjectFunctionBuilder to build a ManagedFunction.

Type Parameters:

O - Dependency key type.

f - Flow key type.

Parameters:

functionName - Name of the ManagedFunction.

managedFunctionFactory - ManagedFunctionFactory to create the ManagedFunction.

Returns:

Specific ManagedObjectFunctionBuilder.

addFunctionDependency

ManagedObjectFunctionDependency addFunctionDependency(java.lang.String name,
                                                      java.lang.Class<?> objectType)

Adds a ManagedObjectFunctionDependency.

Parameters:

name - Name of the ManagedObjectFunctionDependency.

objectType - Object type.

Returns:

ManagedObjectFunctionDependency.

createStartupCompletion

ManagedObjectStartupCompletion createStartupCompletion()

Creates a ManagedObjectStartupCompletion.

Returns:

New ManagedObjectStartupCompletion that must be completed before OfficeFloor servicing.

addStartupFunction

void addStartupFunction(java.lang.String functionName,
                        java.lang.Object parameter)

Adds a ManagedFunction to invoke on start up of the Office.

The ManagedFunction must be registered by this ManagedObjectSource.

Parameters:

functionName - Name of ManagedFunction registered by this ManagedObjectSource.

parameter - Parameter for the ManagedFunction. Typically the parameter will contain any created ManagedObjectStartupCompletion to enable indicating when startup is complete.