Package net.officefloor.frame.internal.structure

Interface FunctionLogic

All Known Implementing Classes:

SpawnThreadFunctionLogic, SynchroniseProcessStateFunctionLogic

public interface FunctionLogic

Encapsulates simple logic for a FunctionState.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
FunctionState	execute(Flow flow)	Executes the logic.
default TeamManagement	getResponsibleTeam()	Obtains the responsible TeamManagement for this FunctionLogic.
default boolean	isRequireThreadStateSafety()	Indicates if the FunctionLogic requires ThreadState safety.

Method Details

getResponsibleTeam

default TeamManagement getResponsibleTeam()

Obtains the responsible TeamManagement for this FunctionLogic.

Returns:

TeamManagement responsible for this FunctionLogic. May be null to use any Team.

isRequireThreadStateSafety

default boolean isRequireThreadStateSafety()

Indicates if the FunctionLogic requires ThreadState safety.

Returns:

true should FunctionLogic require ThreadState safety.

execute

FunctionState execute(Flow flow)
               throws Throwable

Executes the logic.

Parameters:

flow - Flow that contains this FunctionLogic.

Returns:

Optional FunctionState to execute next.

Throws:

Throwable - If logic fails.