Class OfficeFrame
- Direct Known Subclasses:
OfficeFrameImpl
Office Frame to create the OfficeFloor.
This is the starting point to use the framework.
- Author:
- Daniel Sagenschneider
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringSystem.getProperty(String)that flags to infer the sourceClassundertaking the logging. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final OfficeFloorBuilderConvenience method to create a singleOfficeFloorBuilder, as there is typically only oneOfficeFloorper JVM.abstract OfficeFloorBuildercreateOfficeFloorBuilder(String officeFloorName) Obtains theOfficeFloorBuilder.static final OfficeFrameObtains the the Singleton instance of theOfficeFrame.static LoggerObtains theLogger.static final voidsetInstance(OfficeFrame singleton) Specifies theOfficeFrameimplementation.
-
Field Details
-
IMPLEMENTATION_CLASS_PROPERTY_NAME
System.getProperty(String)that allows specifying theOfficeFrameimplementationClass.Should this not be specified the default
OfficeFrameImplwill be used.Note: it is anticipated that
OfficeFrameImplwill always be used.- See Also:
-
LOG_SOURCE_CLASS_PROPERTY_NAME
System.getProperty(String)that flags to infer the sourceClassundertaking the logging.By default the
Loggerinstances will specify anullsourceClassname so that theLoggername is used by theSimpleFormatter. This will then result inLogRecordinstances formatted with theLoggername.Flagging this
truewill allow the sourceClassname to be inferred. However, aFormatterwill likely need to be configured to indicate the specificLoggername to distinguish the configured instance.- See Also:
-
-
Constructor Details
-
OfficeFrame
public OfficeFrame()
-
-
Method Details
-
setInstance
Specifies theOfficeFrameimplementation. Allows for overriding the default implementation.- Parameters:
singleton-OfficeFrameimplementation.
-
getInstance
Obtains the the Singleton instance of theOfficeFrame.- Returns:
- Singleton
OfficeFrame.
-
createOfficeFloorBuilder
Convenience method to create a single
OfficeFloorBuilder, as there is typically only oneOfficeFloorper JVM.If more than one
OfficeFlooris required, use theOfficeFramereturned fromgetInstance().- Returns:
OfficeFloorBuilder.
-
getLogger
Obtains theLogger. -
createOfficeFloorBuilder
Obtains theOfficeFloorBuilder.- Parameters:
officeFloorName- Name of theOfficeFloor.- Returns:
OfficeFloorBuilder.
-