Package net.officefloor.compile

Class OfficeFloorCompiler

java.lang.Object

net.officefloor.compile.OfficeFloorCompiler

All Implemented Interfaces:

Node, PropertyConfigurable

Direct Known Subclasses:

OfficeFloorCompilerAdapter, OfficeFloorCompilerImpl

public abstract class OfficeFloorCompiler
extends Object
implements Node, PropertyConfigurable

OfficeFloor compiler to compile the OfficeFloor into the OfficeFrame to be built.

This is the starting point to use the compiler.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OfficeFloorCompiler.OfficeFloorCompilerFactory	Factory to create the OfficeFloorCompiler.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMPLEMENTATION_CLASS_PROPERTY_NAME	System.getProperty(String) that allows specifying the OfficeFloorCompiler implementation Class.
static final String	TYPE	Node type.

Constructor Summary

Constructors

Constructor	Description
OfficeFloorCompiler()

Method Summary

Modifier and Type	Method	Description
abstract <E, F extends Enum<F>, G extends Enum<G>, S extends AdministrationSource<E, F, G>> void	addAdministrationSourceAlias(String alias, Class<S> administrationSourceClass)	Allows providing an alias name for a AdministrationSource.
abstract void	addAutoWireStateManagerVisitor(AutoWireStateManagerVisitor autoWireStateManagerVisitor)	Adds an AutoWireStateManagerVisitor.
void	addEnvProperties()	Convenience method to add all the Property instances from System.getenv().
abstract <I, F extends Enum<F>, S extends GovernanceSource<I, F>> void	addGovernanceSourceAlias(String alias, Class<S> governanceSourceClass)	Allows providing an alias name for a GovernanceSource.
abstract <S extends ManagedFunctionSource> void	addManagedFunctionSourceAlias(String alias, Class<S> managedFunctionSourceClass)	Allows providing an alias name for a ManagedFunctionSource.
abstract <S extends ManagedObjectPoolSource> void	addManagedObjectPoolSourceAlias(String alias, Class<S> managedObjectPoolSourceClass)	Allows providing an alias name for a ManagedObjectPoolSource.
abstract <D extends Enum<D>, F extends Enum<F>, S extends ManagedObjectSource<D, F>> void	addManagedObjectSourceAlias(String alias, Class<S> managedObjectSourceClass)	Allows providing an alias name for a ManagedObjectSource.
abstract void	addOfficeFloorListener(OfficeFloorListener officeFloorListener)	Adds an OfficeFloorListener.
abstract <S extends OfficeSource> void	addOfficeSourceAlias(String alias, Class<S> officeSourceClass)	Allows providing an alias name for an OfficeSource.
abstract void	addProfile(String profile)	Adds a profile.
abstract void	addProfiler(String officeName, Profiler profiler)	Adds the Profiler for the Office.
abstract void	addResources(ResourceSource resourceSource)	Adds a ResourceSource.
abstract <S extends SectionSource> void	addSectionSourceAlias(String alias, Class<S> sectionSourceClass)	Allows providing an alias name for a SectionSource.
void	addSourceAliases()	Adds the aliases for the source classes.
abstract <S extends SupplierSource> void	addSupplierSourceAlias(String alias, Class<S> supplierSourceClass)	Allows providing an alias name for a SupplierSource.
void	addSystemProperties()	Convenience method to add all the Property instances from System.getProperties().
abstract <S extends TeamSource> void	addTeamSourceAlias(String alias, Class<S> teamSourceClass)	Allows providing an alias name for a TeamSource.
abstract OfficeFloor	compile(String officeFloorName)	Compiles and builds the OfficeFloor.
abstract boolean	configureOfficeFloorCompiler()	Runs the OfficeFloorCompilerConfigurer instances to configure this OfficeFloorCompiler.
abstract PropertyList	createPropertyList()	Creates a new empty PropertyList.
abstract SourceContext	createRootSourceContext()	Creates a root SourceContext.
abstract AdministrationLoader	getAdministrationLoader()	Obtains the AdministrationLoader.
Node[]	getChildNodes()	Obtains the child Node instances.
final ClassLoader	getClassLoader()	Obtains the ClassLoader for this OfficeFloorCompiler.
abstract CompilerIssues	getCompilerIssues()	Obtains the CompilerIssues.
abstract ExecutiveLoader	getExecutiveLoader()	Obtains the ExecutiveLoader.
abstract GovernanceLoader	getGovernanceLoader()	Obtains the GovernanceLoader.
String	getLocation()	Obtains the location of the Node.
abstract ManagedFunctionLoader	getManagedFunctionLoader()	Obtains the ManagedFunctionLoader.
abstract ManagedObjectLoader	getManagedObjectLoader()	Obtains the ManagedObjectLoader.
abstract ManagedObjectPoolLoader	getManagedObjectPoolLoader()	Obtains the ManagedObjectPoolLoader.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
abstract OfficeFloorLoader	getOfficeFloorLoader()	Obtains the OfficeFloorLoader.
abstract OfficeLoader	getOfficeLoader()	Obtains the OfficeLoader.
Node	getParentNode()	Obtains the Node containing this Node.
String	getQualifiedName(String name)	Obtains the qualified name for child Node.
abstract SectionLoader	getSectionLoader()	Obtains the SectionLoader.
abstract SupplierLoader	getSupplierLoader()	Obtains the SupplierLoader.
abstract TeamLoader	getTeamLoader()	Obtains the TeamLoader.
abstract TypeLoader	getTypeLoader()	Obtains the TypeLoader.
boolean	isInitialised()	Indicates if the Node has been initialised.
static final OfficeFloorCompiler	newOfficeFloorCompiler(ClassLoader implClassLoader)	Creates a new instance of a OfficeFloorCompiler.
static final PropertyList	newPropertyList()	Convenience method to create a new PropertyList.
<T> T	run(Class<? extends OfficeFloorCompilerRunnable<T>> runnableClass, Object... parameters)	Executes the OfficeFloorCompilerRunnable by instantiating it with the same ClassLoader being used by this OfficeFloorCompiler.
protected final void	setClassLoader(ClassLoader classLoader)	Specifies the ClassLoader.
abstract void	setClockFactory(ClockFactory clockFactory)	Specifies the ClockFactory.
abstract void	setCompilerIssues(CompilerIssues issues)	Overrides the default CompilerIssues to use in compiling the OfficeFloor.
abstract void	setEscalationHandler(EscalationHandler escalationHandler)	Overrides the default EscalationHandler.
static final void	setFactory(OfficeFloorCompiler.OfficeFloorCompilerFactory factory)	Specifies the OfficeFloorCompiler.OfficeFloorCompilerFactory.
abstract void	setMBeanRegistrator(MBeanRegistrator mbeanRegistrator)	Specifies the MBeanRegistrator.
abstract void	setOfficeFloorLocation(String officeFloorLocation)	Specifies the location of the OfficeFloor.
abstract void	setOfficeFloorSource(OfficeFloorSource officeFloorSource)	Specifies the OfficeFloorSource instance to use for compiling the OfficeFloor.
abstract <S extends OfficeFloorSource> void	setOfficeFloorSourceClass(Class<S> officeFloorSourceClass)	Overrides the default OfficeFloorSource to source the OfficeFloor.
abstract void	setOfficeFrame(OfficeFrame officeFrame)	Overrides the default OfficeFrame for building the OfficeFloor.
abstract void	setOverridePropertiesDirectory(File propertiesDirectory)	Specifies a directory containing override properties.

