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

Class ManagedObjectBuilderImpl<O extends Enum<O>,F extends Enum<F>,MS extends ManagedObjectSource<O,F>>

java.lang.Object

net.officefloor.frame.impl.construct.managedobjectsource.ManagedObjectBuilderImpl<O,F,MS>

All Implemented Interfaces:

ManagedObjectBuilder<F>, ManagedObjectSourceConfiguration<F,MS>

public class ManagedObjectBuilderImpl<O extends Enum<O>,F extends Enum<F>,MS extends ManagedObjectSource<O,F>>
extends Object
implements ManagedObjectBuilder<F>, ManagedObjectSourceConfiguration<F,MS>

Implements the ManagedObjectBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedObjectBuilderImpl(String managedObjectSourceName, Class<MS> managedObjectSourceClass)	Initiate.
ManagedObjectBuilderImpl(String managedObjectSourceName, MS managedObjectSource)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addAdditionalProfile(String profile)	Adds an additional profile.
void	addFunctionEnhancer(ManagedObjectFunctionEnhancer functionEnhancer)	Adds a ManagedObjectFunctionEnhancer.
void	addProperty(String name, String value)	Specifies a property for the ManagedObjectSource.
String[]	getAdditionalProfiles()	Obtains the additional profiles.
ManagedObjectFunctionEnhancer[]	getManagedObjectFunctionEnhancers()	Obtains the ManagedObjectFunctionEnhancer instances.
ManagedObjectPoolConfiguration	getManagedObjectPoolConfiguration()	Obtains the ManagedObjectPoolConfiguration for this ManagedObjectSource.
MS	getManagedObjectSource()	Obtains the ManagedObjectSource instance to use.
Class<MS>	getManagedObjectSourceClass()	Obtains the Class of the ManagedObjectSource.
String	getManagedObjectSourceName()	Obtains the name of this ManagedObjectSource.
ManagingOfficeConfiguration<F>	getManagingOfficeConfiguration()	Obtains the ManagingOfficeConfiguration detailing the Office responsible for managing this ManagedObjectSource.
SourceProperties	getProperties()	Obtains the SourceProperties to initialise the ManagedObjectSource.
String[]	getStartupAfter()	Obtains the names of the ManagedObjectSource to start up after.
String[]	getStartupBefore()	Obtains the names of the ManagedObjectSource to start up before.
long	getTimeout()	Obtains the timeout to: to source the ManagedObject have asynchronous operations on the ManagedObject complete
ManagedObjectPoolBuilder	setManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)	Specifies the ManagedObjectPoolFactory for this ManagedObject.
ManagingOfficeBuilder<F>	setManagingOffice(String officeName)	Specifies the Office to manage this ManagedObject.
void	setTimeout(long timeout)	Specifies the timeout to: to source the ManagedObject have asynchronous operations on the ManagedObject complete
void	startupAfter(String managedObjectSourceName)	Flags for this ManagedObjectSource to be started after the specified named ManagedObjectSource.
void	startupBefore(String managedObjectSourceName)	Flags for this ManagedObjectSource to be started before the specified named ManagedObjectSource.

Methods inherited from class java.lang.Object

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

Constructor Details

ManagedObjectBuilderImpl

public ManagedObjectBuilderImpl(String managedObjectSourceName,
 Class<MS> managedObjectSourceClass)

Initiate.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClass - Class of the ManagedObjectSource.

ManagedObjectBuilderImpl

public ManagedObjectBuilderImpl(String managedObjectSourceName,
 MS managedObjectSource)

Initiate.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Method Details

addAdditionalProfile

public void addAdditionalProfile(String profile)

Description copied from interface: ManagedObjectBuilder

Adds an additional profile.

Specified by:

addAdditionalProfile in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

profile - Additional profile.

addProperty

public void addProperty(String name,
 String value)

Description copied from interface: ManagedObjectBuilder

Specifies a property for the ManagedObjectSource.

Specified by:

addProperty in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

name - Name of property.

value - Value of property.

setManagedObjectPool

public ManagedObjectPoolBuilder setManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)

Description copied from interface: ManagedObjectBuilder

Specifies the ManagedObjectPoolFactory for this ManagedObject.

Specified by:

setManagedObjectPool in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

managedObjectPoolFactory - ManagedObjectPoolFactory for this ManagedObject.

Returns:

ManagedObjectPoolBuilder.

setTimeout

public void setTimeout(long timeout)

