Package net.officefloor.frame.internal.structure

Interface ThreadState

All Superinterfaces:

LinkedListSetEntry<ThreadState,ProcessState>

All Known Implementing Classes:

ThreadStateImpl

public interface ThreadState
extends LinkedListSetEntry<ThreadState,ProcessState>

State of a thread within the ProcessState.

May be used as a LinkedListSetEntry in a list of ThreadState instances for a ProcessState.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
AvoidTeam	avoidTeam(FunctionState function, TeamManagement team)	Runs avoiding the specified Team.
Flow	createFlow(FlowCompletion flowCompletion, EscalationCompletion escalationCompletion)	Creates a Flow contained in this ThreadState.
FunctionState	flowComplete(Flow flow, java.lang.Throwable flowEscalation, EscalationCompletion completion)	Flags that the input Flow has completed.
GovernanceContainer<?>	getGovernanceContainer(int index)	Obtains the GovernanceContainer for the input index.
ManagedObjectContainer	getManagedObjectContainer(int index)	Obtains the ManagedObjectContainer for the input index.
int	getMaximumFunctionChainLength()	Obtains the maximum FunctionState chain length for this ThreadState.
ProcessState	getProcessState()	Obtains the ProcessState of the process containing this ThreadState.
FunctionState	handleEscalation(java.lang.Throwable escalation, EscalationCompletion completion)	Handles the Escalation from a Flow of this ThreadState.
boolean	isAttachedToThread()	Indicates if this ThreadState is attached to the current Thread.
boolean	isGovernanceActive(int index)	Indicates if the Governance is active.
boolean	isThreadStateSafe()	Indicates if changes to the ThreadState are safe on the current Thread.
void	profile(ManagedFunctionLogicMetaData functionMetaData)	Profiles that ManagedObjectContainer is being executed.
FunctionState	registerThreadProfiler()	Obtains the FunctionState to register the ThreadProfiler.
<R,T extends java.lang.Throwable> R	runProcessSafeOperation(ProcessSafeOperation<R,T> operation)	Runs the ProcessSafeOperation.
<R,T extends java.lang.Throwable> R	runThreadSafeOperation(ThreadSafeOperation<R,T> operation)	Run the ThreadSafeOperation.
FunctionState	runWithin(FunctionState function)	Runs the FunctionState within this ThreadState.
FunctionState	then(FunctionState function, FunctionState thenFunction)	Creates FunctionState to execute the chain of the first FunctionState before moving onto execute the chain of the second FunctionState.

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

getLinkedListSetOwner, getNext, getPrev, setNext, setPrev

Method Detail

isAttachedToThread

boolean isAttachedToThread()

Indicates if this ThreadState is attached to the current Thread.

Returns:

true if ThreadState is attached to the current Thread.

isThreadStateSafe

boolean isThreadStateSafe()

Indicates if changes to the ThreadState are safe on the current Thread.

Returns:

true should changes to the ThreadState be safe on the current Thread.

then

FunctionState then(FunctionState function,
                   FunctionState thenFunction)

Creates FunctionState to execute the chain of the first FunctionState before moving onto execute the chain of the second FunctionState.

Parameters:

function - Head of initial FunctionState chain to complete.

thenFunction - Head of the second FunctionState chain to then complete next.

Returns:

FunctionState to execute the chains one after another.

runWithin

FunctionState runWithin(FunctionState function)

Runs the FunctionState within this ThreadState.

Parameters:

function - FunctionState to run within this ThreadState.

Returns:

FunctionState running within this ThreadState.

avoidTeam

AvoidTeam avoidTeam(FunctionState function,
                    TeamManagement team)

Runs avoiding the specified Team.

Parameters:

function - FunctionState to avoid being executed by the specified Team.

team - TeamManagement of Team to avoid.

Returns:

AvoidTeam.

getMaximumFunctionChainLength

int getMaximumFunctionChainLength()

Obtains the maximum FunctionState chain length for this ThreadState.

