Package net.officefloor.compile.internal.structure

Interface Node

All Known Subinterfaces:

AdministrationNode, BoundManagedObjectNode, DependentObjectNode, EscalationNode, ExecutionStrategyNode, ExecutiveNode, FunctionFlowNode, FunctionNamespaceNode, FunctionObjectNode, GovernanceNode, InputManagedObjectNode, LinkExecutionStrategyNode, LinkFlowNode, LinkObjectNode, LinkOfficeNode, LinkPoolNode, LinkStartAfterNode, LinkStartBeforeNode, LinkStartupAfterNode, LinkStartupBeforeNode, LinkTeamNode, ManagedFunctionNode, ManagedObjectDependencyNode, ManagedObjectExecutionStrategyNode, ManagedObjectExtensionNode, ManagedObjectFlowNode, ManagedObjectFunctionDependencyNode, ManagedObjectNode, ManagedObjectPoolNode, ManagedObjectSourceNode, ManagedObjectTeamNode, ManagingOfficeNode, OfficeFloorNode, OfficeInputNode, OfficeNode, OfficeObjectNode, OfficeOutputNode, OfficeStartNode, OfficeTeamNode, ResponsibleTeamNode, SectionInputNode, SectionNode, SectionObjectNode, SectionOutputNode, SuppliedManagedObjectSourceNode, SupplierNode, SupplierThreadLocalNode, TeamNode

All Known Implementing Classes:

AdministrationNodeImpl, AutoWireStateManagerImpl, EscalationNodeImpl, ExecutionStrategyNodeImpl, ExecutiveNodeImpl, FunctionFlowNodeImpl, FunctionNamespaceNodeImpl, FunctionObjectNodeImpl, GovernanceNodeImpl, InputManagedObjectNodeImpl, ManagedFunctionNodeImpl, ManagedObjectDependencyNodeImpl, ManagedObjectExecutionStrategyNodeImpl, ManagedObjectFlowNodeImpl, ManagedObjectFunctionDependencyNodeImpl, ManagedObjectNodeImpl, ManagedObjectPoolNodeImpl, ManagedObjectSourceNodeImpl, ManagedObjectTeamNodeImpl, ManagingOfficeNodeImpl, OfficeFloorCompiler, OfficeFloorCompilerAdapter, OfficeFloorCompilerImpl, OfficeFloorNodeImpl, OfficeInputNodeImpl, OfficeNodeImpl, OfficeObjectNodeImpl, OfficeOutputNodeImpl, OfficeStartNodeImpl, OfficeTeamNodeImpl, ResponsibleTeamNodeImpl, SectionInputNodeImpl, SectionNodeImpl, SectionObjectNodeImpl, SectionOutputNodeImpl, SuppliedManagedObjectSourceNodeImpl, SupplierNodeImpl, SupplierThreadLocalNodeImpl, TeamNodeImpl

public interface Node

Node within the compilation tree.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
static java.lang.String	escape(java.lang.String name)	Creates an escaped name.
Node[]	getChildNodes()	Obtains the child Node instances.
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.
default java.lang.String	getQualifiedName()	Obtains the qualified name of the Node.
default java.lang.String	getQualifiedName(java.lang.String name)	Obtains the qualified name for child Node.
boolean	isInitialised()	Indicates if the Node has been initialised.
static java.lang.String	qualify(java.lang.String... names)	Creates the qualified name, handling null names.

Method Detail

qualify

static java.lang.String qualify(java.lang.String... names)

Creates the qualified name, handling null names.

Parameters:

names - Names. Entries may be null.

Returns:

Qualified name.

escape

static java.lang.String escape(java.lang.String name)

Creates an escaped name.

Parameters:

name - Name.

Returns:

Escaped name.

getNodeName

java.lang.String getNodeName()

Obtains the name of the Node.

Returns:

Name of the Node.

getNodeType

java.lang.String getNodeType()

Obtains the Node type.

Returns:

Node type.

getLocation

java.lang.String getLocation()

Obtains the location of the Node.

Returns:

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

getParentNode

Node getParentNode()

Obtains the Node containing this Node.

Returns:

Node containing this Node.

getQualifiedName

default java.lang.String getQualifiedName()

Obtains the qualified name of the Node.

Returns:

Qualified name of the Node.

getQualifiedName

default java.lang.String getQualifiedName(java.lang.String name)

Obtains the qualified name for child Node.

Parameters:

name - Name of child Node.

Returns:

Name qualified by this Node.

isInitialised

boolean isInitialised()

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

Returns:

true if initialised.

getChildNodes

Node[] getChildNodes()

Obtains the child Node instances.

Returns:

Child Node instances.