Package net.officefloor.frame.impl.execute.managedobject

Class ManagedObjectContainerImpl

java.lang.Object

net.officefloor.frame.impl.execute.managedobject.ManagedObjectContainerImpl

All Implemented Interfaces:

Asset, ManagedObjectContainer

public class ManagedObjectContainerImpl
extends java.lang.Object
implements ManagedObjectContainer, Asset

Container of a ManagedObject.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedObjectContainerImpl(ManagedObject managedObject, ManagedObjectMetaData<D> metaData, ThreadState responsibleThreadState)	Initiate the container with a provided ManagedObject.
ManagedObjectContainerImpl(ManagedObjectMetaData<D> metaData, ThreadState responsibleThreadState)	Initiate the container.

Method Summary

Modifier and Type	Method	Description
void	checkOnAsset(CheckAssetContext context)	Checks on the Asset.
FunctionState	checkReady(ManagedObjectReadyCheck check)	Creates a FunctionState to check if the ManagedObject contained within this ManagedObjectContainer is ready.
<E> FunctionState	extractExtension(ManagedObjectExtensionExtractor<E> extractor, E[] managedObjectExtensions, int extensionIndex, TeamManagement responsibleTeam)	Extracts the ManagedObject extension from the ManagedObject contained in this ManagedObjectContainer.
static ManagedObjectContainer	getManagedObjectContainer(ManagedObjectIndex index, ManagedFunctionContainer managedFunction)	Convenience method to obtain the ManagedObjectContainer.
java.lang.Object	getObject()	Obtains the object being managed by the ManagedObject.
java.lang.Object	getOptionalObject()	Obtains the object only if available, otherwise null.
ThreadState	getOwningThreadState()	Obtains the ThreadState owning this Asset.
ThreadState	getResponsibleThreadState()	Obtains the ThreadState responsible for changes to this ManagedObjectContainer.
FunctionState	loadManagedObject(ManagedFunctionContainer managedFunction)	Creates a FunctionState to load the ManagedObject.
FunctionState	unloadManagedObject()	Creates a FunctionState to unload the ManagedObject.
FunctionState	unregisterGovernance(int governanceIndex)	Unregisters the ManagedObject from Governance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedObjectContainerImpl

public ManagedObjectContainerImpl(ManagedObjectMetaData<D> metaData,
                                  ThreadState responsibleThreadState)

Initiate the container.

Type Parameters:

D - Dependency key type.

Parameters:

metaData - Meta-data of the ManagedObject.

responsibleThreadState - ThreadState responsible for making changes to this ManagedObjectContainer.

ManagedObjectContainerImpl

public ManagedObjectContainerImpl(ManagedObject managedObject,
                                  ManagedObjectMetaData<D> metaData,
                                  ThreadState responsibleThreadState)

Initiate the container with a provided ManagedObject.

Type Parameters:

D - Dependency key type.

Parameters:

managedObject - ManagedObject triggering the ProcessState.

metaData - ManagedObjectMetaData of the ManagedObject.

responsibleThreadState - ThreadState responsible for making changes to this ManagedObjectContainer.

Method Detail

getManagedObjectContainer

public static ManagedObjectContainer getManagedObjectContainer(ManagedObjectIndex index,
                                                               ManagedFunctionContainer managedFunction)

Convenience method to obtain the ManagedObjectContainer.

Parameters:

index - ManagedObjectIndex to identify the ManagedObjectContainer.

managedFunction - ManagedFunctionContainer to specify context for obtaining the ManagedObjectContainer.

Returns:

ManagedObjectContainer.

getResponsibleThreadState

public ThreadState getResponsibleThreadState()

Description copied from interface: ManagedObjectContainer

Obtains the ThreadState responsible for changes to this ManagedObjectContainer.

Specified by:

getResponsibleThreadState in interface ManagedObjectContainer

Returns:

ThreadState responsible for changes to this ManagedObjectContainer.

loadManagedObject

public FunctionState loadManagedObject(ManagedFunctionContainer managedFunction)

Description copied from interface: ManagedObjectContainer

Creates a FunctionState to load the ManagedObject.

Specified by:

loadManagedObject in interface ManagedObjectContainer

Parameters:

managedFunction - ManagedFunctionContainer requiring the ManagedObject.

Returns:

Optional FunctionState to load the ManagedObject. Should this return null, the ManagedFunctionContainer should not then be executed, as it is expecting to wait. This will return the ManagedFunctionContainer when the ManagedObject is loaded.

checkReady

public FunctionState checkReady(ManagedObjectReadyCheck check)

Description copied from interface: ManagedObjectContainer

Creates a FunctionState to check if the ManagedObject contained within this ManagedObjectContainer is ready.

Should the ManagedObject not be ready, then will latch to wait for the ManagedObject to be ready.

Specified by:

checkReady in interface ManagedObjectContainer

Parameters:

check - ManagedObjectReadyCheck.

Returns:

FunctionState to check if the ManagedObject contained within this ManagedObjectContainer is ready.

getObject

public java.lang.Object getObject()

Description copied from interface: ManagedObjectContainer

Obtains the object being managed by the ManagedObject.

Specified by:

getObject in interface ManagedObjectContainer

Returns:

Object being managed by the ManagedObject.

getOptionalObject

public java.lang.Object getOptionalObject()

Description copied from interface: ManagedObjectContainer

Obtains the object only if available, otherwise null.

Specified by:

getOptionalObject in interface ManagedObjectContainer

Returns:

Object being managed by the ManagedObject or null if not yet available.

See Also:

OptionalThreadLocal

extractExtension

public <E> FunctionState extractExtension(ManagedObjectExtensionExtractor<E> extractor,
                                          E[] managedObjectExtensions,
                                          int extensionIndex,
                                          TeamManagement responsibleTeam)

Description copied from interface: ManagedObjectContainer

Extracts the ManagedObject extension from the ManagedObject contained in this ManagedObjectContainer.

Should the ManagedObject not be loaded, then no ManagedObject extension will be loaded.

Specified by:

extractExtension in interface ManagedObjectContainer

Type Parameters:

E - Extension type.

Parameters:

extractor - ManagedObjectExtensionExtractor.

managedObjectExtensions - List to load the ManagedObject extension.

extensionIndex - Index within the ManagedObject extensions array to load the extension.

responsibleTeam - TeamManagement responsible for extracting the extension. May be null to use any Team.

Returns:

FunctionState to load the ManagedObject extension.

unregisterGovernance

public FunctionState unregisterGovernance(int governanceIndex)

Description copied from interface: ManagedObjectContainer

Unregisters the ManagedObject from Governance.

Specified by:

unregisterGovernance in interface ManagedObjectContainer

Parameters:

governanceIndex - Index of the Governance.

Returns:

FunctionState to unregister the ManagedObject from Governance.

unloadManagedObject

public FunctionState unloadManagedObject()

Description copied from interface: ManagedObjectContainer

Creates a FunctionState to unload the ManagedObject.

Specified by:

unloadManagedObject in interface ManagedObjectContainer

Returns:

FunctionState to unload the ManagedObject.

getOwningThreadState

public ThreadState getOwningThreadState()

Description copied from interface: Asset

Obtains the ThreadState owning this Asset.

Specified by:

getOwningThreadState in interface Asset

Returns:

ThreadState owning this Asset.

checkOnAsset

public void checkOnAsset(CheckAssetContext context)

Description copied from interface: Asset

Checks on the Asset.

Specified by:

checkOnAsset in interface Asset

Parameters:

context - CheckAssetContext for checking on the Asset.