Once the FunctionState chain has reached this length, it will be broken. (spawned in another Thread). This avoids StackOverflowError issues in FunctionState chain being too large.

Returns:

Maximum FunctionState chain length for this ThreadState.

runThreadSafeOperation

<R,T extends java.lang.Throwable> R runThreadSafeOperation(ThreadSafeOperation<R,T> operation)
                                                          throws T extends java.lang.Throwable

Run the ThreadSafeOperation.

Initially locks are not taken to make the main ThreadState safe. This ensures the ThreadSafeOperation is run under critical section of this ThreadState.

Type Parameters:

R - Return type from ThreadSafeOperation.

T - Possible Escalation from ThreadSafeOperation.

Parameters:

operation - ThreadSafeOperation.

Returns:

Optional return value from ThreadSafeOperation.

Throws:

T - Optional Throwable from ThreadSafeOperation.

T extends java.lang.Throwable

runProcessSafeOperation

<R,T extends java.lang.Throwable> R runProcessSafeOperation(ProcessSafeOperation<R,T> operation)
                                                           throws T extends java.lang.Throwable

Runs the ProcessSafeOperation.

Type Parameters:

R - Return type from ProcessSafeOperation.

T - Possible Escalation from ProcessSafeOperation.

Parameters:

operation - ProcessSafeOperation.

Returns:

Optional return value from ProcessSafeOperation.

Throws:

T - Optional Throwable from ProcessSafeOperation.

T extends java.lang.Throwable

createFlow

Flow createFlow(FlowCompletion flowCompletion,
                EscalationCompletion escalationCompletion)

Creates a Flow contained in this ThreadState.

Parameters:

flowCompletion - Optional FlowCompletion to handle completion of the Flow. May be null.

escalationCompletion - Optional EscalationCompletion to handle completion of Flow and notify Escalation handling complete. May be null.

Returns:

New Flow.

handleEscalation

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

Handles the Escalation from a Flow of this ThreadState.

Parameters:

escalation - Escalation.

completion - Optional EscalationCompletion to be notified of completion of Escalation handling.

Returns:

FunctionState to handle the Escalation.

flowComplete

FunctionState flowComplete(Flow flow,
                           java.lang.Throwable flowEscalation,
                           EscalationCompletion completion)

Flags that the input Flow has completed.

Parameters:

flow - Flow that has completed.

flowEscalation - Possible Escalation from the Flow. May be null.

completion - EscalationCompletion. May be null.

Returns:

Optional FunctionState to complete the Flow.

getProcessState

ProcessState getProcessState()

Obtains the ProcessState of the process containing this ThreadState.

Returns:

ProcessState of the process containing this ThreadState.

getManagedObjectContainer

ManagedObjectContainer getManagedObjectContainer(int index)

Obtains the ManagedObjectContainer for the input index.

Parameters:

index - Index of the ManagedObjectContainer to be returned.

Returns:

ManagedObjectContainer for the index.

getGovernanceContainer

GovernanceContainer<?> getGovernanceContainer(int index)

Obtains the GovernanceContainer for the input index.

Parameters:

index - Index of the GovernanceContainer to be returned.

Returns:

GovernanceContainer for the index only if active. If not active will return null.

isGovernanceActive

boolean isGovernanceActive(int index)

Indicates if the Governance is active.

This provides a quick check and avoids creation of the GovernanceContainer.

Parameters:

index - Index of the Governance to check active.

Returns:

true if the Governance is active.

registerThreadProfiler

FunctionState registerThreadProfiler()

Obtains the FunctionState to register the ThreadProfiler.

Returns:

FunctionState to register the ThreadProfiler. May be null if no ThreadProfiler required.

profile

void profile(ManagedFunctionLogicMetaData functionMetaData)

Profiles that ManagedObjectContainer is being executed.

Parameters:

functionMetaData - ManagedFunctionLogicMetaData of the ManagedFunctionContainer being executed.