Package net.officefloor.frame.util

Class ManagedObjectUserStandAlone

java.lang.Object

net.officefloor.frame.util.ManagedObjectUserStandAlone

All Implemented Interfaces:

AsynchronousContext, ManagedObjectContext, ObjectRegistry, ManagedObjectUser

public class ManagedObjectUserStandAlone
extends Object
implements ManagedObjectUser, ManagedObjectContext, AsynchronousContext, ObjectRegistry

Implementation of a ManagedObjectUser to source an object from a ManagedObjectSource.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedObjectUserStandAlone()

Method Summary

Modifier and Type	Method	Description
<T extends Throwable> void	complete(AsynchronousOperation<T> operation)	Indicates that the AsynchronousManagedObject has completed and is ready for another operation.
String	getBoundName()	Obtains the name this ManagedObject is bound under.
Logger	getLogger()	Obtains the Logger for the ManagedObject.
Object	getObject(int index)	Obtains the dependency Object by its index.
Object	getObject(Enum key)	Obtains the dependency Object for the dependency key.
void	mapDependency(int index, Object dependency)	Maps the dependency for the CoordinatingManagedObject.
void	mapDependency(Enum<?> key, Object dependency)	Maps the dependency for the CoordinatingManagedObject.
<R, T extends Throwable> R	run(ProcessSafeOperation<R,T> operation)	Undertakes a ProcessSafeOperation.
void	setAsynchronousListener(AsynchronousContext listener)	Allows overriding the AsynchronousContext to initialise an AsynchronousManagedObject.
void	setBoundManagedObjectName(String boundManagedObjectName)	Specifies the bound name for a ContextAwareManagedObject.
void	setFailure(Throwable cause)	Indicates failure to obtain the ManagedObject.
void	setManagedObject(ManagedObject managedObject)	Specifies the ManagedObject to be used.
void	setObjectRegistry(ObjectRegistry<?> objectRegistry)	Allows overriding the ObjectRegistry to initialise a CoordinatingManagedObject.
void	setSourceTimeout(long sourceTimeout)	Specifies the timeout to source the ManagedObject.
ManagedObject	sourceManagedObject(ManagedObjectSource<?,?> source)	Sources the ManagedObject from the ManagedObjectSource.
ManagedObject	sourceManagedObject(ManagedObjectSource<?,?> source, boolean isWait)	Sources the ManagedObject from the ManagedObjectSource.
<T extends Throwable> void	start(AsynchronousOperation<T> operation)	Undertakes an AsynchronousOperation.

Methods inherited from class java.lang.Object

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

Constructor Details

ManagedObjectUserStandAlone

public ManagedObjectUserStandAlone()

Method Details

setSourceTimeout

public void setSourceTimeout(long sourceTimeout)

Specifies the timeout to source the ManagedObject.

Parameters:

sourceTimeout - Timeout to source the ManagedObject.

setBoundManagedObjectName

public void setBoundManagedObjectName(String boundManagedObjectName)

Specifies the bound name for a ContextAwareManagedObject.

Parameters:

boundManagedObjectName - Bound name for a ContextAwareManagedObject.

setAsynchronousListener

public void setAsynchronousListener(AsynchronousContext listener)

Allows overriding the AsynchronousContext to initialise an AsynchronousManagedObject.

Parameters:

listener - AsynchronousContext.

setObjectRegistry

public void setObjectRegistry(ObjectRegistry<?> objectRegistry)

Allows overriding the ObjectRegistry to initialise a CoordinatingManagedObject.

Parameters:

objectRegistry - ObjectRegistry.

mapDependency

public void mapDependency(int index,
 Object dependency)

Maps the dependency for the CoordinatingManagedObject.

Parameters:

index - Index of the dependency.

dependency - Dependency.

mapDependency

public void mapDependency(Enum<?> key,
 Object dependency)

Maps the dependency for the CoordinatingManagedObject.

Parameters:

key - Key of the dependency.

dependency - Dependency.

sourceManagedObject

