net.officefloor.frame.test

Class MockAdministratorSource

java.lang.Object

net.officefloor.frame.test.MockAdministratorSource

All Implemented Interfaces:

AdministratorSource<Object,Indexed>

@TestSource
public class MockAdministratorSource
extends Object
implements AdministratorSource<Object,Indexed>

Mock implementation of the AdministratorSource for testing.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
protected net.officefloor.frame.test.MockAdministratorSource.TaskAdministratorSourceState	taskAdministratorSourceState TaskAdministratorSourceState.

Constructor Summary

Constructors

Constructor and Description
MockAdministratorSource() Default constructor.

Method Summary

Modifier and Type	Method and Description
static <A extends Enum<A>> AdministratorBuilder<A>	bindAdministrator(String name, Administrator<?,A> administrator, AdministratorSourceMetaData<?,A> sourceMetaData, OfficeBuilder officeBuilder) Convenience method to bind the Administrator instance to the AdministratorBuilder.
Administrator	createAdministrator() Creates a new Administrator.
AdministratorSourceMetaData	getMetaData() Obtains the meta-data to describe this.
AdministratorSourceSpecification	getSpecification() Obtains the specification for this.
void	init(AdministratorSourceContext context) Called only once after the AdministratorSource is instantiated.

Methods inherited from class java.lang.Object

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

Field Detail

taskAdministratorSourceState

protected net.officefloor.frame.test.MockAdministratorSource.TaskAdministratorSourceState taskAdministratorSourceState

TaskAdministratorSourceState.

Constructor Detail

MockAdministratorSource

public MockAdministratorSource()

Default constructor.

Method Detail

bindAdministrator

public static <A extends Enum<A>> AdministratorBuilder<A> bindAdministrator(String name,
                                                                            Administrator<?,A> administrator,
                                                                            AdministratorSourceMetaData<?,A> sourceMetaData,
                                                                            OfficeBuilder officeBuilder)

Convenience method to bind the Administrator instance to the AdministratorBuilder.

Type Parameters:

A - Administration key.

Parameters:

name - Name to bind under.

administrator - Administrator to bind.

sourceMetaData - AdministratorSourceMetaData to bind.

officeBuilder - OfficeBuilder.

Returns:

AdministratorBuilder for additional configuration.

getSpecification

public AdministratorSourceSpecification getSpecification()

Description copied from interface: AdministratorSource

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 AdministratorSource<Object,Indexed>

Returns:

Specification of this.

init

public void init(AdministratorSourceContext context)
          throws Exception

Description copied from interface: AdministratorSource

Called only once after the AdministratorSource is instantiated.

Specified by:

init in interface AdministratorSource<Object,Indexed>

Parameters:

context - AdministratorSourceContext to initialise this instance of the AdministratorSource.

Throws:

Exception - Should the AdministratorSource fail to configure itself from the input properties.

getMetaData

public AdministratorSourceMetaData getMetaData()

Description copied from interface: AdministratorSource

Obtains the meta-data to describe this.

This is called after the AdministratorSource.init(AdministratorSourceContext) method and therefore may use the configuration.

This should always return non-null. If there is a problem due to incorrect configuration, the AdministratorSource.init(AdministratorSourceContext) should indicate this via an exception.

Specified by:

getMetaData in interface AdministratorSource<Object,Indexed>

Returns:

Meta-data to describe this.

createAdministrator

public Administrator createAdministrator()

Description copied from interface: AdministratorSource

Creates a new Administrator.

Specified by:

createAdministrator in interface AdministratorSource<Object,Indexed>

Returns:

New Administrator.