Methods inherited from class java.lang.Object

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

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

getQualifiedName

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

addProperty

Field Details

TYPE

public static final String TYPE

Node type.

See Also:

• Constant Field Values

IMPLEMENTATION_CLASS_PROPERTY_NAME

public static final String IMPLEMENTATION_CLASS_PROPERTY_NAME

System.getProperty(String) that allows specifying the OfficeFloorCompiler implementation Class.

Should this not be specified the default OfficeFloorCompilerImpl will be used.

Note: it is anticipated that OfficeFloorCompilerImpl will always be used.

See Also:

• Constant Field Values

Constructor Details

OfficeFloorCompiler

public OfficeFloorCompiler()

Method Details

setFactory

public static final void setFactory(OfficeFloorCompiler.OfficeFloorCompilerFactory factory)

Specifies the OfficeFloorCompiler.OfficeFloorCompilerFactory. Allows for overriding the default behaviour in creating an OfficeFloorCompiler.

Typically this should not be called however is included to enable flexibility in creating OfficeFloorCompiler instances.

Parameters:

factory - OfficeFloorCompiler.OfficeFloorCompilerFactory.

newOfficeFloorCompiler

public static final OfficeFloorCompiler newOfficeFloorCompiler(ClassLoader implClassLoader)

Creates a new instance of a OfficeFloorCompiler.

