Package net.officefloor.compile.spi.section

Interface SectionDesigner

All Superinterfaces:

SourceIssues

All Known Subinterfaces:

SectionNode

All Known Implementing Classes:

SectionNodeImpl, TransformSectionDesigner

public interface SectionDesigner
extends SourceIssues

Designer to design the SectionNode.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
SectionManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, java.lang.String managedObjectPoolSourceClassName)	Adds an SectionManagedObjectPool.
SectionManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds a SectionManagedObjectPool.
SectionFunctionNamespace	addSectionFunctionNamespace(java.lang.String functionNamespaceName, java.lang.String managedFunctionSourceClassName)	Adds a SectionFunctionNamespace to the SectionNode being built.
SectionFunctionNamespace	addSectionFunctionNamespace(java.lang.String functionNamespaceName, ManagedFunctionSource managedFunctionSource)	Adds a SectionFunctionNamespace to the SectionNode being built.
SectionInput	addSectionInput(java.lang.String inputName, java.lang.String parameterType)	Adds a SectionInput to the SectionNode being built.
SectionManagedObjectSource	addSectionManagedObjectSource(java.lang.String managedObjectSourceName, java.lang.String managedObjectSourceClassName)	Adds a SectionManagedObjectSource to the SectionNode being built.
SectionManagedObjectSource	addSectionManagedObjectSource(java.lang.String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource)	Adds a SectionManagedObjectSource to the SectionNode being built.
SectionObject	addSectionObject(java.lang.String objectName, java.lang.String objectType)	Adds a SectionObject to the SectionNode being built.
SectionOutput	addSectionOutput(java.lang.String outputName, java.lang.String argumentType, boolean isEscalationOnly)	Adds a SectionOutput to the SectionNode being built.
SubSection	addSubSection(java.lang.String subSectionName, java.lang.String sectionSourceClassName, java.lang.String location)	Adds a SubSection to the SectionNode being built.
SubSection	addSubSection(java.lang.String subSectionName, SectionSource sectionSource, java.lang.String location)	Adds a SubSection to the SectionNode being built.
void	link(FunctionFlow functionFlow, SectionFlowSinkNode sectionSinkNode, boolean isSpawnThreadState)	Links the FunctionFlow to be undertaken by the SectionFlowSinkNode.
void	link(SectionDependencyRequireNode dependencyRequireNode, SectionDependencyObjectNode dependencyObjectNode)	Links the SectionDependencyRequireNode to be fulfilled by the SectionDependencyObjectNode.
void	link(SectionFlowSourceNode flowSourceNode, SectionFlowSinkNode flowSinkNode)	Links the SectionFlowSourceNode to undertaken by the SectionFlowSinkNode.
void	link(SectionManagedObjectSource managedObjectSource, SectionManagedObjectPool managedObjectPool)	Links the SectionManagedObjectSource to be pooled by the SectionManagedObjectPool.

Methods inherited from interface net.officefloor.compile.issues.SourceIssues

addIssue, addIssue

Method Detail

addSectionInput

SectionInput addSectionInput(java.lang.String inputName,
                             java.lang.String parameterType)

Adds a SectionInput to the SectionNode being built.

Parameters:

inputName - Name of the SectionInput.

parameterType - Parameter type for the SectionInputType.

Returns:

SectionInput for linking.

addSectionOutput

SectionOutput addSectionOutput(java.lang.String outputName,
                               java.lang.String argumentType,
                               boolean isEscalationOnly)

Adds a SectionOutput to the SectionNode being built.

Parameters:

outputName - Name of the SectionOutput.

argumentType - Argument type for the SectionOutputType.

isEscalationOnly - true if only ManagedFunctionEscalationType instances are using the SectionOutputType.

Returns:

SectionOutput for linking.

addSectionObject

SectionObject addSectionObject(java.lang.String objectName,
                               java.lang.String objectType)

Adds a SectionObject to the SectionNode being built.

Parameters:

objectName - Name of the SectionObject.

objectType - Type required for the SectionObjectType.

Returns:

SectionObject for linking.

addSectionFunctionNamespace

SectionFunctionNamespace addSectionFunctionNamespace(java.lang.String functionNamespaceName,
                                                     java.lang.String managedFunctionSourceClassName)

Adds a SectionFunctionNamespace to the SectionNode being built.

Parameters:

functionNamespaceName - Name of the SectionFunctionNamespace.

