CompleteFlowCallback (OfficeFloor 3.27.0 API)

java.lang.Object
- net.officefloor.frame.test.CompleteFlowCallback

All Implemented Interfaces:

FlowCallback

Direct Known Subclasses:

SafeCompleteFlowCallback
```
public class CompleteFlowCallback
extends java.lang.Object
implements FlowCallback
```
FlowCallback that checks on completion and propagates failures.

Author:

Daniel Sagenschneider

Field Summary

Fields
Modifier and Type Field Description

protected boolean isComplete
Indicates if Flow is complete.
- Fields inherited from interface net.officefloor.frame.api.function.FlowCallback
  ESCALATE

Constructor Summary

Constructors
Constructor Description

CompleteFlowCallback()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`assertComplete()`	Asserts the `Flow` is complete.
`void`	`assertNotComplete()`	Asserts the `Flow` is not complete.
`void`	`run(java.lang.Throwable escalation)`	Invoked on completion of the `Flow`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - isComplete
```
protected boolean isComplete
```
    Indicates if Flow is complete.
- Constructor Detail
  - CompleteFlowCallback
```
public CompleteFlowCallback()
```
- Method Detail
  - assertComplete
```
public void assertComplete()
                    throws java.lang.Exception
```
    Asserts the Flow is complete.
    
    Throws:
    
    java.lang.Exception - If failure in execution.
  - assertNotComplete
```
public void assertNotComplete()
                       throws java.lang.Exception
```
    Asserts the Flow is not complete.
    
    Throws:
    
    java.lang.Exception - If failure in execution.
  - run
```
public void run(java.lang.Throwable escalation)
         throws java.lang.Throwable
```
    Description copied from interface: FlowCallback
    
    Invoked on completion of the Flow.
    
    Specified by:
    
    run in interface FlowCallback
    
    Parameters:
    
    escalation - Possible Throwable from the Flow. null indicates all Escalation instances handled within Flow.
    
    Throws:
    
    java.lang.Throwable - Escalation within the callback logic.