Package net.officefloor.compile.spi.officefloor

Interface OfficeFloorDeployer

All Superinterfaces:

SourceIssues

All Known Subinterfaces:

OfficeFloorNode

All Known Implementing Classes:

OfficeFloorNodeImpl

public interface OfficeFloorDeployer
extends SourceIssues

Deploys the OfficeFloor.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
DeployedOffice	addDeployedOffice(java.lang.String officeName, java.lang.String officeSourceClassName, java.lang.String officeLocation)	Adds a DeployedOffice to the OfficeFloor.
DeployedOffice	addDeployedOffice(java.lang.String officeName, OfficeSource officeSource, java.lang.String officeLocation)	Adds a DeployedOffice to the OfficeFloor.
OfficeFloorInputManagedObject	addInputManagedObject(java.lang.String inputManagedObjectName, java.lang.String inputObjectType)	Adds an OfficeFloorInputManagedObject.
OfficeFloorManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, java.lang.String managedObjectPoolSourceClassName)	Adds an OfficeFloorManagedObjectPool.
OfficeFloorManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds an OfficeFloorManagedObjectPool.
OfficeFloorManagedObjectSource	addManagedObjectSource(java.lang.String managedObjectSourceName, java.lang.String managedObjectSourceClassName)	Adds an OfficeFloorManagedObjectSource.
OfficeFloorManagedObjectSource	addManagedObjectSource(java.lang.String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource)	Adds an OfficeFloorManagedObjectSource.
void	addManagedObjectSourceAugmentor(ManagedObjectSourceAugmentor managedObjectSourceAugmentor)	Adds a ManagedObjectSourceAugmentor.
void	addOfficeFloorListener(OfficeFloorListener listener)	Adds an OfficeFloorListener.
OfficeFloorSupplier	addSupplier(java.lang.String supplierName, java.lang.String supplierSourceClassName)	Adds an OfficeFloorSupplier.
OfficeFloorSupplier	addSupplier(java.lang.String supplierName, SupplierSource supplierSource)	Adds an OfficeFloorSupplier.
OfficeFloorTeam	addTeam(java.lang.String teamName, java.lang.String teamSourceClassName)	Adds a OfficeFloorTeam.
OfficeFloorTeam	addTeam(java.lang.String teamName, TeamSource teamSource)	Adds a OfficeFloorTeam.
void	addTeamAugmentor(TeamAugmentor teamAugmentor)	Adds a TeamAugmentor.
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.
DeployedOffice	getDeployedOffice(java.lang.String officeName)	Obtains the DeployedOffice.
DeployedOffice[]	getDeployedOffices()	Obtains the currently added DeployedOffice instances.
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.
OfficeFloorExecutive	setExecutive(java.lang.String executiveSourceClassName)	Sets the OfficeFloorExecutive.
OfficeFloorExecutive	setExecutive(ExecutiveSource executiveSource)	Sets the OfficeFloorExecutive.
void	startAfter(OfficeFloorManagedObjectSource managedObjectSource, java.lang.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, java.lang.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.

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

addIssue, addIssue

Method Detail

enableAutoWireObjects

void enableAutoWireObjects()

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

enableAutoWireTeams

void enableAutoWireTeams()

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

addOfficeFloorListener

void addOfficeFloorListener(OfficeFloorListener listener)

Adds an OfficeFloorListener.

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

Parameters:

listener - OfficeFloorListener.

addManagedObjectSourceAugmentor

void addManagedObjectSourceAugmentor(ManagedObjectSourceAugmentor managedObjectSourceAugmentor)

Adds a ManagedObjectSourceAugmentor.

Parameters:

managedObjectSourceAugmentor - ManagedObjectSourceAugmentor.

addTeamAugmentor

void addTeamAugmentor(TeamAugmentor teamAugmentor)

Adds a TeamAugmentor.

Parameters:

teamAugmentor - TeamAugmentor.

addTeam

OfficeFloorTeam addTeam(java.lang.String teamName,
                        java.lang.String teamSourceClassName)

Adds a OfficeFloorTeam.

Parameters:

teamName - Name of the OfficeFloorTeam.

teamSourceClassName - Fully qualified class name of the TeamSource.

Returns:

Added OfficeFloorTeam.

addTeam

OfficeFloorTeam addTeam(java.lang.String teamName,
                        TeamSource teamSource)

Adds a OfficeFloorTeam.

Parameters:

teamName - Name of the OfficeFloorTeam.

teamSource - TeamSource.

Returns:

Added OfficeFloorTeam.

setExecutive

OfficeFloorExecutive setExecutive(java.lang.String executiveSourceClassName)

Sets the OfficeFloorExecutive.

Parameters:

executiveSourceClassName - Fully qualified class name of the ExecutiveSource.

Returns:

Set OfficeFloorExecutive.

setExecutive

OfficeFloorExecutive setExecutive(ExecutiveSource executiveSource)

Sets the OfficeFloorExecutive.

Parameters:

executiveSource - ExecutiveSource.

Returns:

Set OfficeFloorExecutive.

addManagedObjectSource

OfficeFloorManagedObjectSource addManagedObjectSource(java.lang.String managedObjectSourceName,
                                                      java.lang.String managedObjectSourceClassName)

Adds an OfficeFloorManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource.

Returns:

Added OfficeFloorManagedObjectSource.

addManagedObjectSource

OfficeFloorManagedObjectSource addManagedObjectSource(java.lang.String managedObjectSourceName,
                                                      ManagedObjectSource<?,?> managedObjectSource)

Adds an OfficeFloorManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

Added OfficeFloorManagedObjectSource.

addInputManagedObject

OfficeFloorInputManagedObject addInputManagedObject(java.lang.String inputManagedObjectName,
                                                    java.lang.String inputObjectType)

Adds an OfficeFloorInputManagedObject.

Parameters:

inputManagedObjectName - Name of the OfficeFloorInputManagedObject.

inputObjectType - Input Object type.

Returns:

Added OfficeFloorInputManagedObject.

addManagedObjectPool

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

Adds an OfficeFloorManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the OfficeFloorManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added OfficeFloorManagedObjectPool.

addManagedObjectPool

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

Adds an OfficeFloorManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the OfficeFloorManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

OfficeFloorManagedObjectPool.

addSupplier

OfficeFloorSupplier addSupplier(java.lang.String supplierName,
                                java.lang.String supplierSourceClassName)

Adds an OfficeFloorSupplier.

Parameters:

supplierName - Name of the OfficeFloorSupplier.

supplierSourceClassName - Fully qualified class name of the SupplierSource.

Returns:

OfficeFloorSupplier.

addSupplier

OfficeFloorSupplier addSupplier(java.lang.String supplierName,
                                SupplierSource supplierSource)

Adds an OfficeFloorSupplier.

Parameters:

supplierName - Name of the OfficeFloorSupplier.

supplierSource - SupplierSource instance to use.

Returns:

OfficeFloorSupplier.

addDeployedOffice

DeployedOffice addDeployedOffice(java.lang.String officeName,
                                 java.lang.String officeSourceClassName,
                                 java.lang.String officeLocation)

Adds a DeployedOffice to the OfficeFloor.

Parameters:

officeName - Name of the Office.

officeSourceClassName - Fully qualified class name of the OfficeSource.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

addDeployedOffice

DeployedOffice addDeployedOffice(java.lang.String officeName,
                                 OfficeSource officeSource,
                                 java.lang.String officeLocation)

Adds a DeployedOffice to the OfficeFloor.

Parameters:

officeName - Name of the Office.

officeSource - OfficeSource instance.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

getDeployedOffice

DeployedOffice getDeployedOffice(java.lang.String officeName)

Obtains the DeployedOffice.

Parameters:

officeName - Name of the DeployedOffice.

Returns:

DeployedOffice.

getDeployedOffices

DeployedOffice[] getDeployedOffices()

Obtains the currently added DeployedOffice instances.

Returns:

Currently added DeployedOffice instances.

link

void link(OfficeFloorManagedObjectSource managedObjectSource,
          OfficeFloorInputManagedObject inputManagedObject)

Links the OfficeFloorInputManagedObject to be input by the OfficeFloorManagedObjectSource.

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource.

inputManagedObject - OfficeFloorInputManagedObject.

link

void link(OfficeFloorManagedObjectSource managedObjectSource,
          OfficeFloorManagedObjectPool managedObjectPool)

Links the OfficeFloorManagedObjectSource to be pooled by the OfficeFloorManagedObjectPool.

Parameters:

managedObjectSource - OfficeFloorManagedObject.

managedObjectPool - OfficeFloorManagedObjectPool.

link

void link(OfficeFloorFlowSourceNode flowSourceNode,
          OfficeFloorFlowSinkNode flowSinkNode)

Links the OfficeFloorFlowSourceNode to be undertake by the OfficeFloorFlowSinkNode.

Parameters:

flowSourceNode - OfficeFloorFlowSourceNode.

flowSinkNode - OfficeFloorFlowSinkNode.

link

void link(OfficeFloorDependencyRequireNode dependencyRequireNode,
          OfficeFloorDependencyObjectNode dependencyObjectNode)

Links the OfficeFloorDependencyObjectNode to be fulfilled by the OfficeFloorDependencyObjectNode.

Parameters:

dependencyRequireNode - OfficeFloorDependencyRequireNode.

dependencyObjectNode - OfficeFloorDependencyObjectNode.

link

void link(OfficeFloorResponsibility responsibility,
          OfficeFloorTeam officeFloorTeam)

Links the OfficeFloorResponsibility to the OfficeFloorTeam.

Parameters:

responsibility - OfficeFloorResponsibility.

officeFloorTeam - OfficeFloorTeam.

link

void link(OfficeFloorManagedObjectExecutionStrategy managedObjectExecutionStrategy,
          OfficeFloorExecutionStrategy executionStrategy)

Links the OfficeFloorManagedObjectExecutionStrategy to the OfficeFloorExecutionStrategy.

Parameters:

managedObjectExecutionStrategy - OfficeFloorManagedObjectExecutionStrategy.

executionStrategy - OfficeFloorExecutionStrategy.

link

void link(ManagingOffice managingOffice,
          DeployedOffice office)

Links the ManagingOffice to be managed by the DeployedOffice.

Parameters:

managingOffice - ManagingOffice.

office - DeployedOffice.

startBefore

void startBefore(OfficeFloorManagedObjectSource startEarlier,
                 OfficeFloorManagedObjectSource startLater)

Flags an OfficeFloorManagedObjectSource to be started before another OfficeFloorManagedObjectSource.

Parameters:

startEarlier - OfficeFloorManagedObjectSource to be started up before.

startLater - OfficeFloorManagedObjectSource to be started up afterwards.

startBefore

void startBefore(OfficeFloorManagedObjectSource managedObjectSource,
                 java.lang.String managedObjectTypeName)

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

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

void startAfter(OfficeFloorManagedObjectSource startLater,
                OfficeFloorManagedObjectSource startEarlier)

Flags an OfficeFloorManagedObjectSource to be started after another OfficeFloorManagedObjectSource.

Parameters:

startLater - OfficeFloorManagedObjectSource to be started up afterwards.

startEarlier - OfficeFloorManagedObjectSource to be started up before.

startAfter

void startAfter(OfficeFloorManagedObjectSource managedObjectSource,
                java.lang.String managedObjectTypeName)

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

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.