Package net.officefloor.compile.impl.structure

Class OfficeFloorNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.OfficeFloorNodeImpl

All Implemented Interfaces:

ManagedObjectRegistry, ManagedObjectSourceVisitor, Node, OfficeFloorNode, OverrideProperties, TeamVisitor, SourceIssues, PropertyConfigurable, OfficeFloorDeployer

public class OfficeFloorNodeImpl
extends Object
implements OfficeFloorNode, ManagedObjectSourceVisitor, TeamVisitor

OfficeFloorNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

OFFICE_FLOOR_NAME, TYPE

Constructor Summary

Constructors

Constructor	Description
OfficeFloorNodeImpl(String officeFloorSourceClassName, OfficeFloorSource officeFloorSource, String officeFloorLocation, NodeContext context, Map<String,Profiler> profilers)	Initiate.

Method Summary

Modifier and Type	Method	Description
DeployedOffice	addDeployedOffice(String officeName, String officeSourceClassName, String officeLocation)	Adds a DeployedOffice to the OfficeFloor.
DeployedOffice	addDeployedOffice(String officeName, OfficeSource officeSource, String officeLocation)	Adds a DeployedOffice to the OfficeFloor.
<O, M extends InputManagedObject> ExternalServiceInputFactory<O,M>	addExternalServiceInputFactory(Class<O> objectType, String typeQualifier, Class<M> managedObjectType, OfficeNode managingOffice)	Obtains the ExternalServiceInputFactory.
OfficeFloorInputManagedObject	addInputManagedObject(String inputManagedObjectName, String inputObjectType)	Adds an OfficeFloorInputManagedObject.
CompileError	addIssue(String issueDescription)	Allows the source to add an issue.
CompileError	addIssue(String issueDescription, Throwable cause)	Allows the source to add an issue along with its cause.
ManagedObjectNode	addManagedObjectNode(String managedObjectName, ManagedObjectScope managedObjectScope, ManagedObjectSourceNode managedObjectSourceNode)	Adds an initialised ManagedObjectNode to the registry.
OfficeFloorManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, String managedObjectPoolSourceClassName)	Adds an OfficeFloorManagedObjectPool.
OfficeFloorManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds an OfficeFloorManagedObjectPool.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, String managedObjectSourceClassName)	Adds an OfficeFloorManagedObjectSource.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject)	Adds a OfficeFloorManagedObjectSource supplied from an OfficeFloorSupplier.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource)	Adds an OfficeFloorManagedObjectSource.
void	addManagedObjectSourceAugmentor(ManagedObjectSourceAugmentor managedObjectSourceAugmentor)	Adds a ManagedObjectSourceAugmentor.
void	addOfficeFloorListener(OfficeFloorListener listener)	Adds an OfficeFloorListener.
void	addProperty(String name, String value)	Adds a Property to configure the item.
OfficeFloorSupplier	addSupplier(String supplierName, String supplierSourceClassName)	Adds an OfficeFloorSupplier.
OfficeFloorSupplier	addSupplier(String supplierName, SupplierSource supplierSource)	Adds an OfficeFloorSupplier.
OfficeFloorTeam	addTeam(String teamName, String teamSourceClassName)	Adds a OfficeFloorTeam.
OfficeFloorTeam	addTeam(String teamName, TeamSource teamSource)	Adds a OfficeFloorTeam.
void	addTeamAugmentor(TeamAugmentor teamAugmentor)	Adds a TeamAugmentor.
OfficeFloor	deployOfficeFloor(String officeFloorName, OfficeFloorBuilder builder, CompileContext compileContext)	Deploys the OfficeFloor.
void	enableAutoWireObjects()	Flags to attempt to auto wire any non-configured object links.
void	enableAutoWireTeams()	Flags to attempt to auto wire any non-configured Team links.
AvailableType[]	getAvailableTypes(CompileContext compileContext)	Obtains the AvailableType instances.
Node[]	getChildNodes()	Obtains the child Node instances.
DeployedOffice	getDeployedOffice(String officeName)	Obtains the DeployedOffice.
DeployedOffice[]	getDeployedOffices()	Obtains the currently added DeployedOffice instances.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances.
String	getLocation()	Obtains the location of the Node.
ManagedObjectNode	getManagedObjectNode(String managedObjectName)	Obtains the ManagedObjectNode from the registry.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
OfficeFloorListener[]	getOfficeFloorListeners()	Obtains the OfficeFloorDeployer configured OfficeFloorListener instances.
PropertyList	getOverridePropertyList()	Obtains the override PropertyList.
Node	getParentNode()	Obtains the Node containing this Node.
String	getQualifiedName(String name)	Obtains the qualified name for child Node.
void	initialise()	Initialises the OfficeFloorNode.
boolean	isDefaultExecutionStrategy()	Indicates if default ExecutionStrategy is being used.
boolean	isInitialised()	Indicates if the Node has been initialised.
void	link(ManagingOffice managingOffice, DeployedOffice office)	Links the ManagingOffice to be managed by the DeployedOffice.
void	link(OfficeFloorDependencyRequireNode dependencyRequireNode, OfficeFloorDependencyObjectNode dependencyObjectNode)	Links the OfficeFloorDependencyObjectNode to be fulfilled by the OfficeFloorDependencyObjectNode.
void	link(OfficeFloorFlowSourceNode flowSourceNode, OfficeFloorFlowSinkNode flowSinkNode)	Links the OfficeFloorFlowSourceNode to be undertake by the OfficeFloorFlowSinkNode.
void	link(OfficeFloorManagedObjectExecutionStrategy managedObjectExecutionStrategy, OfficeFloorExecutionStrategy executionStrategy)	Links the OfficeFloorManagedObjectExecutionStrategy to the OfficeFloorExecutionStrategy.
void	link(OfficeFloorManagedObjectSource managedObjectSource, OfficeFloorInputManagedObject inputManagedObject)	Links the OfficeFloorInputManagedObject to be input by the OfficeFloorManagedObjectSource.
void	link(OfficeFloorManagedObjectSource managedObjectSource, OfficeFloorManagedObjectPool managedObjectPool)	Links the OfficeFloorManagedObjectSource to be pooled by the OfficeFloorManagedObjectPool.
void	link(OfficeFloorResponsibility responsibility, OfficeFloorTeam officeFloorTeam)	Links the OfficeFloorResponsibility to the OfficeFloorTeam.
AutoWirer<ManagedObjectExtensionNode>	loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer, CompileContext compileContext)	Loads the AutoWire extension targets for the OfficeFloorManagedObject.
AutoWirer<ManagedObjectSourceNode>	loadAutoWireManagedObjectSourceTargets(AutoWirer<ManagedObjectSourceNode> autoWirer, CompileContext compileContext)	Loads the AutoWire targets for the ManagedObjectSourceNode instances.
AutoWirer<LinkObjectNode>	loadAutoWireObjectTargets(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext)	Loads the AutoWire targets for the OfficeFloorManagedObject instances.
void	loadAutoWireTeamTargets(AutoWirer<LinkTeamNode> autoWirer, OfficeTeamRegistry officeTeamRegistry, CompileContext compileContext)	Loads the AutoWire targets for the OfficeFloorTeam instances.
void	loadExternalServicing(OfficeFloor officeFloor)	Loads the FunctionManager instances to externally trigger this OfficeFloorNode.
OfficeFloorType	loadOfficeFloorType(CompileContext compileContext)	Loads the OfficeFloorType.
OfficeFloorExecutive	setExecutive(String executiveSourceClassName)	Sets the OfficeFloorExecutive.
OfficeFloorExecutive	setExecutive(ExecutiveSource executiveSource)	Sets the OfficeFloorExecutive.
boolean	sourceOfficeFloor(CompileContext compileContext)	Sources the OfficeFloor into this OfficeFloorNode.
boolean	sourceOfficeFloorTree(AutoWirerVisitor autoWirerVisitor, CompileContext compileContext)	Sources this OfficeFloorNode and all its descendant Node instances recursively.
void	startAfter(OfficeFloorManagedObjectSource managedObjectSource, String managedObjectTypeName)	Flags an OfficeFloorManagedObjectSource to be started after ManagedObjectSource instances providing the type.
void	startAfter(OfficeFloorManagedObjectSource startLater, OfficeFloorManagedObjectSource startEarlier)	Flags an OfficeFloorManagedObjectSource to be started after another OfficeFloorManagedObjectSource.
void	startBefore(OfficeFloorManagedObjectSource managedObjectSource, String managedObjectTypeName)	Flags an OfficeFloorManagedObjectSource to be started before ManagedObjectSource instances providing the type.
void	startBefore(OfficeFloorManagedObjectSource startEarlier, OfficeFloorManagedObjectSource startLater)	Flags an OfficeFloorManagedObjectSource to be started before another OfficeFloorManagedObjectSource.
void	visit(ManagedObjectType<?> managedObjectType, ManagedObjectSourceNode managedObjectSourceNode, CompileContext compileContext)	Visits the ManagedObjectSourceNode.
void	visit(TeamType teamType, TeamNode teamNode, CompileContext compileContext)	Visits the TeamNode.

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

