Package net.officefloor.frame.test

Class MockManagedObjectSource

java.lang.Object

net.officefloor.frame.test.MockManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<None,None>

@TestSource
public class MockManagedObjectSource
extends java.lang.Object
implements ManagedObjectSource<None,None>

Mock implementation of the ManagedObjectSource for testing.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
protected net.officefloor.frame.test.MockManagedObjectSource.ManagedObjectSourceState	managedObjectSourceState	MockManagedObjectSource.ManagedObjectSourceState.

Constructor Summary

Constructors

Constructor	Description
MockManagedObjectSource()	Default constructor.

Method Summary

Modifier and Type	Method	Description
static <F extends java.lang.Enum<F>> ManagedObjectBuilder<F>	bindManagedObject(java.lang.String name, ManagedObject managedObject, ManagedObjectSourceMetaData<?,F> sourceMetaData, OfficeFloorBuilder officeFloorBuilder)	Convenience method to bind the ManagedObject instance to the ManagedObjectBuilder.
ManagedObjectSourceSpecification	getSpecification()	Obtains the specification for this.
ManagedObjectSourceMetaData<None,None>	init(ManagedObjectSourceContext context)	Initialises the ManagedObjectSource.
void	sourceManagedObject(ManagedObjectUser user)	Sources a ManagedObject from this ManagedObjectSource.
void	start(ManagedObjectExecuteContext<None> context)	Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.
void	stop()	Called to notify that the OfficeFloor is being closed.

Methods inherited from class java.lang.Object

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

Field Detail

managedObjectSourceState

protected net.officefloor.frame.test.MockManagedObjectSource.ManagedObjectSourceState managedObjectSourceState

MockManagedObjectSource.ManagedObjectSourceState.

Constructor Detail

MockManagedObjectSource

public MockManagedObjectSource()

Default constructor.

Method Detail

bindManagedObject

public static <F extends java.lang.Enum<F>> ManagedObjectBuilder<F> bindManagedObject(java.lang.String name,
                                                                                      ManagedObject managedObject,
                                                                                      ManagedObjectSourceMetaData<?,F> sourceMetaData,
                                                                                      OfficeFloorBuilder officeFloorBuilder)

Convenience method to bind the ManagedObject instance to the ManagedObjectBuilder.

Type Parameters:

F - Flow type.

Parameters:

name - Name to bind under.

managedObject - ManagedObject to bind.

sourceMetaData - ManagedObjectSourceMetaData to bind.

officeFloorBuilder - OfficeFloorBuilder to bind ManagedObject.

Returns:

ManagedObjectBuilder for additional configuration.

getSpecification

public ManagedObjectSourceSpecification getSpecification()

Description copied from interface: ManagedObjectSource

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Specified by:

getSpecification in interface ManagedObjectSource<None,None>

Returns:

Specification of this.

init

public ManagedObjectSourceMetaData<None,None> init(ManagedObjectSourceContext context)
                                                  throws java.lang.Exception

Description copied from interface: ManagedObjectSource

Initialises the ManagedObjectSource.

Specified by:

init in interface ManagedObjectSource<None,None>

Parameters:

context - ManagedObjectSourceContext to use in initialising.

Returns:

Meta-data to describe this.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to configure itself from the input properties.

start

public void start(ManagedObjectExecuteContext<None> context)
           throws java.lang.Exception

Description copied from interface: ManagedObjectSource

Called once after ManagedObjectSource.init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Specified by:

start in interface ManagedObjectSource<None,None>

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to start execution.

sourceManagedObject

public void sourceManagedObject(ManagedObjectUser user)

Description copied from interface: ManagedObjectSource

Sources a ManagedObject from this ManagedObjectSource.

Specified by:

sourceManagedObject in interface ManagedObjectSource<None,None>

Parameters:

user - ManagedObjectUser interested in using the ManagedObject.

stop

public void stop()

Description copied from interface: ManagedObjectSource

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.

Specified by:

stop in interface ManagedObjectSource<None,None>