Parameters:

implClassLoader - ClassLoader to use for the OfficeFloor. May be null which will default to use the current Thread.getContextClassLoader().

Returns:

New OfficeFloorCompiler.

newPropertyList

public static final PropertyList newPropertyList()

Convenience method to create a new PropertyList.

Returns:

New PropertyList.

getClassLoader

public final ClassLoader getClassLoader()

Obtains the ClassLoader for this OfficeFloorCompiler.

Returns:

ClassLoader for this OfficeFloorCompiler.

setClassLoader

protected final void setClassLoader(ClassLoader classLoader)
                             throws IllegalArgumentException

Specifies the ClassLoader.

To ensure Class compatibility, the ClassLoader must be a child of the existing ClassLoader.

Parameters:

classLoader - Child ClassLoader.

Throws:

IllegalArgumentException - If ClassLoader not a child of the existing ClassLoader.

run

public <T> T run(Class<? extends OfficeFloorCompilerRunnable<T>> runnableClass,
 Object... parameters)
          throws Exception

Executes the OfficeFloorCompilerRunnable by instantiating it with the same ClassLoader being used by this OfficeFloorCompiler.

This is typically used by graphical editors that need to use the project class path rather than the editor's class path.

Type Parameters:

T - Return type.

Parameters:

runnableClass - OfficeFloorCompilerRunnable class.

parameters - Parameters to enable configuration of the OfficeFloorCompilerRunnable. As Proxy instances are used to bridge Class compatibility issues due to different ClassLoader, all parameters should only be access via their implementing interfaces.

Returns:

Value returned from the OfficeFloorCompilerRunnable.

Throws:

Exception - If fails to run the OfficeFloorCompilerRunnable.

addSystemProperties

public void addSystemProperties()

Convenience method to add all the Property instances from System.getProperties().

PropertyConfigurable.addProperty(String, String) will be invoked for each Property.

addEnvProperties

public void addEnvProperties()

Convenience method to add all the Property instances from System.getenv().

PropertyConfigurable.addProperty(String, String) will be invoked for each Property.

addSourceAliases

public void addSourceAliases()

Adds the aliases for the source classes.

getNodeName

public String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getNodeType

public String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public String getLocation()

Description copied from interface: Node

Obtains the location of the Node.

Specified by:

getLocation in interface Node

Returns:

Location of the Node. May be null if Node does not support a location.

getParentNode

public Node getParentNode()

Description copied from interface: Node

Obtains the Node containing this Node.

Specified by:

getParentNode in interface Node

Returns:

Node containing this Node.

getQualifiedName

public String getQualifiedName(String name)

Description copied from interface: Node

Obtains the qualified name for child Node.

Specified by:

getQualifiedName in interface Node

Parameters:

name - Name of child Node.

Returns:

Name qualified by this Node.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

isInitialised

public boolean isInitialised()

Description copied from interface: Node

Indicates if the Node has been initialised. Node instances should only be initialised once. Initialising the Node twice is an issue.

Specified by:

isInitialised in interface Node

Returns:

true if initialised.

setClockFactory

public abstract void setClockFactory(ClockFactory clockFactory)

Specifies the ClockFactory.

This will be added to the OfficeFrame before compiling the OfficeFloor and will be available in the SourceContext for retrieving Clock instances.

