Package net.officefloor.frame.impl.execute.process

Class ProcessStateImpl

java.lang.Object

net.officefloor.frame.impl.execute.process.ProcessStateImpl

All Implemented Interfaces:

ProcessState

public class ProcessStateImpl
extends java.lang.Object
implements ProcessState

Implementation of the ProcessState.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ProcessStateImpl(ProcessMetaData processMetaData, OfficeMetaData officeMetaData, FlowCallback callback, ThreadState callbackThreadState, ThreadLocalAwareExecutor threadLocalAwareExecutor, Profiler profiler, java.util.function.Consumer<ProcessState> initialSetup)	Initiate.
ProcessStateImpl(ProcessMetaData processMetaData, OfficeMetaData officeMetaData, FlowCallback callback, ThreadState callbackThreadState, ThreadLocalAwareExecutor threadLocalAwareExecutor, Profiler profiler, ManagedObject inputManagedObject, ManagedObjectMetaData<?> inputManagedObjectMetaData, int inputManagedObjectIndex, java.util.function.Consumer<ProcessState> initialSetup)	Initiate for a ProcessState initiated by a ManagedObject.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessStateImpl

public ProcessStateImpl(ProcessMetaData processMetaData,
                        OfficeMetaData officeMetaData,
                        FlowCallback callback,
                        ThreadState callbackThreadState,
                        ThreadLocalAwareExecutor threadLocalAwareExecutor,
                        Profiler profiler,
                        java.util.function.Consumer<ProcessState> initialSetup)

Initiate.

Parameters:

processMetaData - ProcessMetaData for this ProcessState.

officeMetaData - OfficeMetaData.

callback - Optional FlowCallback. May be null.

callbackThreadState - Optional FlowCallback ThreadState. May be null.

threadLocalAwareExecutor - ThreadLocalAwareExecutor.

profiler - Optional Profiler. May be null.

initialSetup - Initial setup with ProcessState before the ProcessState initialises.

ProcessStateImpl

public ProcessStateImpl(ProcessMetaData processMetaData,
                        OfficeMetaData officeMetaData,
                        FlowCallback callback,
                        ThreadState callbackThreadState,
                        ThreadLocalAwareExecutor threadLocalAwareExecutor,
                        Profiler profiler,
                        ManagedObject inputManagedObject,
                        ManagedObjectMetaData<?> inputManagedObjectMetaData,
                        int inputManagedObjectIndex,
                        java.util.function.Consumer<ProcessState> initialSetup)

Initiate for a ProcessState initiated by a ManagedObject.

Parameters:

processMetaData - ProcessMetaData for this ProcessState.

officeMetaData - OfficeMetaData.

callback - Optional FlowCallback. May be null.

callbackThreadState - Optional FlowCallback ThreadState. May be null.

threadLocalAwareExecutor - ThreadLocalAwareExecutor.

profiler - Optional Profiler. May be null.

inputManagedObject - ManagedObject that invoked this ProcessState. May be null.

inputManagedObjectMetaData - ManagedObjectMetaData of the input ManagedObject. Should the input ManagedObject be provided this must be also provided.

inputManagedObjectIndex - Index of the input ManagedObject within this ProcessState.

initialSetup - Initial setup with ProcessState before the ProcessState initialises.

Method Detail

getProcessIdentifier

public ProcessIdentifier getProcessIdentifier()

Description copied from interface: ProcessState

Obtains the ProcessIdentifier for this ProcessState.

Specified by:

getProcessIdentifier in interface ProcessState

Returns:

ProcessIdentifier for this ProcessState.

getProcessManager

public ProcessManager getProcessManager()

Description copied from interface: ProcessState

Obtains the ProcessManager for this ProcessState.

Specified by:

getProcessManager in interface ProcessState

Returns:

ProcessManager for this ProcessState.

getOfficeManager

public OfficeManager getOfficeManager()

Description copied from interface: ProcessState

Obtains the OfficeManager for this ProcessState.

Specified by:

getOfficeManager in interface ProcessState

Returns:

OfficeManager for this ProcessState.

getExecutor

public java.util.concurrent.Executor getExecutor()

Description copied from interface: ProcessState

Obtains the Executor for this ProcessState.

Specified by:

getExecutor in interface ProcessState

Returns:

Executor for this ProcessState.

isCancelled

public boolean isCancelled()

Description copied from interface: ProcessState

Indicates if the ProcessState has been cancelled.

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

Specified by:

isCancelled in interface ProcessState

Returns:

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

getMainThreadState

public ThreadState getMainThreadState()

Description copied from interface: ProcessState

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.

Specified by:

getMainThreadState in interface ProcessState

Returns:

Main ThreadState for this ProcessState.

getManagedObjectCleanup

public ManagedObjectCleanup getManagedObjectCleanup()

Description copied from interface: ProcessState

Obtains the ManagedObjectCleanup for this ProcessState.

Specified by:

getManagedObjectCleanup in interface ProcessState

Returns:

ManagedObjectCleanup for this ProcessState.

spawnThreadState

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

Description copied from interface: ProcessState

Spawns a new ThreadState contained in this ProcessState.

Specified by:

spawnThreadState in interface 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

public FunctionState threadComplete(ThreadState thread,
                                    FunctionState threadCompletion)

Description copied from interface: ProcessState

Flags that the input ThreadState has complete.

Specified by:

threadComplete in interface ProcessState

Parameters:

thread - ThreadState that has completed.

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

Returns:

FunctionState to complete the ThreadState.

getManagedObjectContainer

public ManagedObjectContainer getManagedObjectContainer(int index)

Description copied from interface: ProcessState

Obtains the ManagedObjectContainer for the input index.

Specified by:

getManagedObjectContainer in interface ProcessState

Parameters:

index - Index of the ManagedObjectContainer to be returned.

Returns:

ManagedObjectContainer for the index.

getFunctionLoop

public FunctionLoop getFunctionLoop()

Description copied from interface: ProcessState

Obtains the FunctionLoop for the ProcessState.

Specified by:

getFunctionLoop in interface ProcessState

Returns:

FunctionLoop for the ProcessState.