Description copied from interface: ManagedObjectBuilder

Specifies the timeout to:

1. to source the ManagedObject
2. have asynchronous operations on the ManagedObject complete

Specified by:

setTimeout in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

timeout - Timeout.

setManagingOffice

public ManagingOfficeBuilder<F> setManagingOffice(String officeName)

Description copied from interface: ManagedObjectBuilder

Specifies the Office to manage this ManagedObject.

Specified by:

setManagingOffice in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

officeName - Name of the Office.

Returns:

ManagingOfficeBuilder.

addFunctionEnhancer

public void addFunctionEnhancer(ManagedObjectFunctionEnhancer functionEnhancer)

Description copied from interface: ManagedObjectBuilder

Adds a ManagedObjectFunctionEnhancer.

Specified by:

addFunctionEnhancer in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

functionEnhancer - ManagedObjectFunctionEnhancer.

startupBefore

public void startupBefore(String managedObjectSourceName)

Description copied from interface: ManagedObjectBuilder

Flags for this ManagedObjectSource to be started before the specified named ManagedObjectSource.

Specified by:

startupBefore in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

managedObjectSourceName - Name of ManagedObjectSource to be started after this ManagedObjectSource.

startupAfter

public void startupAfter(String managedObjectSourceName)

Description copied from interface: ManagedObjectBuilder

Flags for this ManagedObjectSource to be started after the specified named ManagedObjectSource.

Specified by:

startupAfter in interface ManagedObjectBuilder<O extends Enum<O>>

Parameters:

managedObjectSourceName - Name of ManagedObjectSource to be started before this ManagedObjectSource.

getManagedObjectSourceName

public String getManagedObjectSourceName()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the name of this ManagedObjectSource.

Specified by:

getManagedObjectSourceName in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Name of this ManagedObjectSource.

getManagingOfficeConfiguration

public ManagingOfficeConfiguration<F> getManagingOfficeConfiguration()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the ManagingOfficeConfiguration detailing the Office responsible for managing this ManagedObjectSource.

Specified by:

getManagingOfficeConfiguration in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

ManagingOfficeConfiguration.

getManagedObjectSource

public MS getManagedObjectSource()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the ManagedObjectSource instance to use.

Specified by:

getManagedObjectSource in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

ManagedObjectSource instance to use. This may be null and therefore the ManagedObjectSourceConfiguration.getManagedObjectSourceClass() should be used to obtain the ManagedObjectSource.

getManagedObjectSourceClass

public Class<MS> getManagedObjectSourceClass()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the Class of the ManagedObjectSource.

Specified by:

getManagedObjectSourceClass in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Class of the ManagedObjectSource. Will be null if a ManagedObjectSource instance is configured.

getAdditionalProfiles

public String[] getAdditionalProfiles()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the additional profiles.

Specified by:

getAdditionalProfiles in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Additional profiles.

getProperties

public SourceProperties getProperties()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the SourceProperties to initialise the ManagedObjectSource.

Specified by:

getProperties in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

SourceProperties to initialise the ManagedObjectSource.

getManagedObjectPoolConfiguration

public ManagedObjectPoolConfiguration getManagedObjectPoolConfiguration()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the ManagedObjectPoolConfiguration for this ManagedObjectSource.

Specified by:

getManagedObjectPoolConfiguration in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

ManagedObjectPoolConfiguration for this ManagedObjectSource or null if not to be pooled.

getManagedObjectFunctionEnhancers

public ManagedObjectFunctionEnhancer[] getManagedObjectFunctionEnhancers()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the ManagedObjectFunctionEnhancer instances.

Specified by:

getManagedObjectFunctionEnhancers in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

ManagedObjectFunctionEnhancer instances.

getTimeout

public long getTimeout()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the timeout to:

1. to source the ManagedObject
2. have asynchronous operations on the ManagedObject complete

Specified by:

getTimeout in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Timeout.

getStartupBefore

public String[] getStartupBefore()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the names of the ManagedObjectSource to start up before.

Specified by:

getStartupBefore in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Names of the ManagedObjectSource to start up before.

getStartupAfter

public String[] getStartupAfter()

Description copied from interface: ManagedObjectSourceConfiguration

Obtains the names of the ManagedObjectSource to start up after.

Specified by:

getStartupAfter in interface ManagedObjectSourceConfiguration<O extends Enum<O>,F extends Enum<F>>

Returns:

Names of the ManagedObjectSource to start up after.