Package net.officefloor.frame.api.build

Interface OfficeFloorBuilder

All Known Implementing Classes:

OfficeFloorBuilderImpl

public interface OfficeFloorBuilder

Builder of an OfficeFloor.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>,MS extends ManagedObjectSource<O,F>> ManagedObjectBuilder<F>	addManagedObject(java.lang.String managedObjectSourceName, java.lang.Class<MS> managedObjectSourceClass)	Adds a ManagedObjectSource to this OfficeFloorBuilder.
<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedObjectBuilder<F>	addManagedObject(java.lang.String managedObjectSourceName, ManagedObjectSource<O,F> managedObjectSource)	Adds a ManagedObjectSource to this OfficeFloorBuilder.
OfficeBuilder	addOffice(java.lang.String officeName)	Adds an Office on the OfficeFloor.
void	addOfficeFloorListener(OfficeFloorListener listener)	Adds an OfficeFloorListener.
void	addOfficeVisitor(OfficeVisitor visitor)	Adds an OfficeVisitor.
void	addProfile(java.lang.String profile)	Adds an active profile for the OfficeFloor.
void	addResources(ResourceSource resourceSource)	Adds a ResourceSource to locate resources.
<TS extends TeamSource> TeamBuilder<TS>	addTeam(java.lang.String teamName, java.lang.Class<TS> teamSourceClass)	Adds a Team which will execute FunctionState instances within this OfficeFloor.
<TS extends TeamSource> TeamBuilder<TS>	addTeam(java.lang.String teamName, TS teamSource)	Adds a Team which will execute FunctionState instances within the OfficeFloor.
OfficeFloor	buildOfficeFloor()	Builds the OfficeFloor.
OfficeFloor	buildOfficeFloor(OfficeFloorIssues issuesListener)	Builds the OfficeFloor.
<TS extends TeamSource> TeamBuilder<TS>	setBreakChainTeam(java.lang.Class<TS> teamSourceClass)	Specifies the break FunctionState chain Team.
void	setClassLoader(java.lang.ClassLoader classLoader)	Allows overriding the ClassLoader provided to the sources by the SourceContext.
void	setClockFactory(ClockFactory clockFactory)	Allows overriding the ClockFactory to create Clock instances by the SourceContext.
void	setEscalationHandler(EscalationHandler escalationHandler)	Specifies the EscalationHandler for issues escalating out of the Office instances.
<XS extends ExecutiveSource> ExecutiveBuilder<XS>	setExecutive(java.lang.Class<XS> executiveSourceClass)	Specifies an Executive which will manage the Team instances within the OfficeFloor.
<XS extends ExecutiveSource> ExecutiveBuilder<XS>	setExecutive(XS executiveSource)	Specifies an Executive which will manage the Team instances within the OfficeFloor.
void	setMaxStartupWaitTime(long maxStartupWaitTime)	Specifies the maximum time in milliseconds to wait for OfficeFloor to start.
void	setThreadDecorator(java.util.function.Consumer<java.lang.Thread> decorator)	Decorates all the Thread instances created by the TeamSourceContext.

Method Detail

addProfile

void addProfile(java.lang.String profile)

Adds an active profile for the OfficeFloor.

Parameters:

profile - Active profile for the OfficeFloor.

setClassLoader

void setClassLoader(java.lang.ClassLoader classLoader)

Allows overriding the ClassLoader provided to the sources by the SourceContext.

Parameters:

classLoader - ClassLoader.

setClockFactory

void setClockFactory(ClockFactory clockFactory)

Allows overriding the ClockFactory to create Clock instances by the SourceContext.

Parameters:

clockFactory - ClockFactory.

setMaxStartupWaitTime

void setMaxStartupWaitTime(long maxStartupWaitTime)

Specifies the maximum time in milliseconds to wait for OfficeFloor to start.

Parameters:

maxStartupWaitTime - Maximum time in milliseconds to wait for OfficeFloor to start.

setThreadDecorator

void setThreadDecorator(java.util.function.Consumer<java.lang.Thread> decorator)

Decorates all the Thread instances created by the TeamSourceContext.

Parameters:

decorator - Decorates all the Thread instances created by the TeamSourceContext.

addResources

void addResources(ResourceSource resourceSource)

Adds a ResourceSource to locate resources.

