Package net.officefloor.frame.api

Class OfficeFrame

java.lang.Object

net.officefloor.frame.api.OfficeFrame

Direct Known Subclasses:

OfficeFrameImpl

public abstract class OfficeFrame
extends Object

Office Frame to create the OfficeFloor.

This is the starting point to use the framework.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMPLEMENTATION_CLASS_PROPERTY_NAME	System.getProperty(String) that allows specifying the OfficeFrame implementation Class.
static final String	LOG_SOURCE_CLASS_PROPERTY_NAME	System.getProperty(String) that flags to infer the source Class undertaking the logging.

Constructor Summary

Constructors

Constructor	Description
OfficeFrame()

Method Summary

Modifier and Type	Method	Description
static final OfficeFloorBuilder	createOfficeFloorBuilder()	Convenience method to create a single OfficeFloorBuilder, as there is typically only one OfficeFloor per JVM.
abstract OfficeFloorBuilder	createOfficeFloorBuilder(String officeFloorName)	Obtains the OfficeFloorBuilder.
static final OfficeFrame	getInstance()	Obtains the the Singleton instance of the OfficeFrame.
static Logger	getLogger(String loggerName)	Obtains the Logger.
static final void	setInstance(OfficeFrame singleton)	Specifies the OfficeFrame implementation.

Methods inherited from class java.lang.Object

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

Field Details

IMPLEMENTATION_CLASS_PROPERTY_NAME

public static final String IMPLEMENTATION_CLASS_PROPERTY_NAME

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

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

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

See Also:

• Constant Field Values

LOG_SOURCE_CLASS_PROPERTY_NAME

public static final String LOG_SOURCE_CLASS_PROPERTY_NAME

System.getProperty(String) that flags to infer the source Class undertaking the logging.

By default the Logger instances will specify a null source Class name so that the Logger name is used by the SimpleFormatter. This will then result in LogRecord instances formatted with the Logger name.

Flagging this true will allow the source Class name to be inferred. However, a Formatter will likely need to be configured to indicate the specific Logger name to distinguish the configured instance.

See Also:

• Constant Field Values

Constructor Details

OfficeFrame

public OfficeFrame()

Method Details

setInstance

public static final void setInstance(OfficeFrame singleton)

Specifies the OfficeFrame implementation. Allows for overriding the default implementation.

Parameters:

singleton - OfficeFrame implementation.

getInstance

public static final OfficeFrame getInstance()

Obtains the the Singleton instance of the OfficeFrame.

Returns:

Singleton OfficeFrame.

createOfficeFloorBuilder

public static final OfficeFloorBuilder createOfficeFloorBuilder()

Convenience method to create a single OfficeFloorBuilder, as there is typically only one OfficeFloor per JVM.

If more than one OfficeFloor is required, use the OfficeFrame returned from getInstance().

Returns:

OfficeFloorBuilder.

getLogger

public static Logger getLogger(String loggerName)

Obtains the Logger.

Parameters:

loggerName - Name of Logger.

Returns:

Logger.

createOfficeFloorBuilder

public abstract OfficeFloorBuilder createOfficeFloorBuilder(String officeFloorName)

Obtains the OfficeFloorBuilder.

Parameters:

officeFloorName - Name of the OfficeFloor.

Returns:

OfficeFloorBuilder.