Constructor Details

OfficeFloorNodeImpl

public OfficeFloorNodeImpl(String officeFloorSourceClassName,
 OfficeFloorSource officeFloorSource,
 String officeFloorLocation,
 NodeContext context,
 Map<String,Profiler> profilers)

Initiate.

Parameters:

officeFloorSourceClassName - OfficeFloorSource class name.

officeFloorSource - Optional instantiated OfficeFloorSource. May be null.

officeFloorLocation - Location of the OfficeFloor.

context - NodeContext.

profilers - Mapping of Profiler by their Office name.

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.

getQualifiedName

public String getQualifiedName(String name)

Description copied from interface: Node

Obtains the qualified name for child Node.

Specified by:

getQualifiedName in interface Node

Parameters:

name - Name of child Node.

Returns:

Name qualified by 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: OfficeFloorNode

Initialises the OfficeFloorNode.

Specified by:

initialise in interface OfficeFloorNode

getOverridePropertyList

public PropertyList getOverridePropertyList()

Description copied from interface: OverrideProperties

Obtains the override PropertyList.

Specified by:

getOverridePropertyList in interface OverrideProperties

Returns:

Override PropertyList.

visit

public void visit(ManagedObjectType<?> managedObjectType,
 ManagedObjectSourceNode managedObjectSourceNode,
 CompileContext compileContext)

