Package net.officefloor.compile.impl.structure

Class FunctionFlowNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.FunctionFlowNodeImpl

All Implemented Interfaces:

FunctionFlowNode, LinkFlowNode, Node, FunctionFlow

public class FunctionFlowNodeImpl
extends java.lang.Object
implements FunctionFlowNode

FunctionFlowNode implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.compile.internal.structure.FunctionFlowNode

TYPE

Constructor Summary

Constructors

Constructor	Description
FunctionFlowNodeImpl(java.lang.String flowName, boolean isEscalation, ManagedFunctionNode function, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
Node[]	getChildNodes()	Obtains the child Node instances.
java.lang.String	getFunctionFlowName()	Obtains the name of this FunctionFlow.
LinkFlowNode	getLinkedFlowNode()	Obtains the LinkFlowNode linked to this LinkFlowNode.
java.lang.String	getLocation()	Obtains the location of the Node.
java.lang.String	getNodeName()	Obtains the name of the Node.
java.lang.String	getNodeType()	Obtains the Node type.
Node	getParentNode()	Obtains the Node containing this Node.
void	initialise()	Initialises the FunctionFlowNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	isSpawnThreadState()	Indicates whether to spawn a ThreadState for this FunctionFlow.
boolean	linkFlowNode(LinkFlowNode node)	Links the input LinkFlowNode to this LinkFlowNode.
void	setSpawnThreadState(boolean isSpawnThreadState)	Specifies whether to spawn a ThreadState for this FunctionFlow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getQualifiedName, getQualifiedName

Constructor Detail

FunctionFlowNodeImpl

public FunctionFlowNodeImpl(java.lang.String flowName,
                            boolean isEscalation,
                            ManagedFunctionNode function,
                            NodeContext context)

Initiate.

Parameters:

flowName - Name of this FunctionFlow.

isEscalation - Indicates if this FunctionFlow is for a ManagedFunctionEscalationType.

function - Parent ManagedFunctionNode.

context - NodeContext.

Method Detail

getNodeName

public java.lang.String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getNodeType

public java.lang.String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public java.lang.String getLocation()

Description copied from interface: Node

Obtains the location of the Node.

Specified by:

getLocation in interface Node

Returns:

Location of the Node. May be null if Node does not support a location.

getParentNode

public Node getParentNode()

Description copied from interface: Node

Obtains the Node containing this Node.

Specified by:

getParentNode in interface Node

Returns:

Node containing this Node.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

isInitialised

public boolean isInitialised()

Description copied from interface: Node

Indicates if the Node has been initialised. Node instances should only be initialised once. Initialising the Node twice is an issue.

Specified by:

isInitialised in interface Node

Returns:

true if initialised.

initialise

public void initialise()

Description copied from interface: FunctionFlowNode

Initialises the FunctionFlowNode.

Specified by:

initialise in interface FunctionFlowNode

getFunctionFlowName

public java.lang.String getFunctionFlowName()

Description copied from interface: FunctionFlow

Obtains the name of this FunctionFlow.

Specified by:

getFunctionFlowName in interface FunctionFlow

Returns:

Name of this FunctionFlow.

isSpawnThreadState

public boolean isSpawnThreadState()

Description copied from interface: FunctionFlowNode

Indicates whether to spawn a ThreadState for this FunctionFlow.

Specified by:

isSpawnThreadState in interface FunctionFlowNode

Returns:

true to spawn a ThreadState for this FunctionFlow.

setSpawnThreadState

public void setSpawnThreadState(boolean isSpawnThreadState)

Description copied from interface: FunctionFlowNode

Specifies whether to spawn a ThreadState for this FunctionFlow.

Specified by:

setSpawnThreadState in interface FunctionFlowNode

Parameters:

isSpawnThreadState - true to spawn a ThreadState for this FunctionFlow.

linkFlowNode

public boolean linkFlowNode(LinkFlowNode node)

Description copied from interface: LinkFlowNode

Links the input LinkFlowNode to this LinkFlowNode.

Specified by:

linkFlowNode in interface LinkFlowNode

Parameters:

node - LinkFlowNode to link to this LinkFlowNode.

Returns:

true if linked.

getLinkedFlowNode

public LinkFlowNode getLinkedFlowNode()

Description copied from interface: LinkFlowNode

Obtains the LinkFlowNode linked to this LinkFlowNode.

Specified by:

getLinkedFlowNode in interface LinkFlowNode

Returns:

LinkFlowNode linked to this LinkFlowNode.