Package net.officefloor.frame.impl.construct.officefloor

Class OfficeFloorBuilderImpl

java.lang.Object

net.officefloor.frame.impl.construct.officefloor.OfficeFloorBuilderImpl

All Implemented Interfaces:

OfficeFloorBuilder, OfficeFloorConfiguration

public class OfficeFloorBuilderImpl
extends java.lang.Object
implements OfficeFloorBuilder, OfficeFloorConfiguration

Implementation of OfficeFloorBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
OfficeFloorBuilderImpl(java.lang.String officeFloorName)	Initiate.

Method Summary

Modifier and Type	Method	Description
<D extends java.lang.Enum<D>,F extends java.lang.Enum<F>,MS extends ManagedObjectSource<D,F>> ManagedObjectBuilder<F>	addManagedObject(java.lang.String managedObjectSourceName, java.lang.Class<MS> managedObjectSourceClass)	Adds a ManagedObjectSource to this OfficeFloorBuilder.
<D extends java.lang.Enum<D>,F extends java.lang.Enum<F>> ManagedObjectBuilder<F>	addManagedObject(java.lang.String managedObjectSourceName, ManagedObjectSource<D,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 issues)	Builds the OfficeFloor.
TeamConfiguration<?>	getBreakChainTeamConfiguration()	Obtains the break FunctionState chain TeamConfiguration.
EscalationHandler	getEscalationHandler()	Obtains the EscalationHandler for issues escalating out of the Office instances.
ExecutiveConfiguration<?>	getExecutiveConfiguration()	Obtains the configuration of the Executive for the OfficeFloor.
ManagedObjectSourceConfiguration<?,?>[]	getManagedObjectSourceConfiguration()	Obtains the configuration of the ManagedObjectSource instances.
long	getMaxStartupWaitTime()	Obtains the maximum time in milliseconds to wait for OfficeFloor to start.
OfficeConfiguration[]	getOfficeConfiguration()	Obtains the configuration of the Office instances on the OfficeFloor.
java.lang.String	getOfficeFloorName()	Obtains the name of the OfficeFloor.
OfficeVisitor[]	getOfficeVisitors()	Obtains the OfficeVisitor instances.
java.lang.String[]	getProfiles()	Obtains the profiles.
SourceContext	getSourceContext(java.lang.String sourceName, java.util.function.Supplier<ClockFactory> clockFactoryProvider)	Obtains the SourceContext.
TeamConfiguration<?>[]	getTeamConfiguration()	Obtains the configuration of the Team instances on the OfficeFloor.
java.util.function.Consumer<java.lang.Thread>	getThreadDecorator()	Obtains the decorator of Thread instances created by the TeamSourceContext.
<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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeFloorBuilderImpl

public OfficeFloorBuilderImpl(java.lang.String officeFloorName)

Initiate.

Parameters:

officeFloorName - Name of the OfficeFloor.

Method Detail

addProfile

public void addProfile(java.lang.String profile)

Description copied from interface: OfficeFloorBuilder

Adds an active profile for the OfficeFloor.

Specified by:

addProfile in interface OfficeFloorBuilder

Parameters:

profile - Active profile for the OfficeFloor.

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setClassLoader in interface OfficeFloorBuilder

Parameters:

classLoader - ClassLoader.

setClockFactory

public void setClockFactory(ClockFactory clockFactory)

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setClockFactory in interface OfficeFloorBuilder

Parameters:

clockFactory - ClockFactory.

setMaxStartupWaitTime

public void setMaxStartupWaitTime(long maxStartupWaitTime)

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setMaxStartupWaitTime in interface OfficeFloorBuilder

Parameters:

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

setThreadDecorator

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

Description copied from interface: OfficeFloorBuilder

Decorates all the Thread instances created by the TeamSourceContext.

Specified by:

setThreadDecorator in interface OfficeFloorBuilder

Parameters:

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

addResources

public void addResources(ResourceSource resourceSource)