public ManagedObject sourceManagedObject(ManagedObjectSource<?,?> source)
                                  throws Throwable

Sources the ManagedObject from the ManagedObjectSource.

Parameters:

source - ManagedObjectSource.

Returns:

ManagedObject from the ManagedObjectSource.

Throws:

Throwable - If fails to source the ManagedObject.

sourceManagedObject

public ManagedObject sourceManagedObject(ManagedObjectSource<?,?> source,
 boolean isWait)
                                  throws Throwable

Sources the ManagedObject from the ManagedObjectSource.

Parameters:

source - ManagedObjectSource.

isWait - Flags to wait for ManagedObjectSource to provide the ManagedObject.

Returns:

ManagedObject from the ManagedObjectSource or null if not waiting and not sourced immediately.

Throws:

Throwable - If fails to source the ManagedObject.

setManagedObject

public void setManagedObject(ManagedObject managedObject)

Description copied from interface: ManagedObjectUser

Specifies the ManagedObject to be used.

This will be called by the ManagedObjectSource.sourceManagedObject(ManagedObjectUser) method to provide the ManagedObject to this ManagedObjectUser.

Specified by:

setManagedObject in interface ManagedObjectUser

Parameters:

managedObject - ManagedObject to be used.

setFailure

public void setFailure(Throwable cause)

Description copied from interface: ManagedObjectUser

Indicates failure to obtain the ManagedObject.

Specified by:

setFailure in interface ManagedObjectUser

Parameters:

cause - Cause of the failure.

getBoundName

public String getBoundName()

Description copied from interface: ManagedObjectContext

Obtains the name this ManagedObject is bound under.

This is useful to have a unique name identifying the ManagedObject.

Specified by:

getBoundName in interface ManagedObjectContext

Returns:

Name this ManagedObject is bound under.

getLogger

public Logger getLogger()

Description copied from interface: ManagedObjectContext

Obtains the Logger for the ManagedObject.

Specified by:

getLogger in interface ManagedObjectContext

Returns:

Logger for the ManagedObject.

run

public <R,
T extends Throwable> R run(ProcessSafeOperation<R,T> operation)
                              throws T

Description copied from interface: ManagedObjectContext

Undertakes a ProcessSafeOperation.

Specified by:

run in interface ManagedObjectContext

Type Parameters:

R - Return type from operation

T - Possible Throwable type from operation.

Parameters:

operation - ProcessSafeOperation.

Returns:

Return value.

Throws:

T - Possible Throwable.

start

public <T extends Throwable> void start(AsynchronousOperation<T> operation)

Description copied from interface: AsynchronousContext

Undertakes an AsynchronousOperation.

Specified by:

start in interface AsynchronousContext

Type Parameters:

T - Possible exception type from AsynchronousOperation.

Parameters:

operation - Optional operation to be undertaken, once the AsynchronousManagedObject is registered as started an asynchronous operation. May be null.

complete

public <T extends Throwable> void complete(AsynchronousOperation<T> operation)

Description copied from interface: AsynchronousContext

Indicates that the AsynchronousManagedObject has completed and is ready for another operation.

Specified by:

complete in interface AsynchronousContext

Type Parameters:

T - Possible exception type from AsynchronousOperation.

Parameters:

operation - Optional operation to be undertaken, once the AsynchronousManagedObject is unregistered from undertaking an asynchronous operation. May be null.

getObject

public Object getObject(Enum key)

Description copied from interface: ObjectRegistry

Obtains the dependency Object for the dependency key.

Specified by:

getObject in interface ObjectRegistry

Parameters:

key - Key identifying the dependency Object.

Returns:

Dependency Object for the key.

getObject

public Object getObject(int index)

Description copied from interface: ObjectRegistry

Obtains the dependency Object by its index.

This enables a dynamic number of dependencies for the ManagedObject.

Specified by:

getObject in interface ObjectRegistry

Parameters:

index - Index identifying the dependency Object.

Returns:

Dependency Object for the index.