Description copied from interface: ManagedObjectSourceVisitor

Visits the ManagedObjectSourceNode.

Specified by:

visit in interface ManagedObjectSourceVisitor

Parameters:

managedObjectType - ManagedObjectType.

managedObjectSourceNode - ManagedObjectSourceNode.

compileContext - CompileContext.

visit

public void visit(TeamType teamType,
 TeamNode teamNode,
 CompileContext compileContext)

Description copied from interface: TeamVisitor

Visits the TeamNode.

Specified by:

visit in interface TeamVisitor

Parameters:

teamType - TeamType.

teamNode - TeamNode.

compileContext - CompileContext.

getManagedObjectNode

public ManagedObjectNode getManagedObjectNode(String managedObjectName)

Description copied from interface: ManagedObjectRegistry

Obtains the ManagedObjectNode from the registry.

The returned ManagedObjectNode may or may not be initialised.

Specified by:

getManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

Returns:

ManagedObjectNode from the registry.

addManagedObjectNode

public ManagedObjectNode addManagedObjectNode(String managedObjectName,
 ManagedObjectScope managedObjectScope,
 ManagedObjectSourceNode managedObjectSourceNode)

Description copied from interface: ManagedObjectRegistry

Adds an initialised ManagedObjectNode to the registry.

Should an ManagedObjectNode already be added by the name, then an issue is reported to the CompilerIssue.

Specified by:

addManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

managedObjectScope - ManagedObjectScope.

managedObjectSourceNode - ManagedObjectSourceNode for the ManagedObjectNode.

Returns:

Initialised ManagedObjectNode by the name.

enableAutoWireObjects

public void enableAutoWireObjects()

Description copied from interface: OfficeFloorDeployer

Flags to attempt to auto wire any non-configured object links.

Specified by:

enableAutoWireObjects in interface OfficeFloorDeployer

enableAutoWireTeams

public void enableAutoWireTeams()

Description copied from interface: OfficeFloorDeployer

Flags to attempt to auto wire any non-configured Team links.

Specified by:

enableAutoWireTeams in interface OfficeFloorDeployer

addOfficeFloorListener

public void addOfficeFloorListener(OfficeFloorListener listener)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorListener.

This enables external services to operate in the open/close life-cycle of OfficeFloor.

Specified by:

addOfficeFloorListener in interface OfficeFloorDeployer

Parameters:

listener - OfficeFloorListener.

addManagedObjectSourceAugmentor

public void addManagedObjectSourceAugmentor(ManagedObjectSourceAugmentor managedObjectSourceAugmentor)

Description copied from interface: OfficeFloorDeployer

Adds a ManagedObjectSourceAugmentor.

Specified by:

addManagedObjectSourceAugmentor in interface OfficeFloorDeployer

Parameters:

managedObjectSourceAugmentor - ManagedObjectSourceAugmentor.

addTeamAugmentor

public void addTeamAugmentor(TeamAugmentor teamAugmentor)

Description copied from interface: OfficeFloorDeployer

Adds a TeamAugmentor.

Specified by:

addTeamAugmentor in interface OfficeFloorDeployer

Parameters:

teamAugmentor - TeamAugmentor.

addManagedObjectSource

public OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
 String managedObjectSourceClassName)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorManagedObjectSource.

Specified by:

addManagedObjectSource in interface OfficeFloorDeployer

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource.

Returns:

Added OfficeFloorManagedObjectSource.

addManagedObjectSource

public OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
 ManagedObjectSource<?,?> managedObjectSource)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorManagedObjectSource.

Specified by:

addManagedObjectSource in interface OfficeFloorDeployer

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

Added OfficeFloorManagedObjectSource.

addInputManagedObject

public OfficeFloorInputManagedObject addInputManagedObject(String inputManagedObjectName,
 String inputObjectType)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorInputManagedObject.

Specified by:

addInputManagedObject in interface OfficeFloorDeployer

Parameters:

inputManagedObjectName - Name of the OfficeFloorInputManagedObject.

inputObjectType - Input Object type.

Returns:

Added OfficeFloorInputManagedObject.

addManagedObjectPool

public OfficeFloorManagedObjectPool addManagedObjectPool(String managedObjectPoolName,
 String managedObjectPoolSourceClassName)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorManagedObjectPool.

Specified by:

addManagedObjectPool in interface OfficeFloorDeployer

Parameters:

managedObjectPoolName - Name of the OfficeFloorManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added OfficeFloorManagedObjectPool.

addManagedObjectPool

public OfficeFloorManagedObjectPool addManagedObjectPool(String managedObjectPoolName,
 ManagedObjectPoolSource managedObjectPoolSource)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorManagedObjectPool.

Specified by:

addManagedObjectPool in interface OfficeFloorDeployer

Parameters:

managedObjectPoolName - Name of the OfficeFloorManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

OfficeFloorManagedObjectPool.

addSupplier

public OfficeFloorSupplier addSupplier(String supplierName,
 String supplierSourceClassName)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorSupplier.

Specified by:

addSupplier in interface OfficeFloorDeployer

Parameters:

supplierName - Name of the OfficeFloorSupplier.

supplierSourceClassName - Fully qualified class name of the SupplierSource.

Returns:

OfficeFloorSupplier.

addSupplier

public OfficeFloorSupplier addSupplier(String supplierName,
 SupplierSource supplierSource)

Description copied from interface: OfficeFloorDeployer

Adds an OfficeFloorSupplier.

Specified by:

addSupplier in interface OfficeFloorDeployer

Parameters:

supplierName - Name of the OfficeFloorSupplier.

supplierSource - SupplierSource instance to use.

Returns:

OfficeFloorSupplier.

addTeam

public OfficeFloorTeam addTeam(String teamName,
 String teamSourceClassName)

Description copied from interface: OfficeFloorDeployer

Adds a OfficeFloorTeam.

Specified by:

addTeam in interface OfficeFloorDeployer

Parameters:

teamName - Name of the OfficeFloorTeam.

teamSourceClassName - Fully qualified class name of the TeamSource.

Returns:

Added OfficeFloorTeam.

addTeam

public OfficeFloorTeam addTeam(String teamName,
 TeamSource teamSource)

Description copied from interface: OfficeFloorDeployer

Adds a OfficeFloorTeam.

Specified by:

addTeam in interface OfficeFloorDeployer

Parameters:

teamName - Name of the OfficeFloorTeam.

teamSource - TeamSource.

Returns:

Added OfficeFloorTeam.

setExecutive

public OfficeFloorExecutive setExecutive(String executiveSourceClassName)

Description copied from interface: OfficeFloorDeployer

