Package net.officefloor.plugin.managedobject.singleton

Class Singleton

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<None,None>

net.officefloor.plugin.managedobject.singleton.Singleton

All Implemented Interfaces:

ExtensionFactory<Object>, ManagedObject, ManagedObjectSource<None,None>

@PrivateSource
public class Singleton
extends AbstractManagedObjectSource<None,None>
implements ManagedObject, ExtensionFactory<Object>

Provides a singleton object.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Constructor Summary

Constructors

Constructor	Description
Singleton(Object object)	Initiate.

Method Summary

Modifier and Type	Method	Description
Object	createExtension(ManagedObject managedObject)	Creates the specific extension for the ManagedObject.
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
Object	getObject()	Obtains the object being managed.
static OfficeManagedObject	load(OfficeArchitect architect, Object singleton, AutoWire... autoWires)	Convenience method to load singleton Object.
static OfficeManagedObject	load(OfficeArchitect architect, String managedObjectName, Object singleton, AutoWire... autoWires)	Convenience method to load singleton Object.
static OfficeFloorManagedObject	load(OfficeFloorDeployer deployer, Object singleton, DeployedOffice managingOffice, AutoWire... autoWires)	Convenience method to load singleton Object.
static OfficeFloorManagedObject	load(OfficeFloorDeployer deployer, String managedObjectName, Object singleton, DeployedOffice managingOffice, AutoWire... autoWires)	Convenience method to load singleton Object.
static SectionManagedObject	load(SectionDesigner designer, Object singleton)	Convenience method to load singleton Object.
static SectionManagedObject	load(SectionDesigner designer, String managedObjectName, Object singleton)	Convenience method to load singleton Object.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	Overridden to load specifications.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

Singleton

public Singleton(Object object)

Initiate.

Parameters:

object - Singleton object.

Method Details

load

public static OfficeFloorManagedObject load(OfficeFloorDeployer deployer,
 Object singleton,
 DeployedOffice managingOffice,
 AutoWire... autoWires)

Convenience method to load singleton Object.

Parameters:

deployer - OfficeFloorDeployer.

singleton - Singleton Object.

managingOffice - Managing DeployedOffice.

autoWires - Optional AutoWire instances for the singleton.

Returns:

OfficeFloorManagedObject for the singleton.

load

public static OfficeFloorManagedObject load(OfficeFloorDeployer deployer,
 String managedObjectName,
 Object singleton,
 DeployedOffice managingOffice,
 AutoWire... autoWires)

Convenience method to load singleton Object.

Parameters:

deployer - OfficeFloorDeployer.

managedObjectName - Name of OfficeManagedObject.

singleton - Singleton Object.

managingOffice - Managing DeployedOffice.

autoWires - Optional AutoWire instances for the singleton.

Returns:

OfficeFloorManagedObject for the singleton.

load

public static OfficeManagedObject load(OfficeArchitect architect,
 Object singleton,
 AutoWire... autoWires)

Convenience method to load singleton Object.

Parameters:

architect - OfficeArchitect.

singleton - Singleton Object.

autoWires - Optional AutoWire instances for the singleton.

Returns:

OfficeManagedObject for the singleton.

load

public static OfficeManagedObject load(OfficeArchitect architect,
 String managedObjectName,
 Object singleton,
 AutoWire... autoWires)

Convenience method to load singleton Object.

Parameters:

architect - OfficeArchitect.

managedObjectName - Name of OfficeManagedObject.

singleton - Singleton Object.

autoWires - Optional AutoWire instances for the singleton.

Returns:

OfficeManagedObject for the singleton.

load

public static SectionManagedObject load(SectionDesigner designer,
 Object singleton)

Convenience method to load singleton Object.

Parameters:

designer - SectionDesigner.

singleton - Singleton Object.

Returns:

SectionManagedObject.

load

public static SectionManagedObject load(SectionDesigner designer,
 String managedObjectName,
 Object singleton)

Convenience method to load singleton Object.

Parameters:

designer - SectionDesigner.

managedObjectName - Name of SectionManagedObject.

singleton - Singleton Object.

Returns:

SectionManagedObject.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

getManagedObject

protected ManagedObject getManagedObject()

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,None>

Returns:

ManagedObject.

getObject

public Object getObject()

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

createExtension

public Object createExtension(ManagedObject managedObject)

Description copied from interface: ExtensionFactory

Creates the specific extension for the ManagedObject.

Specified by:

createExtension in interface ExtensionFactory<Object>

Parameters:

managedObject - ManagedObject that is have the extension created for it.

Returns:

Extension for the ManagedObject.