Package net.officefloor.compile.impl.structure

Class FunctionObjectNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.FunctionObjectNodeImpl

All Implemented Interfaces:

FunctionObjectNode, LinkObjectNode, Node, AugmentedFunctionObject, FunctionObject, SectionDependencyRequireNode

public class FunctionObjectNodeImpl
extends Object
implements FunctionObjectNode

FunctionObjectNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
FunctionObjectNodeImpl(String objectName, ManagedFunctionNode functionNode, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	flagAsParameter()	Flags this FunctionObject as a parameter for the ManagedFunction.
Node[]	getChildNodes()	Obtains the child Node instances.
String	getFunctionObjectName()	Obtains the name of this FunctionObject.
LinkObjectNode	getLinkedObjectNode()	Obtains the LinkObjectNode linked to this LinkObjectNode.
String	getLocation()	Obtains the location of the Node.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
Node	getParentNode()	Obtains the Node containing this Node.
void	initialise()	Initialises the FunctionObjectNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	isLinked()	Indicates if the FunctionObject is already linked.
boolean	isParameter()	Indicates if this FunctionObject is a parameter to the ManagedFunction.
boolean	linkObjectNode(LinkObjectNode node)	Links the input LinkObjectNode to this LinkObjectNode.
ObjectDependencyType	loadObjectDependencyType(CompileContext compileContext)	Loads the ObjectDependencyType.
void	unlink()	Unlinks the FunctionObject from existing link.

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 Details

FunctionObjectNodeImpl

public FunctionObjectNodeImpl(String objectName,
 ManagedFunctionNode functionNode,
 NodeContext context)

Initiate.

Parameters:

objectName - Name of this FunctionObject.

functionNode - ManagedFunctionNode containing this FunctionObjectNode.

context - NodeContext.

Method Details

getNodeName

public 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 String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public 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: FunctionObjectNode

Initialises the FunctionObjectNode.

Specified by:

initialise in interface FunctionObjectNode

isParameter

public boolean isParameter()

Description copied from interface: FunctionObjectNode

Indicates if this FunctionObject is a parameter to the ManagedFunction.

Specified by:

isParameter in interface FunctionObjectNode

Returns:

true if this FunctionObject is a parameter to the ManagedFunction.

loadObjectDependencyType

public ObjectDependencyType loadObjectDependencyType(CompileContext compileContext)

Description copied from interface: FunctionObjectNode

Loads the ObjectDependencyType.

Specified by:

loadObjectDependencyType in interface FunctionObjectNode

Parameters:

compileContext - CompileContext.

Returns:

ObjectDependencyType or null with issue reported to the CompilerIssues.

getFunctionObjectName

public String getFunctionObjectName()

Description copied from interface: AugmentedFunctionObject

Obtains the name of this FunctionObject.

Specified by:

getFunctionObjectName in interface AugmentedFunctionObject

Specified by:

getFunctionObjectName in interface FunctionObject

Returns:

Name of this FunctionObject.

flagAsParameter

public void flagAsParameter()

Description copied from interface: AugmentedFunctionObject

Flags this FunctionObject as a parameter for the ManagedFunction.

Specified by:

flagAsParameter in interface AugmentedFunctionObject

Specified by:

flagAsParameter in interface FunctionObject

isLinked

public boolean isLinked()

Description copied from interface: AugmentedFunctionObject

Indicates if the FunctionObject is already linked.

Specified by:

isLinked in interface AugmentedFunctionObject

Returns:

true if already linked.

unlink

public void unlink()

Description copied from interface: AugmentedFunctionObject

Unlinks the FunctionObject from existing link.

Specified by:

unlink in interface AugmentedFunctionObject

linkObjectNode

public boolean linkObjectNode(LinkObjectNode node)

Description copied from interface: LinkObjectNode

Links the input LinkObjectNode to this LinkObjectNode.

Specified by:

linkObjectNode in interface LinkObjectNode

Parameters:

node - LinkObjectNode to link to this LinkObjectNode.

Returns:

true if linked.

getLinkedObjectNode

public LinkObjectNode getLinkedObjectNode()

Description copied from interface: LinkObjectNode

Obtains the LinkObjectNode linked to this LinkObjectNode.

Specified by:

getLinkedObjectNode in interface LinkObjectNode

Returns:

LinkObjectNode linked to this LinkObjectNode.