Sets the OfficeFloorExecutive.

Specified by:

setExecutive in interface OfficeFloorDeployer

Parameters:

executiveSourceClassName - Fully qualified class name of the ExecutiveSource.

Returns:

Set OfficeFloorExecutive.

setExecutive

public OfficeFloorExecutive setExecutive(ExecutiveSource executiveSource)

Description copied from interface: OfficeFloorDeployer

Sets the OfficeFloorExecutive.

Specified by:

setExecutive in interface OfficeFloorDeployer

Parameters:

executiveSource - ExecutiveSource.

Returns:

Set OfficeFloorExecutive.

addDeployedOffice

public DeployedOffice addDeployedOffice(String officeName,
 OfficeSource officeSource,
 String officeLocation)

Description copied from interface: OfficeFloorDeployer

Adds a DeployedOffice to the OfficeFloor.

Specified by:

addDeployedOffice in interface OfficeFloorDeployer

Parameters:

officeName - Name of the Office.

officeSource - OfficeSource instance.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

addDeployedOffice

public DeployedOffice addDeployedOffice(String officeName,
 String officeSourceClassName,
 String officeLocation)

Description copied from interface: OfficeFloorDeployer

Adds a DeployedOffice to the OfficeFloor.

Specified by:

addDeployedOffice in interface OfficeFloorDeployer

Parameters:

officeName - Name of the Office.

officeSourceClassName - Fully qualified class name of the OfficeSource.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

getDeployedOffice

public DeployedOffice getDeployedOffice(String officeName)

Description copied from interface: OfficeFloorDeployer

Obtains the DeployedOffice.

Specified by:

getDeployedOffice in interface OfficeFloorDeployer

Parameters:

officeName - Name of the DeployedOffice.

Returns:

DeployedOffice.

getDeployedOffices

public DeployedOffice[] getDeployedOffices()

Description copied from interface: OfficeFloorDeployer

Obtains the currently added DeployedOffice instances.

Specified by:

getDeployedOffices in interface OfficeFloorDeployer

Returns:

Currently added DeployedOffice instances.

link

public void link(OfficeFloorManagedObjectSource managedObjectSource,
 OfficeFloorInputManagedObject inputManagedObject)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorInputManagedObject to be input by the OfficeFloorManagedObjectSource.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource.

inputManagedObject - OfficeFloorInputManagedObject.

link

public void link(OfficeFloorManagedObjectSource managedObjectSource,
 OfficeFloorManagedObjectPool managedObjectPool)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorManagedObjectSource to be pooled by the OfficeFloorManagedObjectPool.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

managedObjectSource - OfficeFloorManagedObject.

managedObjectPool - OfficeFloorManagedObjectPool.

link

public void link(OfficeFloorFlowSourceNode flowSourceNode,
 OfficeFloorFlowSinkNode flowSinkNode)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorFlowSourceNode to be undertake by the OfficeFloorFlowSinkNode.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

flowSourceNode - OfficeFloorFlowSourceNode.

flowSinkNode - OfficeFloorFlowSinkNode.

link

public void link(OfficeFloorDependencyRequireNode dependencyRequireNode,
 OfficeFloorDependencyObjectNode dependencyObjectNode)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorDependencyObjectNode to be fulfilled by the OfficeFloorDependencyObjectNode.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

dependencyRequireNode - OfficeFloorDependencyRequireNode.

dependencyObjectNode - OfficeFloorDependencyObjectNode.

link

public void link(OfficeFloorResponsibility responsibility,
 OfficeFloorTeam officeFloorTeam)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorResponsibility to the OfficeFloorTeam.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

responsibility - OfficeFloorResponsibility.

officeFloorTeam - OfficeFloorTeam.

link

public void link(OfficeFloorManagedObjectExecutionStrategy managedObjectExecutionStrategy,
 OfficeFloorExecutionStrategy executionStrategy)

Description copied from interface: OfficeFloorDeployer

Links the OfficeFloorManagedObjectExecutionStrategy to the OfficeFloorExecutionStrategy.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

managedObjectExecutionStrategy - OfficeFloorManagedObjectExecutionStrategy.

executionStrategy - OfficeFloorExecutionStrategy.

link

public void link(ManagingOffice managingOffice,
 DeployedOffice office)

Description copied from interface: OfficeFloorDeployer

