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
FieldsModifier and TypeFieldDescriptionstatic final StringDefault name of theOfficeFloorNode.static final StringNodetype. -
Method Summary
Modifier and TypeMethodDescription<O,M extends InputManagedObject>
ExternalServiceInputFactory<O,M> addExternalServiceInputFactory(Class<O> objectType, String typeQualifier, Class<M> managedObjectType, OfficeNode managingOffice) Obtains theExternalServiceInputFactory.addManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject) Adds aOfficeFloorManagedObjectSourcesupplied from anOfficeFloorSupplier.deployOfficeFloor(String officeFloorName, OfficeFloorBuilder officeFloorBuilder, CompileContext compileContext) Deploys theOfficeFloor.getAvailableTypes(CompileContext compileContext) Obtains theAvailableTypeinstances.Obtains theInternalSupplierinstances.Obtains theOfficeFloorDeployerconfiguredOfficeFloorListenerinstances.voidInitialises theOfficeFloorNode.booleanIndicates if defaultExecutionStrategyis being used.loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer, CompileContext compileContext) Loads theAutoWireextension targets for theOfficeFloorManagedObject.loadAutoWireManagedObjectSourceTargets(AutoWirer<ManagedObjectSourceNode> autoWirer, CompileContext compileContext) Loads theAutoWiretargets for theManagedObjectSourceNodeinstances.loadAutoWireObjectTargets(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext) Loads theAutoWiretargets for theOfficeFloorManagedObjectinstances.voidloadAutoWireTeamTargets(AutoWirer<LinkTeamNode> autoWirer, OfficeTeamRegistry officeTeamRegistry, CompileContext compileContext) Loads theAutoWiretargets for theOfficeFloorTeaminstances.voidloadExternalServicing(OfficeFloor officeFloor) Loads theFunctionManagerinstances to externally trigger thisOfficeFloorNode.loadOfficeFloorType(CompileContext compileContext) Loads theOfficeFloorType.booleansourceOfficeFloor(CompileContext compileContext) Sources theOfficeFloorinto thisOfficeFloorNode.booleansourceOfficeFloorTree(AutoWirerVisitor autoWirerVisitor, CompileContext compileContext) Sources thisOfficeFloorNodeand all its descendantNodeinstances recursively.Methods inherited from interface net.officefloor.compile.internal.structure.ManagedObjectRegistry
addManagedObjectNode, getManagedObjectNodeMethods inherited from interface net.officefloor.compile.internal.structure.Node
getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialisedMethods 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, startBeforeMethods inherited from interface net.officefloor.compile.internal.structure.OverrideProperties
getOverridePropertyListMethods inherited from interface net.officefloor.compile.properties.PropertyConfigurable
addPropertyMethods inherited from interface net.officefloor.compile.issues.SourceIssues
addIssue, addIssue
-
Field Details
-
OFFICE_FLOOR_NAME
Default name of theOfficeFloorNode.- See Also:
-
TYPE
Nodetype.- See Also:
-
-
Method Details
-
initialise
void initialise()Initialises theOfficeFloorNode. -
addExternalServiceInputFactory
<O,M extends InputManagedObject> ExternalServiceInputFactory<O,M> addExternalServiceInputFactory(Class<O> objectType, String typeQualifier, Class<M> managedObjectType, OfficeNode managingOffice) Obtains theExternalServiceInputFactory.- Type Parameters:
O- Object Type.M-ManagedObjecttype.- Parameters:
objectType- Object Type.typeQualifier- Type qualifier for theManagedObject.managedObjectType-ManagedObjecttype.managingOffice- ManagingOfficeNode.- Returns:
ExternalServiceInputFactory.
-
addManagedObjectSource
OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject) Adds aOfficeFloorManagedObjectSourcesupplied from anOfficeFloorSupplier.- Parameters:
managedObjectSourceName- Name of theOfficeFloorManagedObjectSource.suppliedManagedObject-SuppliedManagedObjectSourceNodeto supply theOfficeFloorManagedObjectSource.- Returns:
OfficeFloorManagedObjectSource.
-
sourceOfficeFloor
Sources the
OfficeFloorinto thisOfficeFloorNode.This will only source the top level
OfficeSection.- Parameters:
compileContext-CompileContext.- Returns:
trueif successfully sourced. Otherwisefalsewith issue reported to theCompilerIssues.
-
sourceOfficeFloorTree
Sources thisOfficeFloorNodeand all its descendantNodeinstances recursively.- Parameters:
autoWirerVisitor-AutoWirerVisitor.compileContext-CompileContext.- Returns:
trueif successfully sourced. Otherwisefalsewith issue reported to theCompilerIssues.
-
getAvailableTypes
Obtains theAvailableTypeinstances.- Parameters:
compileContext-CompileContext.- Returns:
AvailableTypeinstances.
-
loadAutoWireObjectTargets
AutoWirer<LinkObjectNode> loadAutoWireObjectTargets(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext) Loads theAutoWiretargets for theOfficeFloorManagedObjectinstances.- Parameters:
autoWirer-AutoWirerto be loaded with theOfficeFloorManagedObjecttargets.compileContext-CompileContext.- Returns:
AutoWirerwith context for theOfficeFloor.
-
loadAutoWireManagedObjectSourceTargets
AutoWirer<ManagedObjectSourceNode> loadAutoWireManagedObjectSourceTargets(AutoWirer<ManagedObjectSourceNode> autoWirer, CompileContext compileContext) Loads theAutoWiretargets for theManagedObjectSourceNodeinstances.- Parameters:
autoWirer-AutoWirerto be loaded with theOfficeFloorManagedObjectSourcetargets.compileContext-CompileContext.- Returns:
AutoWirerwith context for theOfficeFloor.
-
loadAutoWireExtensionTargets
AutoWirer<ManagedObjectExtensionNode> loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer, CompileContext compileContext) Loads theAutoWireextension targets for theOfficeFloorManagedObject.- Parameters:
autoWirer-AutoWirerto be loaded with theOfficeFloorManagedObjectextension targets.compileContext-CompileContext.- Returns:
AutoWirerwith context for theOfficeFloor.
-
loadAutoWireTeamTargets
void loadAutoWireTeamTargets(AutoWirer<LinkTeamNode> autoWirer, OfficeTeamRegistry officeTeamRegistry, CompileContext compileContext) Loads theAutoWiretargets for theOfficeFloorTeaminstances.- Parameters:
autoWirer-AutoWireto be loaded with theOfficeFloorTeamtargets.officeTeamRegistry-OfficeTeamRegistry.compileContext-CompileContext.
-
loadOfficeFloorType
Loads theOfficeFloorType.- Parameters:
compileContext-CompileContext.- Returns:
trueif theOfficeFloorTypewas loaded.
-
getOfficeFloorListeners
OfficeFloorListener[] getOfficeFloorListeners()Obtains theOfficeFloorDeployerconfiguredOfficeFloorListenerinstances.- Returns:
OfficeFloorDeployerconfiguredOfficeFloorListenerinstances.
-
isDefaultExecutionStrategy
boolean isDefaultExecutionStrategy()Indicates if defaultExecutionStrategyis being used.- Returns:
trueif defaultExecutionStrategyis being used.
-
deployOfficeFloor
OfficeFloor deployOfficeFloor(String officeFloorName, OfficeFloorBuilder officeFloorBuilder, CompileContext compileContext) Deploys theOfficeFloor.- Parameters:
officeFloorName- Name of theOfficeFloor.officeFloorBuilder-OfficeFloorBuilderto build the deployedOfficeFloor.compileContext-CompileContext.- Returns:
OfficeFloor.
-
loadExternalServicing
void loadExternalServicing(OfficeFloor officeFloor) throws UnknownOfficeException, UnknownFunctionException Loads theFunctionManagerinstances to externally trigger thisOfficeFloorNode.- Parameters:
officeFloor-OfficeFloorfor thisOfficeFloorNode.- Throws:
UnknownOfficeException-UnknownOfficeException.UnknownFunctionException-UnknownFunctionException.
-
getInternalSuppliers
InternalSupplier[] getInternalSuppliers()Obtains theInternalSupplierinstances.- Returns:
InternalSupplierinstances.
-