Package net.officefloor.frame.internal.structure

Interface ManagedObjectContainer

All Known Implementing Classes:

ManagedObjectContainerImpl

public interface ManagedObjectContainer

Container managing a ManagedObject.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
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.
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	getResponsibleThreadState()	Obtains the ThreadState responsible for changes to this ManagedObjectContainer.
FunctionState	loadManagedObject(ManagedFunctionContainer managedFunctionContainer)	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.

Method Detail

getResponsibleThreadState

ThreadState getResponsibleThreadState()

Obtains the ThreadState responsible for changes to this ManagedObjectContainer.

Returns:

ThreadState responsible for changes to this ManagedObjectContainer.

loadManagedObject

FunctionState loadManagedObject(ManagedFunctionContainer managedFunctionContainer)

Creates a FunctionState to load the ManagedObject.

Parameters:

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

FunctionState checkReady(ManagedObjectReadyCheck check)

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.

Parameters:

check - ManagedObjectReadyCheck.

Returns:

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

extractExtension

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

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

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

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.

getObject

java.lang.Object getObject()

Obtains the object being managed by the ManagedObject.

Returns:

Object being managed by the ManagedObject.

getOptionalObject

java.lang.Object getOptionalObject()

Obtains the object only if available, otherwise null.

Returns:

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

See Also:

OptionalThreadLocal

unregisterGovernance

FunctionState unregisterGovernance(int governanceIndex)

Unregisters the ManagedObject from Governance.

Parameters:

governanceIndex - Index of the Governance.

Returns:

FunctionState to unregister the ManagedObject from Governance.

unloadManagedObject

FunctionState unloadManagedObject()

Creates a FunctionState to unload the ManagedObject.

Returns:

FunctionState to unload the ManagedObject.