Parameters:

clockFactory - ClockFactory.

addResources

public abstract void addResources(ResourceSource resourceSource)

Adds a ResourceSource.

This will be added to the OfficeFrame before compiling the OfficeFloor and will be available in the SourceContext for loading the various sources.

Parameters:

resourceSource - ResourceSource.

setEscalationHandler

public abstract void setEscalationHandler(EscalationHandler escalationHandler)

Overrides the default EscalationHandler.

This will be specified on the OfficeFrame before compiling the OfficeFloor.

Parameters:

escalationHandler - EscalationHandler.

setCompilerIssues

public abstract void setCompilerIssues(CompilerIssues issues)

Overrides the default CompilerIssues to use in compiling the OfficeFloor.

Implementations of OfficeFloorCompiler must provide a default CompilerIssues. Typically this will be an implementation that writes issues to System.err.

Parameters:

issues - CompilerIssues.

setOfficeFrame

public abstract void setOfficeFrame(OfficeFrame officeFrame)

Overrides the default OfficeFrame for building the OfficeFloor.

Should this not be called the OfficeFloorCompiler implementation should use the OfficeFrame.getInstance() to build the OfficeFloor.

Parameters:

officeFrame - OfficeFrame.

setOfficeFloorSourceClass

public abstract <S extends OfficeFloorSource> void setOfficeFloorSourceClass(Class<S> officeFloorSourceClass)

Overrides the default OfficeFloorSource to source the OfficeFloor.

OfficeFloorCompiler implementations must provide a default OfficeFloorSource implementation. The choice of OfficeFloorSource implementation is left to the OfficeFloorCompiler, however it should be clearly documented on the OfficeFloorCompiler implementation which OfficeFloorSource implementation is being used.

Type Parameters:

S - OfficeFloorSource type.

Parameters:

officeFloorSourceClass - OfficeFloorSource Class.

setOfficeFloorSource

public abstract void setOfficeFloorSource(OfficeFloorSource officeFloorSource)

Specifies the OfficeFloorSource instance to use for compiling the OfficeFloor.

This will take precedence over specifying the OfficeFloorSource class.

Parameters:

officeFloorSource - OfficeFloorSource.

setOfficeFloorLocation

public abstract void setOfficeFloorLocation(String officeFloorLocation)

Specifies the location of the OfficeFloor.

Parameters:

officeFloorLocation - Location of the OfficeFloor.

addProfile

public abstract void addProfile(String profile)

Adds a profile.

Parameters:

profile - Profile.

addOfficeSourceAlias

public abstract <S extends OfficeSource> void addOfficeSourceAlias(String alias,
 Class<S> officeSourceClass)

Allows providing an alias name for an OfficeSource.

This stops the configuration files from being littered with fully qualified class names of the OfficeSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the OfficeSourceService is the preferred means to provide OfficeSource aliases.

Type Parameters:

S - OfficeSource type.

Parameters:

alias - Alias name for the OfficeSource.

officeSourceClass - OfficeSource Class for the alias.

addSectionSourceAlias

public abstract <S extends SectionSource> void addSectionSourceAlias(String alias,
 Class<S> sectionSourceClass)

Allows providing an alias name for a SectionSource.

This stops the configuration files from being littered with fully qualified class names of the SectionSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the SectionSourceService is the preferred means to provide SectionSource aliases.

Type Parameters:

S - SectionSource type.

Parameters:

alias - Alias name for the SectionSource.

sectionSourceClass - SectionSource Class for the alias.

addManagedFunctionSourceAlias

public abstract <S extends ManagedFunctionSource>
void addManagedFunctionSourceAlias(String alias,
 Class<S> managedFunctionSourceClass)

Allows providing an alias name for a ManagedFunctionSource.

This stops the configuration files from being littered with fully qualified class names of the ManagedFunctionSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the ManagedFunctionSourceService is the preferred means to provide ManagedFunctionSource aliases.

Type Parameters:

S - ManagedFunctionSource type.

Parameters:

alias - Alias name for the ManagedFunctionSource.