Description copied from interface: OfficeFloorBuilder

Adds a ResourceSource to locate resources.

Specified by:

addResources in interface OfficeFloorBuilder

Parameters:

resourceSource - ResourceSource.

addOfficeFloorListener

public void addOfficeFloorListener(OfficeFloorListener listener)

Description copied from interface: OfficeFloorBuilder

Adds an OfficeFloorListener.

Specified by:

addOfficeFloorListener in interface OfficeFloorBuilder

Parameters:

listener - OfficeFloorListener.

addManagedObject

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

Description copied from interface: OfficeFloorBuilder

Adds a ManagedObjectSource to this OfficeFloorBuilder.

Specified by:

addManagedObject in interface OfficeFloorBuilder

Type Parameters:

D - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClass - Class of the ManagedObjectSource.

Returns:

ManagedObjectBuilder.

addManagedObject

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

Description copied from interface: OfficeFloorBuilder

Adds a ManagedObjectSource to this OfficeFloorBuilder.

Specified by:

addManagedObject in interface OfficeFloorBuilder

Type Parameters:

D - Dependency key type.

F - Flow key type.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

ManagedObjectBuilder.

addTeam

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

Description copied from interface: OfficeFloorBuilder

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

Specified by:

addTeam in interface OfficeFloorBuilder

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

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

Description copied from interface: OfficeFloorBuilder

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

Specified by:

addTeam in interface OfficeFloorBuilder

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

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

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setExecutive in interface OfficeFloorBuilder

Type Parameters:

XS - ExecutiveSource type.

Parameters:

executiveSourceClass - ExecutiveSource Class to source the Executive.

Returns:

ExecutiveBuilder to build the Executive.

setExecutive

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

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setExecutive in interface OfficeFloorBuilder

Type Parameters:

XS - ExecutiveSource type.

Parameters:

executiveSource - ExecutiveSource to source the Executive.

Returns:

ExecutiveBuilder to build the Executive.

setBreakChainTeam

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

Description copied from interface: OfficeFloorBuilder

Specifies the break FunctionState chain Team.

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

Specified by:

setBreakChainTeam in interface OfficeFloorBuilder

Type Parameters:

TS - TeamSource type.

Parameters:

teamSourceClass - TeamSource to source the Team.

Returns:

TeamBuilder to build the Team.

addOffice

public OfficeBuilder addOffice(java.lang.String officeName)

Description copied from interface: OfficeFloorBuilder

Adds an Office on the OfficeFloor.

Specified by:

addOffice in interface OfficeFloorBuilder

Parameters:

officeName - Name of the Office.

Returns:

OfficeBuilder to build the Office.

addOfficeVisitor

public void addOfficeVisitor(OfficeVisitor visitor)

Description copied from interface: OfficeFloorBuilder

Adds an OfficeVisitor.

Specified by:

addOfficeVisitor in interface OfficeFloorBuilder

Parameters:

visitor - OfficeVisitor.

setEscalationHandler

public void setEscalationHandler(EscalationHandler escalationHandler)

Description copied from interface: OfficeFloorBuilder

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

Specified by:

setEscalationHandler in interface OfficeFloorBuilder

Parameters:

escalationHandler - EscalationHandler.

buildOfficeFloor

public OfficeFloor buildOfficeFloor()
                             throws OfficeFloorBuildException

Description copied from interface: OfficeFloorBuilder

Builds the OfficeFloor.

Specified by:

buildOfficeFloor in interface OfficeFloorBuilder

Returns:

Built OfficeFloor.

Throws:

OfficeFloorBuildException - If fails to build the OfficeFloor.

See Also:

OfficeFloorBuildException

buildOfficeFloor

public OfficeFloor buildOfficeFloor(OfficeFloorIssues issues)

Description copied from interface: OfficeFloorBuilder

Builds the OfficeFloor.

Specified by:

buildOfficeFloor in interface OfficeFloorBuilder

Parameters:

issues - 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.

getOfficeFloorName