Links the ManagingOffice to be managed by the DeployedOffice.

Specified by:

link in interface OfficeFloorDeployer

Parameters:

managingOffice - ManagingOffice.

office - DeployedOffice.

startBefore

public void startBefore(OfficeFloorManagedObjectSource startEarlier,
 OfficeFloorManagedObjectSource startLater)

Description copied from interface: OfficeFloorDeployer

Flags an OfficeFloorManagedObjectSource to be started before another OfficeFloorManagedObjectSource.

Specified by:

startBefore in interface OfficeFloorDeployer

Parameters:

startEarlier - OfficeFloorManagedObjectSource to be started up before.

startLater - OfficeFloorManagedObjectSource to be started up afterwards.

startBefore

public void startBefore(OfficeFloorManagedObjectSource managedObjectSource,
 String managedObjectTypeName)

Description copied from interface: OfficeFloorDeployer

Flags an OfficeFloorManagedObjectSource to be started before ManagedObjectSource instances providing the type.

Specified by:

startBefore in interface OfficeFloorDeployer

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource to be started up before.

managedObjectTypeName - Fully qualified type name of ManagedObject object type for the ManagedObjectSource to be started up afterwards.

startAfter

public void startAfter(OfficeFloorManagedObjectSource startLater,
 OfficeFloorManagedObjectSource startEarlier)

Description copied from interface: OfficeFloorDeployer

Flags an OfficeFloorManagedObjectSource to be started after another OfficeFloorManagedObjectSource.

Specified by:

startAfter in interface OfficeFloorDeployer

Parameters:

startLater - OfficeFloorManagedObjectSource to be started up afterwards.

startEarlier - OfficeFloorManagedObjectSource to be started up before.

startAfter

public void startAfter(OfficeFloorManagedObjectSource managedObjectSource,
 String managedObjectTypeName)

Description copied from interface: OfficeFloorDeployer

Flags an OfficeFloorManagedObjectSource to be started after ManagedObjectSource instances providing the type.

Specified by:

startAfter in interface OfficeFloorDeployer

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource to be started up after.

managedObjectTypeName - Fully qualified type name of ManagedObject object type for the ManagedObjectSource to be started up beforehand.

addIssue

public CompileError addIssue(String issueDescription)

Description copied from interface: SourceIssues

Allows the source to add an issue.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

addIssue

public CompileError addIssue(String issueDescription,
 Throwable cause)

Description copied from interface: SourceIssues

Allows the source to add an issue along with its cause.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

cause - Cause of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

addProperty

public void addProperty(String name,
 String value)

Description copied from interface: PropertyConfigurable

Adds a Property to configure the item.

Specified by:

addProperty in interface PropertyConfigurable

Parameters:

name - Name of Property.

value - Value of Property.

addExternalServiceInputFactory

public <O,
M extends InputManagedObject>
ExternalServiceInputFactory<O,M> addExternalServiceInputFactory(Class<O> objectType,
 String typeQualifier,
 Class<M> managedObjectType,
 OfficeNode managingOffice)

Description copied from interface: OfficeFloorNode

Obtains the ExternalServiceInputFactory.

Specified by:

addExternalServiceInputFactory in interface OfficeFloorNode

Type Parameters:

O - Object Type.

M - ManagedObject type.

Parameters:

objectType - Object Type.

typeQualifier - Type qualifier for the ManagedObject.

managedObjectType - ManagedObject type.

managingOffice - Managing OfficeNode.

Returns:

ExternalServiceInputFactory.

addManagedObjectSource

public OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
 SuppliedManagedObjectSourceNode suppliedManagedObject)

Description copied from interface: OfficeFloorNode

Adds a OfficeFloorManagedObjectSource supplied from an OfficeFloorSupplier.

Specified by:

addManagedObjectSource in interface OfficeFloorNode

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

suppliedManagedObject - SuppliedManagedObjectSourceNode to supply the OfficeFloorManagedObjectSource.

Returns:

OfficeFloorManagedObjectSource.

sourceOfficeFloor

