Package net.officefloor.test

Class AbstractOfficeFloorJUnit

java.lang.Object

net.officefloor.test.AbstractOfficeFloorJUnit

All Implemented Interfaces:

OfficeFloorJUnit

Direct Known Subclasses:

OfficeFloorRule

public abstract class AbstractOfficeFloorJUnit
extends java.lang.Object
implements OfficeFloorJUnit

Abstract JUnit functionality for OfficeFloor.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AbstractOfficeFloorJUnit()

Method Summary

Modifier and Type	Method	Description
protected void	afterAll()	Undertakes the after all logic.
protected void	afterEach()	Undertakes the after each logic.
protected void	beforeAll()	Undertakes the before all logic.
protected void	beforeEach(java.lang.Object testInstance)	Undertakes the before each logic.
protected void	closeOfficeFloor()	Closes the OfficeFloor.
protected abstract void	doFail(java.lang.String message)	Undertake JUnit version specific fail.
protected abstract java.lang.Error	doFail(java.lang.Throwable cause)	Undertake JUnit version specific fail.
protected java.lang.Object	getDependency(FromOffice fromOffice, StatePoint statePoint)	Obtains the qualifier for the StatePoint.
OfficeFloor	getOfficeFloor()	Obtains the OfficeFloor.
protected java.util.function.Consumer<OfficeFloor>	initialiseOfficeFloorCompiler(OfficeFloorCompiler compiler)	Initialises the OfficeFloorCompiler.
void	invokeProcess(java.lang.String functionName, java.lang.Object parameter)	Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.
void	invokeProcess(java.lang.String functionName, java.lang.Object parameter, long waitTime)	Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.
void	invokeProcess(java.lang.String officeName, java.lang.String functionName, java.lang.Object parameter, long waitTime)	Convenience method to invoke the ProcessState for the ManagedFunction.
protected boolean	isDependencyAvailable(FromOffice fromOffice, StatePoint statePoint)	Determines if the dependency is available.
protected void	openOfficeFloor()	Opens the OfficeFloor.
protected void	setDependencyLoadTimeout(long dependencyLoadTimeout)	Specifies the dependency load timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOfficeFloorJUnit

public AbstractOfficeFloorJUnit()

Method Detail

doFail

protected abstract void doFail(java.lang.String message)

Undertake JUnit version specific fail.

Parameters:

message - Message for the fail.

doFail

protected abstract java.lang.Error doFail(java.lang.Throwable cause)

Undertake JUnit version specific fail.

Parameters:

cause - Cause of the failure.

Returns:

Error to propagate.

setDependencyLoadTimeout

protected void setDependencyLoadTimeout(long dependencyLoadTimeout)

Specifies the dependency load timeout.

Parameters:

dependencyLoadTimeout - Dependency load timeout.

beforeAll

protected void beforeAll()
                  throws java.lang.Exception

Undertakes the before all logic.

Throws:

java.lang.Exception - If fails.

beforeEach

protected void beforeEach(java.lang.Object testInstance)
                   throws java.lang.Exception

Undertakes the before each logic.

Parameters:

testInstance - Test instance.

Throws:

java.lang.Exception - If fails.

afterEach

protected void afterEach()
                  throws java.lang.Exception

Undertakes the after each logic.

Throws:

java.lang.Exception - If fails.

afterAll

protected void afterAll()
                 throws java.lang.Exception

Undertakes the after all logic.

Throws:

java.lang.Exception - If fails.

initialiseOfficeFloorCompiler

protected java.util.function.Consumer<OfficeFloor> initialiseOfficeFloorCompiler(OfficeFloorCompiler compiler)

Initialises the OfficeFloorCompiler.

Parameters:

compiler - OfficeFloorCompiler.

Returns:

Consumer to load the opened OfficeFloor.

openOfficeFloor

protected void openOfficeFloor()
                        throws java.lang.Exception

Opens the OfficeFloor.

Throws:

java.lang.Exception - If fails to open the OfficeFloor.

isDependencyAvailable

protected boolean isDependencyAvailable(FromOffice fromOffice,
                                        StatePoint statePoint)
                                 throws java.lang.Exception

Determines if the dependency is available.

Parameters:

fromOffice - FromOffice.

statePoint - StatePoint.

Returns:

true if the dependency is available.

Throws:

java.lang.Exception - If fails to determine dependency available.

getDependency

protected java.lang.Object getDependency(FromOffice fromOffice,
                                         StatePoint statePoint)
                                  throws java.lang.Exception

Obtains the qualifier for the StatePoint.

Parameters:

fromOffice - FromOffice.

statePoint - StatePoint.

Returns:

Dependency.

Throws:

java.lang.Exception - If fails to obtain the dependency.

closeOfficeFloor

protected void closeOfficeFloor()
                         throws java.lang.Exception

Closes the OfficeFloor.

Throws:

java.lang.Exception - If fails to close the OfficeFloor.

getOfficeFloor

public OfficeFloor getOfficeFloor()

Description copied from interface: OfficeFloorJUnit

Obtains the OfficeFloor.

Specified by:

getOfficeFloor in interface OfficeFloorJUnit

Returns:

OfficeFloor.

invokeProcess

public void invokeProcess(java.lang.String functionName,
                          java.lang.Object parameter)

Description copied from interface: OfficeFloorJUnit

Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.

Specified by:

invokeProcess in interface OfficeFloorJUnit

Parameters:

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

invokeProcess

public void invokeProcess(java.lang.String functionName,
                          java.lang.Object parameter,
                          long waitTime)

Description copied from interface: OfficeFloorJUnit

Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.

Specified by:

invokeProcess in interface OfficeFloorJUnit

Parameters:

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

waitTime - Time in milliseconds to wait for ProcessState to complete.

invokeProcess

public void invokeProcess(java.lang.String officeName,
                          java.lang.String functionName,
                          java.lang.Object parameter,
                          long waitTime)

Description copied from interface: OfficeFloorJUnit

Convenience method to invoke the ProcessState for the ManagedFunction.

Specified by:

invokeProcess in interface OfficeFloorJUnit

Parameters:

officeName - Name of the Office containing the ManagedFunction.

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

waitTime - Time in milliseconds to wait for ProcessState to complete.