public java.lang.String getOfficeFloorName()

Description copied from interface: OfficeFloorConfiguration

Obtains the name of the OfficeFloor.

Specified by:

getOfficeFloorName in interface OfficeFloorConfiguration

Returns:

OfficeFloor.

getMaxStartupWaitTime

public long getMaxStartupWaitTime()

Description copied from interface: OfficeFloorConfiguration

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

Specified by:

getMaxStartupWaitTime in interface OfficeFloorConfiguration

Returns:

Maximum time in milliseconds to wait for OfficeFloor to start.

getProfiles

public java.lang.String[] getProfiles()

Description copied from interface: OfficeFloorConfiguration

Obtains the profiles.

Specified by:

getProfiles in interface OfficeFloorConfiguration

Returns:

Profiles.

getThreadDecorator

public java.util.function.Consumer<java.lang.Thread> getThreadDecorator()

Description copied from interface: OfficeFloorConfiguration

Obtains the decorator of Thread instances created by the TeamSourceContext.

Specified by:

getThreadDecorator in interface OfficeFloorConfiguration

Returns:

Decorator of Thread instances created by the TeamSourceContext. May be null.

getSourceContext

public SourceContext getSourceContext(java.lang.String sourceName,
                                      java.util.function.Supplier<ClockFactory> clockFactoryProvider)

Description copied from interface: OfficeFloorConfiguration

Obtains the SourceContext.

Specified by:

getSourceContext in interface OfficeFloorConfiguration

Parameters:

sourceName - Name of source.

clockFactoryProvider - Provides ClockFactory if one not configured.

Returns:

SourceContext.

getManagedObjectSourceConfiguration

public ManagedObjectSourceConfiguration<?,?>[] getManagedObjectSourceConfiguration()

Description copied from interface: OfficeFloorConfiguration

Obtains the configuration of the ManagedObjectSource instances.

Specified by:

getManagedObjectSourceConfiguration in interface OfficeFloorConfiguration

Returns:

ManagedObjectSource configuration.

getTeamConfiguration

public TeamConfiguration<?>[] getTeamConfiguration()

Description copied from interface: OfficeFloorConfiguration

Obtains the configuration of the Team instances on the OfficeFloor.

Specified by:

getTeamConfiguration in interface OfficeFloorConfiguration

Returns:

TeamConfiguration instances.

getExecutiveConfiguration

public ExecutiveConfiguration<?> getExecutiveConfiguration()

Description copied from interface: OfficeFloorConfiguration

Obtains the configuration of the Executive for the OfficeFloor.

Specified by:

getExecutiveConfiguration in interface OfficeFloorConfiguration

Returns:

ExecutiveConfiguration.

getBreakChainTeamConfiguration

public TeamConfiguration<?> getBreakChainTeamConfiguration()

Description copied from interface: OfficeFloorConfiguration

Obtains the break FunctionState chain TeamConfiguration.

Specified by:

getBreakChainTeamConfiguration in interface OfficeFloorConfiguration

Returns:

Break FunctionState chain TeamConfiguration.

getOfficeConfiguration

public OfficeConfiguration[] getOfficeConfiguration()

Description copied from interface: OfficeFloorConfiguration

Obtains the configuration of the Office instances on the OfficeFloor.

Specified by:

getOfficeConfiguration in interface OfficeFloorConfiguration

Returns:

OfficeConfiguration instances.

getOfficeVisitors

public OfficeVisitor[] getOfficeVisitors()

Description copied from interface: OfficeFloorConfiguration

Obtains the OfficeVisitor instances.

Specified by:

getOfficeVisitors in interface OfficeFloorConfiguration

Returns:

OfficeVisitor instances.

getEscalationHandler

public EscalationHandler getEscalationHandler()

Description copied from interface: OfficeFloorConfiguration

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

Specified by:

getEscalationHandler in interface OfficeFloorConfiguration

Returns:

EscalationHandler for issues escalating out of the Office instances. May be null.