managedFunctionSourceClass - ManagedFunctionSource Class for the alias.

addManagedObjectSourceAlias

public abstract <D extends Enum<D>,
F extends Enum<F>,
S extends ManagedObjectSource<D,
F>>
void addManagedObjectSourceAlias(String alias,
 Class<S> managedObjectSourceClass)

Allows providing an alias name for a ManagedObjectSource.

This stops the configuration files from being littered with fully qualified class names of the ManagedObjectSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the ManagedObjectSourceService is the preferred means to provide ManagedObjectSource aliases.

Type Parameters:

D - Dependency type keys.

F - Flow type keys.

S - ManagedObjectSource type.

Parameters:

alias - Alias name for the ManagedObjectSource.

managedObjectSourceClass - ManagedObjectSource Class for the alias.

addManagedObjectPoolSourceAlias

public abstract <S extends ManagedObjectPoolSource>
void addManagedObjectPoolSourceAlias(String alias,
 Class<S> managedObjectPoolSourceClass)

Allows providing an alias name for a ManagedObjectPoolSource.

This stops the configuration files from being littered with fully qualified class names of the ManagedObjectPoolSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the ManagedObjectSourceService is the preferred means to provide ManagedObjectSource aliases.

Type Parameters:

S - ManagedObjectPoolSource type.

Parameters:

alias - Alias name for the ManagedObjectPoolSource.

managedObjectPoolSourceClass - ManagedObjectPoolSource Class for the alias.

addSupplierSourceAlias

public abstract <S extends SupplierSource> void addSupplierSourceAlias(String alias,
 Class<S> supplierSourceClass)

Allows providing an alias name for a SupplierSource.

This stops the configuration files from being littered with fully qualified class names of the SupplierSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the SupplierSourceService is the preferred means to provide SupplierSource aliases.

Type Parameters:

S - SupplierSource type.

Parameters:

alias - Alias name for the SupplierSource.

supplierSourceClass - SupplierSource Class for the alias.

addAdministrationSourceAlias

public abstract <E,
F extends Enum<F>,
G extends Enum<G>,
S extends AdministrationSource<E,
F,
G>>
void addAdministrationSourceAlias(String alias,
 Class<S> administrationSourceClass)

Allows providing an alias name for a AdministrationSource.

This stops the configuration files from being littered with fully qualified class names of the AdministrationSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the AdministrationSourceService is the preferred means to provide AdministrationSource aliases.

Type Parameters:

E - Extension interface type.

F - Flow keys for the Administration.

G - Governance keys for the Administration.

S - AdministrationSource type.

Parameters:

alias - Alias name for the AdministrationSource.

administrationSourceClass - AdministrationSource Class for the alias.

addGovernanceSourceAlias

public abstract <I,
F extends Enum<F>,
S extends GovernanceSource<I,
F>>
void addGovernanceSourceAlias(String alias,
 Class<S> governanceSourceClass)

Allows providing an alias name for a GovernanceSource.

This stops the configuration files from being littered with fully qualified class names of the GovernanceSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the GovernanceSourceService is the preferred means to provide GovernanceSource aliases.

Type Parameters:

I - Extension interface type.

F - Flow type keys.

S - GovernanceSource type.

Parameters:

alias - Alias name for the GovernanceSource.

governanceSourceClass - GovernanceSource Class for the alias.

addTeamSourceAlias

public abstract <S extends TeamSource> void addTeamSourceAlias(String alias,
 Class<S> teamSourceClass)

Allows providing an alias name for a TeamSource.

This stops the configuration files from being littered with fully qualified class names of the TeamSource classes. This is anticipated to allow flexibility as the functionality evolves so that relocating/renaming classes does not require significant configuration changes.

Typically this should not be used directly as the TeamSourceService is the preferred means to provide TeamSource aliases.

Type Parameters:

S - TeamSource type.

Parameters:

alias - Alias name for the TeamSource.

teamSourceClass - TeamSource Class for the alias.

addProfiler

public abstract void addProfiler(String officeName,
 Profiler profiler)

Adds the Profiler for the Office.

Parameters:

officeName - Name of Office to be profiled.

profiler - Profiler for the Office.

setOverridePropertiesDirectory

public abstract void setOverridePropertiesDirectory(File propertiesDirectory)

Specifies a directory containing override properties.

The files within the directory are properties files with the naming convention: <fully-qualified-name>.properties

Parameters:

propertiesDirectory - Directory containing the override properties.

setMBeanRegistrator

public abstract void setMBeanRegistrator(MBeanRegistrator mbeanRegistrator)

Specifies the MBeanRegistrator.

Parameters:

mbeanRegistrator - MBeanRegistrator.

addOfficeFloorListener

public abstract void addOfficeFloorListener(OfficeFloorListener officeFloorListener)

Adds an OfficeFloorListener.

Parameters:

officeFloorListener - OfficeFloorListener.

addAutoWireStateManagerVisitor

public abstract void addAutoWireStateManagerVisitor(AutoWireStateManagerVisitor autoWireStateManagerVisitor)

Adds an AutoWireStateManagerVisitor.

Parameters:

autoWireStateManagerVisitor - AutoWireStateManagerVisitor.

createPropertyList

public abstract PropertyList createPropertyList()

Creates a new empty PropertyList.

Returns:

New empty PropertyList.

createRootSourceContext

public abstract SourceContext createRootSourceContext()

Creates a root SourceContext.

Returns:

Root SourceContext.

getCompilerIssues

public abstract CompilerIssues getCompilerIssues()

Obtains the CompilerIssues.

Returns:

CompilerIssues.

getTypeLoader

public abstract TypeLoader getTypeLoader()

Obtains the TypeLoader.

Returns:

TypeLoader.

getOfficeFloorLoader

public abstract OfficeFloorLoader getOfficeFloorLoader()

Obtains the OfficeFloorLoader.

Returns:

OfficeFloorLoader.

getOfficeLoader

public abstract OfficeLoader getOfficeLoader()

Obtains the OfficeLoader.

Returns:

OfficeLoader.

getSectionLoader

public abstract SectionLoader getSectionLoader()

Obtains the SectionLoader.

Returns:

SectionLoader.

getManagedFunctionLoader

public abstract ManagedFunctionLoader getManagedFunctionLoader()

Obtains the ManagedFunctionLoader.

Returns:

ManagedFunctionLoader.

getManagedObjectLoader

public abstract ManagedObjectLoader getManagedObjectLoader()

Obtains the ManagedObjectLoader.

Returns:

ManagedObjectLoader.

getSupplierLoader

public abstract SupplierLoader getSupplierLoader()

Obtains the SupplierLoader.

Returns:

SupplierLoader.

getGovernanceLoader

public abstract GovernanceLoader getGovernanceLoader()

Obtains the GovernanceLoader.

Returns:

GovernanceLoader.

getManagedObjectPoolLoader

public abstract ManagedObjectPoolLoader getManagedObjectPoolLoader()

Obtains the ManagedObjectPoolLoader.

Returns:

ManagedObjectPoolLoader.

getAdministrationLoader

public abstract AdministrationLoader getAdministrationLoader()

Obtains the AdministrationLoader.

Returns:

AdministrationLoader.

getTeamLoader

public abstract TeamLoader getTeamLoader()

Obtains the TeamLoader.

Returns:

TeamLoader.

getExecutiveLoader

public abstract ExecutiveLoader getExecutiveLoader()

Obtains the ExecutiveLoader.

Returns:

ExecutiveLoader.

configureOfficeFloorCompiler

public abstract boolean configureOfficeFloorCompiler()

Runs the OfficeFloorCompilerConfigurer instances to configure this OfficeFloorCompiler.

This is always run before a compile. However, may not be run for loaders. This allows running if just loading types.

Returns:

true if configured. false with issue reported to the CompilerIssues.

compile

public abstract OfficeFloor compile(String officeFloorName)

Compiles and builds the OfficeFloor.

Parameters:

officeFloorName - Name of the OfficeFloor.

Returns:

OfficeFloor or null if issues in compiling which are reported to the CompilerIssues.