Package net.officefloor.frame.internal.structure

Interface ThreadStateContext

public interface ThreadStateContext

Context for executing a ThreadState.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
FunctionState	createFunction(FunctionLogic logic, ThreadState fallbackThreadState)	Creates a FunctionState for the FunctionLogic under the current ThreadState.
FunctionState	executeFunction(FunctionState function)	Executes the FunctionState returning the next FunctionState to execute.
void	flagRequiresThreadStateSafety()	Flag the ThreadState requires Thread safety.
ManagedObjectContainer	getManagedObject(ManagedObjectIndex index)	Obtains the ManagedObjectContainer for the ManagedObjectIndex.
boolean	isRequireThreadStateSafety()	Indicates if the ThreadState requires Thread safety.

Method Detail

isRequireThreadStateSafety

boolean isRequireThreadStateSafety()

Indicates if the ThreadState requires Thread safety.

Returns:

true if ThreadState requires Thread safety.

flagRequiresThreadStateSafety

void flagRequiresThreadStateSafety()

Flag the ThreadState requires Thread safety.

createFunction

FunctionState createFunction(FunctionLogic logic,
                             ThreadState fallbackThreadState)

Creates a FunctionState for the FunctionLogic under the current ThreadState.

Parameters:

logic - FunctionLogic.

fallbackThreadState - Fall back ThreadState should there be no current ThreadState.

Returns:

FunctionState for the FunctionLogic.

executeFunction

FunctionState executeFunction(FunctionState function)
                       throws java.lang.Throwable

Executes the FunctionState returning the next FunctionState to execute.

Parameters:

function - FunctionState to be executed.

Returns:

Next FunctionState to be executed. May be null.

Throws:

java.lang.Throwable - Possible failure in executing the FunctionState.

getManagedObject

ManagedObjectContainer getManagedObject(ManagedObjectIndex index)

Obtains the ManagedObjectContainer for the ManagedObjectIndex.

Parameters:

index - ManagedObjectIndex.

Returns:

ManagedObjectContainer. May be null if not yet instantiated.