Package net.officefloor.compile.internal.structure

Interface OfficeFloorNode

All Superinterfaces:

ManagedObjectRegistry, Node, OfficeFloorDeployer, OverrideProperties, PropertyConfigurable, SourceIssues

All Known Implementing Classes:

OfficeFloorNodeImpl

public interface OfficeFloorNode
extends Node, PropertyConfigurable, OverrideProperties, ManagedObjectRegistry, OfficeFloorDeployer

OfficeFloor node.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OFFICE_FLOOR_NAME	Default name of the OfficeFloorNode.
static final String	TYPE	Node type.

Method Summary

Modifier and Type	Method	Description
<O, M extends InputManagedObject> ExternalServiceInputFactory<O,M>	addExternalServiceInputFactory(Class<O> objectType, String typeQualifier, Class<M> managedObjectType, OfficeNode managingOffice)	Obtains the ExternalServiceInputFactory.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject)	Adds a OfficeFloorManagedObjectSource supplied from an OfficeFloorSupplier.
OfficeFloor	deployOfficeFloor(String officeFloorName, OfficeFloorBuilder officeFloorBuilder, CompileContext compileContext)	Deploys the OfficeFloor.
AvailableType[]	getAvailableTypes(CompileContext compileContext)	Obtains the AvailableType instances.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances.
OfficeFloorListener[]	getOfficeFloorListeners()	Obtains the OfficeFloorDeployer configured OfficeFloorListener instances.
void	initialise()	Initialises the OfficeFloorNode.
boolean	isDefaultExecutionStrategy()	Indicates if default ExecutionStrategy is being used.
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.
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.

Methods inherited from interface net.officefloor.compile.internal.structure.ManagedObjectRegistry

addManagedObjectNode, getManagedObjectNode

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialised

Methods inherited from interface net.officefloor.compile.spi.officefloor.OfficeFloorDeployer

addDeployedOffice, addDeployedOffice, addInputManagedObject, addManagedObjectPool, addManagedObjectPool, addManagedObjectSource, addManagedObjectSource, addManagedObjectSourceAugmentor, addOfficeFloorListener, addSupplier, addSupplier, addTeam, addTeam, addTeamAugmentor, enableAutoWireObjects, enableAutoWireTeams, getDeployedOffice, getDeployedOffices, link, link, link, link, link, link, link, setExecutive, setExecutive, startAfter, startAfter, startBefore, startBefore

Methods inherited from interface net.officefloor.compile.internal.structure.OverrideProperties

getOverridePropertyList

Methods inherited from interface net.officefloor.compile.properties.PropertyConfigurable

addProperty

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

addIssue, addIssue

Field Details

OFFICE_FLOOR_NAME

static final String OFFICE_FLOOR_NAME

Default name of the OfficeFloorNode.

See Also:

• Constant Field Values

TYPE

static final String TYPE

Node type.

See Also:

• Constant Field Values

Method Details

initialise

void initialise()

Initialises the OfficeFloorNode.

addExternalServiceInputFactory

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

Obtains the ExternalServiceInputFactory.

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

OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
 SuppliedManagedObjectSourceNode suppliedManagedObject)

Adds a OfficeFloorManagedObjectSource supplied from an OfficeFloorSupplier.

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

suppliedManagedObject - SuppliedManagedObjectSourceNode to supply the OfficeFloorManagedObjectSource.

Returns:

OfficeFloorManagedObjectSource.

sourceOfficeFloor

boolean sourceOfficeFloor(CompileContext compileContext)

Sources the OfficeFloor into this OfficeFloorNode.

This will only source the top level OfficeSection.

Parameters:

compileContext - CompileContext.

Returns:

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

sourceOfficeFloorTree

boolean sourceOfficeFloorTree(AutoWirerVisitor autoWirerVisitor,
 CompileContext compileContext)

Sources this OfficeFloorNode and all its descendant Node instances recursively.

Parameters:

autoWirerVisitor - AutoWirerVisitor.

compileContext - CompileContext.

Returns:

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

getAvailableTypes

AvailableType[] getAvailableTypes(CompileContext compileContext)

Obtains the AvailableType instances.

Parameters:

compileContext - CompileContext.

Returns:

AvailableType instances.

loadAutoWireObjectTargets

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

Loads the AutoWire targets for the OfficeFloorManagedObject instances.

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeFloorManagedObject targets.

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireManagedObjectSourceTargets

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

Loads the AutoWire targets for the ManagedObjectSourceNode instances.

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeFloorManagedObjectSource targets.

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireExtensionTargets

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

Loads the AutoWire extension targets for the OfficeFloorManagedObject.

Parameters:

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

compileContext - CompileContext.

Returns:

AutoWirer with context for the OfficeFloor.

loadAutoWireTeamTargets

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

Loads the AutoWire targets for the OfficeFloorTeam instances.

Parameters:

autoWirer - AutoWire to be loaded with the OfficeFloorTeam targets.

officeTeamRegistry - OfficeTeamRegistry.

compileContext - CompileContext.

loadOfficeFloorType

OfficeFloorType loadOfficeFloorType(CompileContext compileContext)

Loads the OfficeFloorType.

Parameters:

compileContext - CompileContext.

Returns:

true if the OfficeFloorType was loaded.

getOfficeFloorListeners

OfficeFloorListener[] getOfficeFloorListeners()

Obtains the OfficeFloorDeployer configured OfficeFloorListener instances.

Returns:

OfficeFloorDeployer configured OfficeFloorListener instances.

isDefaultExecutionStrategy

boolean isDefaultExecutionStrategy()

Indicates if default ExecutionStrategy is being used.

Returns:

true if default ExecutionStrategy is being used.

deployOfficeFloor

OfficeFloor deployOfficeFloor(String officeFloorName,
 OfficeFloorBuilder officeFloorBuilder,
 CompileContext compileContext)

Deploys the OfficeFloor.

Parameters:

officeFloorName - Name of the OfficeFloor.

officeFloorBuilder - OfficeFloorBuilder to build the deployed OfficeFloor.

compileContext - CompileContext.

Returns:

OfficeFloor.

loadExternalServicing

void loadExternalServicing(OfficeFloor officeFloor)
                    throws UnknownOfficeException,
UnknownFunctionException

Loads the FunctionManager instances to externally trigger this OfficeFloorNode.

Parameters:

officeFloor - OfficeFloor for this OfficeFloorNode.

Throws:

UnknownOfficeException - UnknownOfficeException.

UnknownFunctionException - UnknownFunctionException.

getInternalSuppliers

InternalSupplier[] getInternalSuppliers()

Obtains the InternalSupplier instances.

Returns:

InternalSupplier instances.