Package net.officefloor.frame.internal.structure

Interface ProcessState

All Known Implementing Classes:

ProcessStateImpl

public interface ProcessState

State of a process within the Office.

ProcessState instances can not interact with each other, much like processes within an Operating System can not directly interact (e.g. share process space) with each other.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.Executor	getExecutor()	Obtains the Executor for this ProcessState.
FunctionLoop	getFunctionLoop()	Obtains the FunctionLoop for the ProcessState.
ThreadState	getMainThreadState()	Obtains the main ThreadState for this ProcessState.
ManagedObjectCleanup	getManagedObjectCleanup()	Obtains the ManagedObjectCleanup for this ProcessState.
ManagedObjectContainer	getManagedObjectContainer(int index)	Obtains the ManagedObjectContainer for the input index.
OfficeManager	getOfficeManager()	Obtains the OfficeManager for this ProcessState.
ProcessIdentifier	getProcessIdentifier()	Obtains the ProcessIdentifier for this ProcessState.
ProcessManager	getProcessManager()	Obtains the ProcessManager for this ProcessState.
boolean	isCancelled()	Indicates if the ProcessState has been cancelled.
FunctionState	spawnThreadState(ManagedFunctionMetaData<?,?> managedFunctionMetaData, java.lang.Object parameter, FlowCompletion completion, boolean isEscalationHandlingThreadState)	Spawns a new ThreadState contained in this ProcessState.
FunctionState	threadComplete(ThreadState thread, FunctionState threadCompletion)	Flags that the input ThreadState has complete.

Method Detail

getProcessIdentifier

ProcessIdentifier getProcessIdentifier()

Obtains the ProcessIdentifier for this ProcessState.

Returns:

ProcessIdentifier for this ProcessState.

getProcessManager

ProcessManager getProcessManager()

Obtains the ProcessManager for this ProcessState.

Returns:

ProcessManager for this ProcessState.

getOfficeManager

OfficeManager getOfficeManager()

Obtains the OfficeManager for this ProcessState.

Returns:

OfficeManager for this ProcessState.

getExecutor

java.util.concurrent.Executor getExecutor()

Obtains the Executor for this ProcessState.

Returns:

Executor for this ProcessState.

isCancelled

boolean isCancelled()

Indicates if the ProcessState has been cancelled.

This is only valid after synchronising with this ProcessState (in other words the main ThreadState).

Returns:

true if cancelled - or indeterminate if have not synchronised on ProcessState.

getMainThreadState

ThreadState getMainThreadState()

Obtains the main ThreadState for this ProcessState.

The main ThreadState is used for any ProcessState mutations. This avoids the possibility of data corruption, as only one ThreadState may alter the ProcessState.

Returns:

Main ThreadState for this ProcessState.

spawnThreadState

FunctionState spawnThreadState(ManagedFunctionMetaData<?,?> managedFunctionMetaData,
                               java.lang.Object parameter,
                               FlowCompletion completion,
                               boolean isEscalationHandlingThreadState)

Spawns a new ThreadState contained in this ProcessState.

Parameters:

managedFunctionMetaData - ManagedFunctionMetaData of the initial ManagedFunction within the spawned ThreadState.

parameter - Parameter for the initial ManagedFunction.

completion - Optional FlowCompletion to be notified of completion of the spawned ThreadState.

isEscalationHandlingThreadState - Indicates whether the ThreadState is for Escalation handling.

Returns:

FunctionState to spawn the ThreadState.

threadComplete

FunctionState threadComplete(ThreadState thread,
                             FunctionState threadCompletion)

Flags that the input ThreadState has complete.

Parameters:

thread - ThreadState that has completed.

threadCompletion - Optional FunctionState for the completion of theThreadState. May be null.

Returns:

FunctionState to complete the ThreadState.

getFunctionLoop

FunctionLoop getFunctionLoop()

Obtains the FunctionLoop for the ProcessState.

Returns:

FunctionLoop for the ProcessState.

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.

getManagedObjectCleanup

ManagedObjectCleanup getManagedObjectCleanup()

Obtains the ManagedObjectCleanup for this ProcessState.

Returns:

ManagedObjectCleanup for this ProcessState.