public boolean sourceOfficeFloor(CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Sources the OfficeFloor into this OfficeFloorNode.

This will only source the top level OfficeSection.

Specified by:

sourceOfficeFloor in interface OfficeFloorNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

sourceOfficeFloorTree

public boolean sourceOfficeFloorTree(AutoWirerVisitor autoWirerVisitor,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Sources this OfficeFloorNode and all its descendant Node instances recursively.

Specified by:

sourceOfficeFloorTree in interface OfficeFloorNode

Parameters:

autoWirerVisitor - AutoWirerVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

getAvailableTypes

public AvailableType[] getAvailableTypes(CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Obtains the AvailableType instances.

Specified by:

getAvailableTypes in interface OfficeFloorNode

Parameters:

compileContext - CompileContext.

Returns:

AvailableType instances.

loadAutoWireObjectTargets

public AutoWirer<LinkObjectNode> loadAutoWireObjectTargets(AutoWirer<LinkObjectNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Loads the AutoWire targets for the OfficeFloorManagedObject instances.

Specified by:

loadAutoWireObjectTargets in interface OfficeFloorNode

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeFloorManagedObject targets.

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireManagedObjectSourceTargets

public AutoWirer<ManagedObjectSourceNode> loadAutoWireManagedObjectSourceTargets(AutoWirer<ManagedObjectSourceNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Loads the AutoWire targets for the ManagedObjectSourceNode instances.

Specified by:

loadAutoWireManagedObjectSourceTargets in interface OfficeFloorNode

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeFloorManagedObjectSource targets.

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireExtensionTargets

public AutoWirer<ManagedObjectExtensionNode> loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Loads the AutoWire extension targets for the OfficeFloorManagedObject.

Specified by:

loadAutoWireExtensionTargets in interface OfficeFloorNode

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeFloorManagedObject extension targets.

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireTeamTargets

public void loadAutoWireTeamTargets(AutoWirer<LinkTeamNode> autoWirer,
 OfficeTeamRegistry officeTeamRegistry,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Loads the AutoWire targets for the OfficeFloorTeam instances.

Specified by:

loadAutoWireTeamTargets in interface OfficeFloorNode

Parameters:

autoWirer - AutoWire to be loaded with the OfficeFloorTeam targets.

officeTeamRegistry - OfficeTeamRegistry.

compileContext - CompileContext.

loadOfficeFloorType

public OfficeFloorType loadOfficeFloorType(CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Loads the OfficeFloorType.

Specified by:

loadOfficeFloorType in interface OfficeFloorNode

Parameters:

compileContext - CompileContext.

Returns:

true if the OfficeFloorType was loaded.

getOfficeFloorListeners

public OfficeFloorListener[] getOfficeFloorListeners()

Description copied from interface: OfficeFloorNode

Obtains the OfficeFloorDeployer configured OfficeFloorListener instances.

Specified by:

getOfficeFloorListeners in interface OfficeFloorNode

Returns:

OfficeFloorDeployer configured OfficeFloorListener instances.

isDefaultExecutionStrategy

public boolean isDefaultExecutionStrategy()

Description copied from interface: OfficeFloorNode

Indicates if default ExecutionStrategy is being used.

Specified by:

isDefaultExecutionStrategy in interface OfficeFloorNode

Returns:

true if default ExecutionStrategy is being used.

deployOfficeFloor

public OfficeFloor deployOfficeFloor(String officeFloorName,
 OfficeFloorBuilder builder,
 CompileContext compileContext)

Description copied from interface: OfficeFloorNode

Deploys the OfficeFloor.

Specified by:

deployOfficeFloor in interface OfficeFloorNode

Parameters:

officeFloorName - Name of the OfficeFloor.

builder - OfficeFloorBuilder to build the deployed OfficeFloor.

compileContext - CompileContext.

Returns:

OfficeFloor.

loadExternalServicing

public void loadExternalServicing(OfficeFloor officeFloor)
                           throws UnknownOfficeException,
UnknownFunctionException

Description copied from interface: OfficeFloorNode

Loads the FunctionManager instances to externally trigger this OfficeFloorNode.

Specified by:

loadExternalServicing in interface OfficeFloorNode

Parameters:

officeFloor - OfficeFloor for this OfficeFloorNode.

Throws:

UnknownOfficeException - UnknownOfficeException.

UnknownFunctionException - UnknownFunctionException.

getInternalSuppliers

public InternalSupplier[] getInternalSuppliers()

Description copied from interface: OfficeFloorNode

Obtains the InternalSupplier instances.

Specified by:

getInternalSuppliers in interface OfficeFloorNode

Returns:

InternalSupplier instances.