managedFunctionSourceClassName - Fully qualified class name of the ManagedFunctionSource. This allows adding the SectionFunctionNamespace without having to worry if the ManagedFunctionSource is available on the class path.

Returns:

SectionFunctionNamespace.

addSectionFunctionNamespace

SectionFunctionNamespace addSectionFunctionNamespace(java.lang.String functionNamespaceName,
                                                     ManagedFunctionSource managedFunctionSource)

Adds a SectionFunctionNamespace to the SectionNode being built.

Parameters:

functionNamespaceName - Name of the SectionFunctionNamespace.

managedFunctionSource - ManagedFunctionSource instance to use.

Returns:

SectionFunctionNamespace.

addSectionManagedObjectSource

SectionManagedObjectSource addSectionManagedObjectSource(java.lang.String managedObjectSourceName,
                                                         java.lang.String managedObjectSourceClassName)

Adds a SectionManagedObjectSource to the SectionNode being built.

Parameters:

managedObjectSourceName - Name of the SectionManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource. This allows adding the SectionManagedObject without having to worry if the ManagedObjectSource is available on the class path.

Returns:

SectionManagedObject.

addSectionManagedObjectSource

SectionManagedObjectSource addSectionManagedObjectSource(java.lang.String managedObjectSourceName,
                                                         ManagedObjectSource<?,?> managedObjectSource)

Adds a SectionManagedObjectSource to the SectionNode being built.

Parameters:

managedObjectSourceName - Name of the SectionManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

SectionManagedObject.

addManagedObjectPool

SectionManagedObjectPool addManagedObjectPool(java.lang.String managedObjectPoolName,
                                              java.lang.String managedObjectPoolSourceClassName)

Adds an SectionManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the SectionManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added SectionManagedObjectPool.

addManagedObjectPool

SectionManagedObjectPool addManagedObjectPool(java.lang.String managedObjectPoolName,
                                              ManagedObjectPoolSource managedObjectPoolSource)

Adds a SectionManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the SectionManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

SectionManagedObjectPool.

addSubSection

SubSection addSubSection(java.lang.String subSectionName,
                         java.lang.String sectionSourceClassName,
                         java.lang.String location)

Adds a SubSection to the SectionNode being built.

Parameters:

subSectionName - Name of the SubSection.

sectionSourceClassName - Fully qualified class name of the SectionSource for the SubSection. This allows adding the SubSection without having to worry if the SectionSource is available on the class path. This should be used over attempting to find the SectionSource - as should leave to the compiler to find the SectionSource.

location - Location of the SubSection.

Returns:

SubSection.

addSubSection

SubSection addSubSection(java.lang.String subSectionName,
                         SectionSource sectionSource,
                         java.lang.String location)

Adds a SubSection to the SectionNode being built.

Parameters:

subSectionName - Name of the SubSection.

sectionSource - SectionSource to enable providing direct instances. This should only be used should the SectionSource want to create a SubSection instance by supplying its own instantiated SectionSource implementation.

location - Location of the SubSection.

Returns:

SubSection.

link

void link(SectionManagedObjectSource managedObjectSource,
          SectionManagedObjectPool managedObjectPool)

Links the SectionManagedObjectSource to be pooled by the SectionManagedObjectPool.

Parameters:

managedObjectSource - SectionManagedObjectSource.

managedObjectPool - SectionManagedObjectPool.

link

void link(FunctionFlow functionFlow,
          SectionFlowSinkNode sectionSinkNode,
          boolean isSpawnThreadState)

Links the FunctionFlow to be undertaken by the SectionFlowSinkNode.

Parameters:

functionFlow - FunctionFlow.

sectionSinkNode - SectionFlowSinkNode.

isSpawnThreadState - Indicates if spawns ThreadState for Flow.

link

void link(SectionFlowSourceNode flowSourceNode,
          SectionFlowSinkNode flowSinkNode)

Links the SectionFlowSourceNode to undertaken by the SectionFlowSinkNode.

Parameters:

flowSourceNode - SectionFlowSourceNode.

flowSinkNode - SectionFlowSinkNode.

link

void link(SectionDependencyRequireNode dependencyRequireNode,
          SectionDependencyObjectNode dependencyObjectNode)

Links the SectionDependencyRequireNode to be fulfilled by the SectionDependencyObjectNode.

Parameters:

dependencyRequireNode - SectionDependencyRequireNode.

dependencyObjectNode - SectionDependencyObjectNode.