Package net.officefloor.frame.impl.execute.function

Class ManagedFunctionContainerImpl<M extends ManagedFunctionLogicMetaData>

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<FunctionState,Flow>

net.officefloor.frame.impl.execute.function.ManagedFunctionContainerImpl<M>

All Implemented Interfaces:

BlockState, FunctionState, LinkedListSetEntry<FunctionState,Flow>, ManagedFunctionContainer

public class ManagedFunctionContainerImpl<M extends ManagedFunctionLogicMetaData>
extends AbstractLinkedListSetEntry<FunctionState,Flow>
implements ManagedFunctionContainer

FunctionState to execute a ManagedFunctionLogic.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedFunctionContainerImpl(FunctionState setupFunction, ManagedFunctionLogic managedFunctionLogic, ManagedFunctionBoundManagedObjects boundManagedObjects, ManagedObjectIndex[] requiredManagedObjects, boolean[] requiredGovernance, boolean isEnforceGovernance, M functionLogicMetaData, BlockState parallelOwner, Flow flow, boolean isUnloadManagedObjects)	Initiate.

Method Summary

Modifier and Type	Method	Description
FunctionState	cancel()	Cancels this FunctionState returning an optional FunctionState to clean up this FunctionState.
ManagedFunctionInterest	createInterest()	Creates a ManagedFunctionInterest in this ManagedFunctionContainer.
FunctionState	execute(FunctionStateContext context)	Executes the FunctionState.
Flow	getFlow()	Obtains the Flow containing this ManagedObjectContainer.
Flow	getLinkedListSetOwner()	Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
ManagedObjectContainer	getManagedObjectContainer(int index)	Obtains the ManagedObjectContainer bound to this ManagedFunctionContainer.
BlockState	getParallelBlock()	Obtains the parallel BlockState.
BlockState	getParallelOwner()	Obtains the parallel owner BlockState.
TeamManagement	getResponsibleTeam()	Obtains the TeamManagement responsible for this FunctionState.
BlockState	getSequentialBlock()	Obtains the sequential BlockState.
ThreadState	getThreadState()	Obtains the ThreadState for this FunctionState.
FunctionState	handleEscalation(java.lang.Throwable escalation, EscalationCompletion completion)	Handles Escalation from the ManagedFunction.
boolean	isRequireThreadStateSafety()	Indicates if the FunctionState requires ThreadState safety.
void	setParallelBlock(BlockState parallelBlock)	Specifies the parallel BlockState.
void	setParallelOwner(BlockState parallelOwner)	Specifies the parallel owning BlockState.
void	setSequentialBlock(BlockState sequentialBlock)	Specifies the sequential BlockState.
java.lang.String	toString()

Methods inherited from class net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry

getNext, getPrev, setNext, setPrev

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.internal.structure.BlockState

getNextBlockToExecute, getParallelBlockToExecute, loadParallelBlock, loadSequentialBlock

Methods inherited from interface net.officefloor.frame.internal.structure.LinkedListSetEntry

getNext, getPrev, setNext, setPrev

Constructor Detail

ManagedFunctionContainerImpl

public ManagedFunctionContainerImpl(FunctionState setupFunction,
                                    ManagedFunctionLogic managedFunctionLogic,
                                    ManagedFunctionBoundManagedObjects boundManagedObjects,
                                    ManagedObjectIndex[] requiredManagedObjects,
                                    boolean[] requiredGovernance,
                                    boolean isEnforceGovernance,
                                    M functionLogicMetaData,
                                    BlockState parallelOwner,
                                    Flow flow,
                                    boolean isUnloadManagedObjects)

Initiate.

Parameters:

setupFunction - Optional FunctionState to be executed to setup this ManagedObjectContainer. May be null.

managedFunctionLogic - ManagedFunctionLogic to be executed by this ManagedFunctionContainer.

boundManagedObjects - ManagedFunctionBoundManagedObjects containing the ManagedObjectContainer instances for the ManagedObject instances bound to the ManagedFunction.

requiredManagedObjects - ManagedObjectIndex instances to the ManagedObject instances that must be loaded before the ManagedFunction may be executed.

requiredGovernance - Identifies the required activation state of the Governance for this ManagedFunction.

isEnforceGovernance - true to enforce Governance on deactivation. false to disregard Governance on deactivation.

functionLogicMetaData - ManagedFunctionLogicMetaData for this node.

parallelOwner - Parallel owner of this ManagedFunctionContainer. May be null if no owner.

flow - Flow containing this ManagedFunctionContainer.

isUnloadManagedObjects - Indicates whether this ManagedObjectContainer is responsible for unloading the ManagedObject instances.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLinkedListSetOwner

public Flow getLinkedListSetOwner()

Description copied from interface: LinkedListSetEntry

Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.

LinkedListSetEntry instances may only be added to the LinkedListSet they were intended for and can not be shared between LinkedListSet instances. This constraint:

1. ensures the integrity of the FunctionState, Flow, ThreadState, ProcessState structure, and
2. improves uniqueness performance as LinkedListSetEntry.getNext() and LinkedListSetEntry.getPrev() both returning null indicates not added

Specified by:

getLinkedListSetOwner in interface FunctionState

Specified by:

getLinkedListSetOwner in interface LinkedListSetEntry<FunctionState,Flow>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

setParallelOwner

public void setParallelOwner(BlockState parallelOwner)

Description copied from interface: BlockState

Specifies the parallel owning BlockState.

Specified by:

setParallelOwner in interface BlockState

Parameters:

parallelOwner - Parallel owning BlockState.

getParallelOwner

public BlockState getParallelOwner()

Description copied from interface: BlockState

Obtains the parallel owner BlockState.

Specified by:

getParallelOwner in interface BlockState

Returns:

Parallel owner BlockState.

setParallelBlock

public void setParallelBlock(BlockState parallelBlock)

Description copied from interface: BlockState

Specifies the parallel BlockState.

Specified by:

setParallelBlock in interface BlockState

Parameters:

parallelBlock - Parallel BlockState.

getParallelBlock

public BlockState getParallelBlock()

Description copied from interface: BlockState

Obtains the parallel BlockState.

Specified by:

getParallelBlock in interface BlockState

Returns:

Parallel BlockState.

setSequentialBlock

public void setSequentialBlock(BlockState sequentialBlock)

Description copied from interface: BlockState

Specifies the sequential BlockState.

Specified by:

setSequentialBlock in interface BlockState

Parameters:

sequentialBlock - Sequential BlockState.

getSequentialBlock

public BlockState getSequentialBlock()

Description copied from interface: BlockState

Obtains the sequential BlockState.

Specified by:

getSequentialBlock in interface BlockState

Returns:

Sequential BlockState.

getFlow

public Flow getFlow()

Description copied from interface: ManagedFunctionContainer

Obtains the Flow containing this ManagedObjectContainer.

Specified by:

getFlow in interface ManagedFunctionContainer

Returns:

Flow containing this ManagedObjectContainer.

getManagedObjectContainer

public ManagedObjectContainer getManagedObjectContainer(int index)

Description copied from interface: ManagedFunctionContainer

Obtains the ManagedObjectContainer bound to this ManagedFunctionContainer.

Specified by:

getManagedObjectContainer in interface ManagedFunctionContainer

Parameters:

index - Index of the ManagedObjectContainer.

Returns:

ManagedObjectContainer bound to this ManagedFunctionContainer.

createInterest

public ManagedFunctionInterest createInterest()

Description copied from interface: ManagedFunctionContainer

Creates a ManagedFunctionInterest in this ManagedFunctionContainer.

The ManagedFunctionContainer will not unload its ManagedFunction bound ManagedObject instances until all registered ManagedFunctionInterest instances have been unregistered.

Specified by:

createInterest in interface ManagedFunctionContainer

Returns:

New ManagedFunctionInterest in this ManagedFunctionContainer.

getResponsibleTeam

public TeamManagement getResponsibleTeam()

Description copied from interface: FunctionState

Obtains the TeamManagement responsible for this FunctionState.

By default, FunctionState may be executed by any TeamManagement.

Specified by:

getResponsibleTeam in interface FunctionState

Returns:

TeamManagement responsible for this FunctionState. May be null to indicate any Team may execute the FunctionState.

getThreadState

public ThreadState getThreadState()

Description copied from interface: FunctionState

Obtains the ThreadState for this FunctionState.

This provides access to the ThreadState that this FunctionState resides within.

Specified by:

getThreadState in interface FunctionState

Returns:

ThreadState for this FunctionState.

isRequireThreadStateSafety

public boolean isRequireThreadStateSafety()

Description copied from interface: FunctionState

Indicates if the FunctionState requires ThreadState safety.

Specified by:

isRequireThreadStateSafety in interface FunctionState

Returns:

true should FunctionState require ThreadState safety.

execute

public FunctionState execute(FunctionStateContext context)
                      throws java.lang.Throwable

Description copied from interface: FunctionState

Executes the FunctionState.

Specified by:

execute in interface FunctionState

Parameters:

context - FunctionStateContext for executing the FunctionState.

Returns:

Next FunctionState to be executed. May be null to indicate no further FunctionState instances to execute.

Throws:

java.lang.Throwable - Possible failure of FunctionState logic.

handleEscalation

public FunctionState handleEscalation(java.lang.Throwable escalation,
                                      EscalationCompletion completion)

Description copied from interface: FunctionState

Handles Escalation from the ManagedFunction.

Specified by:

handleEscalation in interface FunctionState

Parameters:

escalation - Escalation.

completion - Optional EscalationCompletion to be notified once Escalation has been handled.

Returns:

Optional FunctionState to handle the Escalation.

cancel

public FunctionState cancel()

Description copied from interface: FunctionState

Cancels this FunctionState returning an optional FunctionState to clean up this FunctionState.

Specified by:

cancel in interface FunctionState

Returns:

Optional clean up FunctionState. May be null.