Parameters:

resourceSource - ResourceSource.

addOfficeVisitor

void addOfficeVisitor(OfficeVisitor visitor)

Adds an OfficeVisitor.

Parameters:

visitor - OfficeVisitor.

addOfficeFloorListener

void addOfficeFloorListener(OfficeFloorListener listener)

Adds an OfficeFloorListener.

Parameters:

listener - OfficeFloorListener.

addManagedObject

<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>,MS extends ManagedObjectSource<O,F>> ManagedObjectBuilder<F> addManagedObject(java.lang.String managedObjectSourceName,
                                                                                                                                                         java.lang.Class<MS> managedObjectSourceClass)

Adds a ManagedObjectSource to this OfficeFloorBuilder.

Type Parameters:

O - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClass - Class of the ManagedObjectSource.

Returns:

ManagedObjectBuilder.

addManagedObject

<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedObjectBuilder<F> addManagedObject(java.lang.String managedObjectSourceName,
                                                                                                         ManagedObjectSource<O,F> managedObjectSource)

Adds a ManagedObjectSource to this OfficeFloorBuilder.

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

ManagedObjectBuilder.

addTeam

<TS extends TeamSource> TeamBuilder<TS> addTeam(java.lang.String teamName,
                                                java.lang.Class<TS> teamSourceClass)

Adds a Team which will execute FunctionState instances within this OfficeFloor.

Type Parameters:

TS - TeamSource type.

Parameters:

teamName - Name to register the Team under.

teamSourceClass - TeamSource Class to source the Team.

Returns:

TeamBuilder to build the Team.

addTeam

<TS extends TeamSource> TeamBuilder<TS> addTeam(java.lang.String teamName,
                                                TS teamSource)

Adds a Team which will execute FunctionState instances within the OfficeFloor.

Type Parameters:

TS - TeamSource type.

Parameters:

teamName - Name to register the Team under.

teamSource - TeamSource to source the Team.

Returns:

TeamBuilder to build the Team.

setExecutive

<XS extends ExecutiveSource> ExecutiveBuilder<XS> setExecutive(java.lang.Class<XS> executiveSourceClass)

Specifies an Executive which will manage the Team instances within the OfficeFloor.

Type Parameters:

XS - ExecutiveSource type.

Parameters:

executiveSourceClass - ExecutiveSource Class to source the Executive.

Returns:

ExecutiveBuilder to build the Executive.

setExecutive

<XS extends ExecutiveSource> ExecutiveBuilder<XS> setExecutive(XS executiveSource)

Specifies an Executive which will manage the Team instances within the OfficeFloor.

Type Parameters:

XS - ExecutiveSource type.

Parameters:

executiveSource - ExecutiveSource to source the Executive.

Returns:

ExecutiveBuilder to build the Executive.

setBreakChainTeam

<TS extends TeamSource> TeamBuilder<TS> setBreakChainTeam(java.lang.Class<TS> teamSourceClass)

Specifies the break FunctionState chain Team.

This need not be specified, but is available to override the default Team.

Type Parameters:

TS - TeamSource type.

Parameters:

teamSourceClass - TeamSource to source the Team.

Returns:

TeamBuilder to build the Team.

addOffice

OfficeBuilder addOffice(java.lang.String officeName)

Adds an Office on the OfficeFloor.

Parameters:

officeName - Name of the Office.

Returns:

OfficeBuilder to build the Office.

setEscalationHandler

void setEscalationHandler(EscalationHandler escalationHandler)

Specifies the EscalationHandler for issues escalating out of the Office instances.

Parameters:

escalationHandler - EscalationHandler.

buildOfficeFloor

OfficeFloor buildOfficeFloor(OfficeFloorIssues issuesListener)

Builds the OfficeFloor.

Parameters:

issuesListener - OfficeFloorIssues to listen for issues in constructing the OfficeFloor.

Returns:

Built OfficeFloor if successfully built, or null if could not construct OfficeFloor with reasons passed to the OfficeFloorIssues.

buildOfficeFloor

OfficeFloor buildOfficeFloor()
                      throws OfficeFloorBuildException

Builds the OfficeFloor.

Returns:

Built OfficeFloor.

Throws:

OfficeFloorBuildException - If fails to build the OfficeFloor.

See Also:

OfficeFloorBuildException