net.officefloor.autowire.impl

Class AutoWireOfficeSource

java.lang.Object

net.officefloor.compile.spi.office.source.impl.AbstractOfficeSource

net.officefloor.autowire.impl.AutoWireOfficeSource

All Implemented Interfaces:

OfficeSource

public class AutoWireOfficeSource
extends AbstractOfficeSource

OfficeSource implementation that auto-wires the configuration based on type.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.office.source.impl.AbstractOfficeSource

AbstractOfficeSource.SpecificationContext

Constructor Summary

Constructors

Constructor and Description
AutoWireOfficeSource() Default constructor.
AutoWireOfficeSource(OfficeFloorCompiler compiler) Initiate.

Method Summary

Modifier and Type	Method and Description
void	addAvailableOfficeObject(AutoWire autoWire, Class<?>... extensionInterfaces) Adds that the OfficeObject has the ability to be used with the specified extension interfaces.
void	addAvailableOfficeTeam(AutoWire autoWire) Adds an available OfficeTeam for executing Task instances that has an object dependency of the input type.
AutoWireGovernance	addGovernance(String governanceName, String governanceSourceClassName) Adds Governance to this Office.
<S extends SectionSource> AutoWireSection	addSection(String sectionName, String sectionSourceClassName, String sectionLocation) Adds an OfficeSection allowing to override the AutoWireSection.
<S extends SectionSource,A extends AutoWireSection> A	addSection(String sectionName, String sectionSourceClassName, String sectionLocation, AutoWireSectionFactory<A> sectionFactory) Adds an OfficeSection.
void	addSectionTransformer(AutoWireSectionTransformer transformer) Adds a AutoWireSectionTransformer to enable transforming all AutoWireSection instances before configuring them for compiling.
void	addStartupFlow(AutoWireSection section, String inputName) Adds a flow to be triggered on start-up.
AutoWireSection	getSection(String sectionName) Obtains the AutoWireSection by its name.
boolean	isLinked(AutoWireSection section, String sectionOutputName) Determines if the AutoWireSection output is configured for linking.
void	link(AutoWireSection sourceSection, String sourceOutputName, AutoWireSection targetSection, String targetInputName) Links the source SectionOutput to a target SectionInput.
void	linkEscalation(Class<? extends Throwable> escalationType, AutoWireSection section, String sectionInputName) Links the handling of the Escalation to the AutoWireSection.
protected void	loadSpecification(AbstractOfficeSource.SpecificationContext context) Loads the OfficeSourceSpecification.
void	sourceOffice(OfficeArchitect architect, OfficeSourceContext context) Sources the OfficeType by constructing it via the input OfficeArchitect.

Methods inherited from class net.officefloor.compile.spi.office.source.impl.AbstractOfficeSource

getSpecification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoWireOfficeSource

public AutoWireOfficeSource(OfficeFloorCompiler compiler)

Initiate.

Parameters:

compiler - OfficeFloorCompiler.

AutoWireOfficeSource

public AutoWireOfficeSource()

Default constructor.

Method Detail

addSection

public <S extends SectionSource,A extends AutoWireSection> A addSection(String sectionName,
                                                                        String sectionSourceClassName,
                                                                        String sectionLocation,
                                                                        AutoWireSectionFactory<A> sectionFactory)

Adds an OfficeSection.

Type Parameters:

S - SectionSource type.

A - AutoWireSection type.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - SectionSource class name.

sectionLocation - OfficeSection location.

sectionFactory - AutoWireSectionFactory.

Returns:

AutoWireSection to configure properties and link flows.

addSection

public <S extends SectionSource> AutoWireSection addSection(String sectionName,
                                                            String sectionSourceClassName,
                                                            String sectionLocation)

Adds an OfficeSection allowing to override the AutoWireSection.

Type Parameters:

S - SectionSource type.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - SectionSource class name.

sectionLocation - OfficeSection location.

Returns:

AutoWireSection to configure properties and link flows.

getSection

public AutoWireSection getSection(String sectionName)

Obtains the AutoWireSection by its name.

Parameters:

sectionName - Name of the AutoWireSection.

Returns:

AutoWireSection or null if no AutoWireSection by the name.

addSectionTransformer

public void addSectionTransformer(AutoWireSectionTransformer transformer)

Adds a AutoWireSectionTransformer to enable transforming all AutoWireSection instances before configuring them for compiling.

Parameters:

transformer - AutoWireSectionTransformer.

link

public void link(AutoWireSection sourceSection,
                 String sourceOutputName,
                 AutoWireSection targetSection,
                 String targetInputName)

Links the source SectionOutput to a target SectionInput.

Parameters:

sourceSection - Source section.

sourceOutputName - Name of the source SectionOutput.

targetSection - Target section.

targetInputName - Name of the target SectionInput.

isLinked

public boolean isLinked(AutoWireSection section,
                        String sectionOutputName)

Determines if the AutoWireSection output is configured for linking.

This aids configuration by allowing to know if SectionOutput flows have been configured (linked).

Parameters:

section - AutoWireSection.

sectionOutputName - SectionOutput name.

Returns:

true if configured for linking, otherwise false.

linkEscalation

public void linkEscalation(Class<? extends Throwable> escalationType,
                           AutoWireSection section,
                           String sectionInputName)

Links the handling of the Escalation to the AutoWireSection.

Parameters:

escalationType - TYpe of Escalation.

section - AutoWireSection.

sectionInputName - Name of the OfficeSectionInput.

addStartupFlow

public void addStartupFlow(AutoWireSection section,
                           String inputName)

Adds a flow to be triggered on start-up.

Parameters:

section - AutoWireSection.

inputName - Name of the AutoWireSection input to trigger on start-up.

addGovernance

public AutoWireGovernance addGovernance(String governanceName,
                                        String governanceSourceClassName)

Adds Governance to this Office.

The Governance is auto-wired to ManagedObject instances with the matching extension interface.

Parameters:

governanceName - Name of the Governance.

governanceSourceClassName - Class name of the GovernanceSource. May be an alias.

Returns:

AutoWireGovernance.

See Also:

ManagedObjectSourceMetaData.getExtensionInterfacesMetaData()

addAvailableOfficeObject

public void addAvailableOfficeObject(AutoWire autoWire,
                                     Class<?>... extensionInterfaces)

Adds that the OfficeObject has the ability to be used with the specified extension interfaces.

This aids both auto-wiring use and Governance for the OfficeObject.

Parameters:

autoWire - OfficeObject AutoWire.

extensionInterfaces - Extension interfaces available for the OfficeObject.

addAvailableOfficeTeam

public void addAvailableOfficeTeam(AutoWire autoWire)

Adds an available OfficeTeam for executing Task instances that has an object dependency of the input type.

Parameters:

autoWire - Object dependency AutoWire for the Task.

loadSpecification

protected void loadSpecification(AbstractOfficeSource.SpecificationContext context)

Description copied from class: AbstractOfficeSource

Loads the OfficeSourceSpecification.

Specified by:

loadSpecification in class AbstractOfficeSource

Parameters:

context - AbstractOfficeSource.SpecificationContext.

sourceOffice

public void sourceOffice(OfficeArchitect architect,
                         OfficeSourceContext context)
                  throws Exception

Description copied from interface: OfficeSource

Sources the OfficeType by constructing it via the input OfficeArchitect.

Parameters:

architect - OfficeArchitect to structure the Office.

context - OfficeSourceContext to source details to structure the Office.

Throws:

Exception - If fails to construct the Office.