Package net.officefloor.frame.impl.execute.flow

Class FlowImpl

java.lang.Object

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

net.officefloor.frame.impl.execute.flow.FlowImpl

All Implemented Interfaces:

Flow, LinkedListSetEntry<Flow,ThreadState>

public class FlowImpl
extends AbstractLinkedListSetEntry<Flow,ThreadState>
implements Flow

Implementation of the Flow.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
FlowImpl(FlowCompletion flowCompletion, EscalationCompletion escalationCompletion, ThreadState threadState)	Initiate.

Method Summary

Modifier and Type	Method	Description
FunctionState	cancel()	Cancels this Flow.
<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>> ManagedFunctionContainer	createAdministrationFunction(ManagedObjectAdministrationMetaData<E,F,G> adminMetaData, ManagedFunctionContainer parallelFunctionOwner)	Creates a new ManagedFunctionContainer contained in this Flow for the ManagedObjectAdministrationMetaData.
FunctionState	createFunction(FunctionLogic logic)	Creates a FunctionState within this Flow for the FunctionLogic.
<F extends java.lang.Enum<F>> ManagedFunctionContainer	createGovernanceFunction(GovernanceActivity<F> governanceActivity, GovernanceMetaData<?,F> governanceMetaData)	Creates a new ManagedFunctionContainer contained in this Flow for the GovernanceActivity.
<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionContainer	createManagedFunction(java.lang.Object parameter, ManagedFunctionMetaData<O,F> managedFunctionMetaData, boolean isEnforceGovernance, BlockState parallelFunctionOwner)	Creates a new managed ManagedFunctionContainer contained in this Flow for the ManagedFunction.
ThreadState	getLinkedListSetOwner()	Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
ThreadState	getThreadState()	Obtains the ThreadState containing this Flow.
FunctionState	managedFunctionComplete(FunctionState function, java.lang.Throwable functionEscalation, EscalationCompletion escalationCompletion)	Flags that the input FunctionState has completed.

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, toString, wait, wait, wait

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

getNext, getPrev, setNext, setPrev

Constructor Detail

FlowImpl

public FlowImpl(FlowCompletion flowCompletion,
                EscalationCompletion escalationCompletion,
                ThreadState threadState)

Initiate.

Parameters:

flowCompletion - FlowCompletion of this Flow.

escalationCompletion - EscalationCompletion for this Flow.

threadState - ThreadState containing this Flow.

Method Detail

getLinkedListSetOwner

public ThreadState 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<Flow,ThreadState>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

createFunction

public FunctionState createFunction(FunctionLogic logic)

Description copied from interface: Flow

Creates a FunctionState within this Flow for the FunctionLogic.

Specified by:

createFunction in interface Flow

Parameters:

logic - FunctionLogic.

Returns:

FunctionState for the FunctionLogic.

createManagedFunction

public <O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionContainer createManagedFunction(java.lang.Object parameter,
                                                                                                                      ManagedFunctionMetaData<O,F> managedFunctionMetaData,
                                                                                                                      boolean isEnforceGovernance,
                                                                                                                      BlockState parallelFunctionOwner)

Description copied from interface: Flow

Creates a new managed ManagedFunctionContainer contained in this Flow for the ManagedFunction.

Specified by:

createManagedFunction in interface Flow

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

parameter - Parameter for the ManagedFunction.

managedFunctionMetaData - ManagedFunctionMetaData for the new ManagedFunction.

isEnforceGovernance - true to enforce Governance on deactivation.

parallelFunctionOwner - BlockState that is the parallel owner of the new ManagedFunction.

Returns:

New ManagedFunctionContainer.

createGovernanceFunction

public <F extends java.lang.Enum<F>> ManagedFunctionContainer createGovernanceFunction(GovernanceActivity<F> governanceActivity,
                                                                                       GovernanceMetaData<?,F> governanceMetaData)

Description copied from interface: Flow

Creates a new ManagedFunctionContainer contained in this Flow for the GovernanceActivity.

Specified by:

createGovernanceFunction in interface Flow

Type Parameters:

F - Flow key type.

Parameters:

governanceActivity - GovernanceActivity.

governanceMetaData - GovernanceMetaData.

Returns:

New ManagedFunctionContainer.

createAdministrationFunction

public <E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>> ManagedFunctionContainer createAdministrationFunction(ManagedObjectAdministrationMetaData<E,F,G> adminMetaData,
                                                                                                                                     ManagedFunctionContainer parallelFunctionOwner)

Description copied from interface: Flow

Creates a new ManagedFunctionContainer contained in this Flow for the ManagedObjectAdministrationMetaData.

Specified by:

createAdministrationFunction in interface Flow

Type Parameters:

E - Extension type.

F - Flow key type.

G - Governance key type.

Parameters:

adminMetaData - ManagedObjectAdministrationMetaData.

parallelFunctionOwner - ManagedFunctionContainer that is the parallel owner of the new ManagedFunction.

Returns:

New ManagedFunctionContainer.

cancel

public FunctionState cancel()

Description copied from interface: Flow

Cancels this Flow.

Specified by:

cancel in interface Flow

Returns:

FunctionState to clean up this Flow.

managedFunctionComplete

public FunctionState managedFunctionComplete(FunctionState function,
                                             java.lang.Throwable functionEscalation,
                                             EscalationCompletion escalationCompletion)

Description copied from interface: Flow

Flags that the input FunctionState has completed.

Specified by:

managedFunctionComplete in interface Flow

Parameters:

function - FunctionState that has completed.

functionEscalation - Possible Escalation from the FunctionState. May be null.

escalationCompletion - Possible EscalationCompletion. May be null.

Returns:

Optional FunctionState to handle completion of the FunctionState.

getThreadState

public ThreadState getThreadState()

Description copied from interface: Flow

Obtains the ThreadState containing this Flow.

Specified by:

getThreadState in interface Flow

Returns:

ThreadState containing this Flow.