Package net.officefloor.frame.impl.execute.function

Class AbstractDelegateFunctionState

java.lang.Object

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

net.officefloor.frame.impl.execute.function.AbstractDelegateFunctionState

All Implemented Interfaces:

FunctionState, LinkedListSetEntry<FunctionState,Flow>

Direct Known Subclasses:

LinkedListSetPromise

public class AbstractDelegateFunctionState
extends AbstractLinkedListSetEntry<FunctionState,Flow>
implements FunctionState

Abstract FunctionState that delegates functionality to a delegate FunctionState.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
protected FunctionState	delegate	Delegate FunctionState.

Constructor Summary

Constructors

Constructor	Description
AbstractDelegateFunctionState(FunctionState delegate)	Instantiate.

Method Summary

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

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

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

getNext, getPrev, setNext, setPrev

Field Detail

delegate

protected final FunctionState delegate

Delegate FunctionState.

Constructor Detail

AbstractDelegateFunctionState

public AbstractDelegateFunctionState(FunctionState delegate)

Instantiate.

Parameters:

delegate - Delegate FunctionState.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLinkedListSetOwner

public 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 FunctionState

Specified by:

getLinkedListSetOwner in interface LinkedListSetEntry<FunctionState,Flow>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

getResponsibleTeam

public TeamManagement getResponsibleTeam()

Description copied from interface: FunctionState

Obtains the TeamManagement responsible for this FunctionState.

By default, FunctionState may be executed by any TeamManagement.

Specified by:

getResponsibleTeam in interface FunctionState

Returns:

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

getThreadState

public ThreadState getThreadState()

Description copied from interface: FunctionState

Obtains the ThreadState for this FunctionState.

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

Specified by:

getThreadState in interface FunctionState

Returns:

ThreadState for this FunctionState.

isRequireThreadStateSafety

public boolean isRequireThreadStateSafety()

Description copied from interface: FunctionState

Indicates if the FunctionState requires ThreadState safety.

Specified by:

isRequireThreadStateSafety in interface FunctionState

Returns:

true should FunctionState require ThreadState safety.

execute

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

Description copied from interface: FunctionState

Executes the FunctionState.

Specified by:

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

public FunctionState cancel()

Description copied from interface: FunctionState

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

Specified by:

cancel in interface FunctionState

Returns:

Optional clean up FunctionState. May be null.

handleEscalation

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

Description copied from interface: FunctionState

Handles Escalation from the ManagedFunction.

Specified by:

handleEscalation in interface FunctionState

Parameters:

escalation - Escalation.

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

Returns:

Optional FunctionState to handle the Escalation.