public class CompletableResultCode
extends java.lang.Object
The implementation of Export operations are often asynchronous in nature, hence the need to convey a result at a later time. CompletableResultCode facilitates this.
Constructor and Description |
---|
CompletableResultCode() |
Modifier and Type | Method and Description |
---|---|
CompletableResultCode |
fail()
Complete this
CompletableResultCode unsuccessfully if it is not already completed. |
boolean |
isDone()
Returns whether this
CompletableResultCode has completed. |
boolean |
isSuccess()
Obtain the current state of completion.
|
CompletableResultCode |
join(long timeout,
java.util.concurrent.TimeUnit unit)
Waits for the specified amount of time for this
CompletableResultCode to complete. |
static CompletableResultCode |
ofAll(java.util.Collection<CompletableResultCode> codes)
Returns a
CompletableResultCode that completes after all the provided CompletableResultCode s complete. |
static CompletableResultCode |
ofFailure()
Returns a
CompletableResultCode that has been completed unsuccessfully. |
static CompletableResultCode |
ofSuccess()
Returns a
CompletableResultCode that has been completed successfully. |
CompletableResultCode |
succeed()
Complete this
CompletableResultCode successfully if it is not already completed. |
CompletableResultCode |
whenComplete(java.lang.Runnable action)
Perform an action on completion.
|
public static CompletableResultCode ofSuccess()
CompletableResultCode
that has been completed successfully.public static CompletableResultCode ofFailure()
CompletableResultCode
that has been completed unsuccessfully.public static CompletableResultCode ofAll(java.util.Collection<CompletableResultCode> codes)
CompletableResultCode
that completes after all the provided CompletableResultCode
s complete. If any of the results fail, the result will be failed.public CompletableResultCode succeed()
CompletableResultCode
successfully if it is not already completed.public CompletableResultCode fail()
CompletableResultCode
unsuccessfully if it is not already completed.public boolean isSuccess()
public CompletableResultCode whenComplete(java.lang.Runnable action)
action
- the action to performpublic boolean isDone()
CompletableResultCode
has completed.public CompletableResultCode join(long timeout, java.util.concurrent.TimeUnit unit)
CompletableResultCode
to complete. If
it times out or is interrupted, the CompletableResultCode
is failed.CompletableResultCode