Package net.officefloor.frame.internal.structure

Interface BlockState

All Superinterfaces:

FunctionState, LinkedListSetEntry<FunctionState,Flow>

All Known Subinterfaces:

ManagedFunctionContainer

All Known Implementing Classes:

ManagedFunctionContainerImpl

public interface BlockState
extends FunctionState

Representative of blocks of code to be executed.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
default BlockState	getNextBlockToExecute()	Obtains the next FunctionState to execute.
BlockState	getParallelBlock()	Obtains the parallel BlockState.
default BlockState	getParallelBlockToExecute()	Obtains the parallel BlockState to execute.
BlockState	getParallelOwner()	Obtains the parallel owner BlockState.
BlockState	getSequentialBlock()	Obtains the sequential BlockState.
default void	loadParallelBlock(BlockState parallelBlock)	Loads a parallel BlockState relative to this BlockState within the tree of BlockState instances.
static void	loadParallelOwner(BlockState parallelBlock, BlockState parallelOwner)	Loads the parallel owner to the parallel BlockState.
default void	loadSequentialBlock(BlockState sequentialBlock)	Loads a sequential BlockState relative to this BlockState within the tree of BlockState instances.
void	setParallelBlock(BlockState parallelBlock)	Specifies the parallel BlockState.
void	setParallelOwner(BlockState parallelOwner)	Specifies the parallel owning BlockState.
void	setSequentialBlock(BlockState sequentialBlock)	Specifies the sequential BlockState.

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

cancel, execute, getLinkedListSetOwner, getResponsibleTeam, getThreadState, handleEscalation, isRequireThreadStateSafety

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

getNext, getPrev, setNext, setPrev

Method Detail

setParallelOwner

void setParallelOwner(BlockState parallelOwner)

Specifies the parallel owning BlockState.

Parameters:

parallelOwner - Parallel owning BlockState.

getParallelOwner

BlockState getParallelOwner()

Obtains the parallel owner BlockState.

Returns:

Parallel owner BlockState.

setParallelBlock

void setParallelBlock(BlockState parallelBlock)

Specifies the parallel BlockState.

Parameters:

parallelBlock - Parallel BlockState.

getParallelBlock

BlockState getParallelBlock()

Obtains the parallel BlockState.

Returns:

Parallel BlockState.

setSequentialBlock

void setSequentialBlock(BlockState sequentialBlock)

Specifies the sequential BlockState.

Parameters:

sequentialBlock - Sequential BlockState.

getSequentialBlock

BlockState getSequentialBlock()

Obtains the sequential BlockState.

Returns:

Sequential BlockState.

loadParallelBlock

default void loadParallelBlock(BlockState parallelBlock)

Loads a parallel BlockState relative to this BlockState within the tree of BlockState instances.

Parameters:

parallelBlock - BlockState to load to tree.

loadParallelOwner

static void loadParallelOwner(BlockState parallelBlock,
                              BlockState parallelOwner)

Loads the parallel owner to the parallel BlockState.

Parameters:

parallelBlock - Parallel BlockState.

parallelOwner - Parallel owner.

loadSequentialBlock

default void loadSequentialBlock(BlockState sequentialBlock)

Loads a sequential BlockState relative to this BlockState within the tree of BlockState instances.

Parameters:

sequentialBlock - BlockState to load to tree.

getParallelBlockToExecute

default BlockState getParallelBlockToExecute()

Obtains the parallel BlockState to execute.

This will not include the sequential BlockState instances. Therefore, this provides ability to check if a BlockState should be executed before this BlockState.

Returns:

Parallel BlockState to execute. May be null if no parallel BlockState to execute.

getNextBlockToExecute

default BlockState getNextBlockToExecute()

Obtains the next FunctionState to execute.

Returns:

Next FunctionState to execute. May be null if no further BlockState instances to execute.