Package net.officefloor.frame.internal.structure

Interface FunctionState

All Superinterfaces:

LinkedListSetEntry<FunctionState,Flow>

All Known Subinterfaces:

AssetManager, BlockState, ManagedFunctionContainer, RegisteredGovernance, ThreadProfiler

All Known Implementing Classes:

AbstractDelegateFunctionState, AbstractFunctionState, AssetManagerImpl, LinkedListSetPromise, ManagedFunctionContainerImpl, ThreadProfilerImpl

public interface FunctionState
extends LinkedListSetEntry<FunctionState,Flow>

Node within the graph of FunctionState instances to execute.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
default FunctionState	cancel()	Cancels this FunctionState returning an optional FunctionState to clean up this FunctionState.
FunctionState	execute(FunctionStateContext context)	Executes the FunctionState.
default Flow	getLinkedListSetOwner()	Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
default TeamManagement	getResponsibleTeam()	Obtains the TeamManagement responsible for this FunctionState.
ThreadState	getThreadState()	Obtains the ThreadState for this FunctionState.
default FunctionState	handleEscalation(java.lang.Throwable escalation, EscalationCompletion completion)	Handles Escalation from the ManagedFunction.
default boolean	isRequireThreadStateSafety()	Indicates if the FunctionState requires ThreadState safety.

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

getNext, getPrev, setNext, setPrev

Method Detail

getLinkedListSetOwner

default 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 LinkedListSetEntry<FunctionState,Flow>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

getResponsibleTeam

default TeamManagement getResponsibleTeam()

Obtains the TeamManagement responsible for this FunctionState.

By default, FunctionState may be executed by any TeamManagement.

Returns:

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

getThreadState

ThreadState getThreadState()

Obtains the ThreadState for this FunctionState.

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

Returns:

ThreadState for this FunctionState.

isRequireThreadStateSafety

default boolean isRequireThreadStateSafety()

Indicates if the FunctionState requires ThreadState safety.

Returns:

true should FunctionState require ThreadState safety.

execute

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

Executes the 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.

cancel

default FunctionState cancel()

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

Returns:

Optional clean up FunctionState. May be null.

handleEscalation

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

Handles Escalation from the ManagedFunction.

Parameters:

escalation - Escalation.

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

Returns:

Optional FunctionState to handle the Escalation.