Package net.officefloor.frame.test

Class SafeCompleteFlowCallback

java.lang.Object

net.officefloor.frame.test.CompleteFlowCallback

net.officefloor.frame.test.SafeCompleteFlowCallback

All Implemented Interfaces:

FlowCallback

public class SafeCompleteFlowCallback
extends CompleteFlowCallback

Thread safe CompleteFlowCallback.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class net.officefloor.frame.test.CompleteFlowCallback

isComplete

Fields inherited from interface net.officefloor.frame.api.function.FlowCallback

ESCALATE

Constructor Summary

Constructors

Constructor	Description
SafeCompleteFlowCallback()

Method Summary

Modifier and Type	Method	Description
void	assertComplete()	Asserts the Flow is complete.
void	assertNotComplete()	Asserts the Flow is not complete.
void	run(Throwable escalation)	Invoked on completion of the Flow.
Thread	waitUntilComplete(int maxWaitTimeInMilliseconds)	Waits until FlowCallback is complete.

Methods inherited from class net.officefloor.frame.test.CompleteFlowCallback

assertComplete, assertNotComplete

Methods inherited from class java.lang.Object

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

Constructor Details

SafeCompleteFlowCallback

public SafeCompleteFlowCallback()

Method Details

waitUntilComplete

public Thread waitUntilComplete(int maxWaitTimeInMilliseconds)

Waits until FlowCallback is complete.

Parameters:

maxWaitTimeInMilliseconds - Maximum wait time in milliseconds.

Returns:

Thread that completed the FlowCallback.

assertComplete

public void assertComplete()
                    throws Exception

Description copied from class: CompleteFlowCallback

Asserts the Flow is complete.

Overrides:

assertComplete in class CompleteFlowCallback

Throws:

Exception - If failure in execution.

assertNotComplete

public void assertNotComplete()
                       throws Exception

Description copied from class: CompleteFlowCallback

Asserts the Flow is not complete.

Overrides:

assertNotComplete in class CompleteFlowCallback

Throws:

Exception - If failure in execution.

run

public void run(Throwable escalation)
         throws Throwable

Description copied from interface: FlowCallback

Invoked on completion of the Flow.

Specified by:

run in interface FlowCallback

Overrides:

run in class CompleteFlowCallback

Parameters:

escalation - Possible Throwable from the Flow. null indicates all Escalation instances handled within Flow.

Throws:

Throwable - Escalation within the callback logic.