ImmediateCancelled (tiny-async-parent 1.0.0-SNAPSHOT API)

java.lang.Object
- eu.toolchain.concurrent.ImmediateCancelled<T>

Type Parameters:

T - type of the completable

All Implemented Interfaces:

Stage<T>
```
public class ImmediateCancelled<T>
extends Object
implements Stage<T>
```
A stage which has already been cancelled.

Field Summary

Fields
Modifier and Type Field and Description

protected Caller caller
- Fields inherited from interface eu.toolchain.concurrent.Stage
  CANCELLED, COMPLETED, FAILED, PENDING

Fields
Modifier and Type	Field and Description
`protected Caller`	`caller`

Constructor Summary

Constructors
Constructor and Description

ImmediateCancelled(Caller caller)

Constructors
Constructor and Description
`ImmediateCancelled(Caller caller)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel()` Cancel the current stage.
`Throwable`	`cause()` Get the cause of a failed stage.
`Stage<T>`	`handle(Handle<? super T> handle)` Register a listener that is called on all three types of events for the current stage; completed, failed, and cancelled.
`boolean`	`isCancelled()` Check if stage is in the cancelled state.
`boolean`	`isCompleted()` Check if stage is completed.
`boolean`	`isDone()` Indicates if the stage is done
`boolean`	`isFailed()` Check if the stage was exceptionally completed.
`T`	`join()` Join the result of the current stage.
`T`	`join(long timeout, TimeUnit unit)` Join the result of the current stage with a timeout.
`T`	`joinNow()` Join the result of the current stage, or fail if it's state is still running.
`<U> Stage<U>`	`thenApply(Function<? super T,? extends U> fn)` Transform the value of the current stage into another type using an immediate function.
`Stage<T>`	`thenApplyFailed(Function<? super Throwable,? extends T> fn)` Apply a failed stage.
`<U> Stage<U>`	`thenCancel()` Build a stage is cancelled, but waits until the current stage completes.
`<U> Stage<U>`	`thenComplete(U result)` Build a stage is completed, but waits until the current stage completes.
`<U> Stage<U>`	`thenCompose(Function<? super T,? extends Stage<U>> fn)` Compose the current stage with the given function.
`Stage<T>`	`thenComposeCaught(Function<? super Throwable,? extends Stage<T>> fn)` Compose a failed stage.
`<U> Stage<U>`	`thenFail(Throwable cause)` Build a stage is failed, but waits until the current stage completes.
`String`	`toString()`
`Stage<T>`	`whenCancelled(Runnable runnable)` Register an listener to be called when the current stage is cancelled.
`Stage<T>`	`whenComplete(Consumer<? super T> consumer)` Register a listener to be called when the current stage is completed.
`Stage<T>`	`whenDone(Runnable runnable)` Register a listener to be called when the current stage finishes for any reason.
`Stage<T>`	`whenFailed(Consumer<? super Throwable> consumer)` Register a listener that is called when a stage is failed.
`Stage<T>`	`withCloser(Supplier<? extends Stage<Void>> complete, Supplier<? extends Stage<Void>> notComplete)` Run one of the provided stages when this stage ends up in a given state.
`Stage<T>`	`withComplete(Supplier<? extends Stage<Void>> supplier)` Run the provided stage when the current stage has completed.
`Stage<T>`	`withNotComplete(Supplier<? extends Stage<Void>> supplier)` Run the provided stage when the current stage ends, but does not complete.

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

- Field Detail
 - caller
```
protected final Caller caller
```
- Constructor Detail
 - ImmediateCancelled
```
public ImmediateCancelled(Caller caller)
```
- Method Detail
 - cancel
```
public boolean cancel()
```
 Description copied from interface: Stage
 
 Cancel the current stage.
 
 Specified by:
 
 cancel in interface Stage<T>
 
 Returns:
 
 true if the stage was cancelled by this call
 - handle
```
public Stage<T> handle(Handle<? super T> handle)
```
 Description copied from interface: Stage
 
 Register a listener that is called on all three types of events for the current stage; completed, failed, and cancelled.
 
 Specified by:
 
 handle in interface Stage<T>
 
 Parameters:
 
 handle - handle to register
 
 Returns:
 
 the current stage
 - whenDone
```
public Stage<T> whenDone(Runnable runnable)
```
 Description copied from interface: Stage
 
 Register a listener to be called when the current stage finishes for any reason.
 
 Specified by:
 
 whenDone in interface Stage<T>
 
 Parameters:
 
 runnable - function to be fired
 
 Returns:
 
 the current stage
 - whenCancelled
```
public Stage<T> whenCancelled(Runnable runnable)
```
 Description copied from interface: Stage
 
 Register an listener to be called when the current stage is cancelled.
 
 Specified by:
 
 whenCancelled in interface Stage<T>
 
 Parameters:
 
 runnable - listener to register
 
 Returns:
 
 the current stage
 - whenComplete
```
public Stage<T> whenComplete(Consumer<? super T> consumer)
```
 Description copied from interface: Stage
 
 Register a listener to be called when the current stage is completed.
 
 Specified by:
 
 whenComplete in interface Stage<T>
 
 Parameters:
 
 consumer - listener to register
 
 Returns:
 
 the current stage
 - whenFailed
```
public Stage<T> whenFailed(Consumer<? super Throwable> consumer)
```
 Description copied from interface: Stage
 
 Register a listener that is called when a stage is failed.
 
 Specified by:
 
 whenFailed in interface Stage<T>
 
 Parameters:
 
 consumer - listener to register
 
 Returns:
 
 the current stage
 - isDone
```
public boolean isDone()
```
 Description copied from interface: Stage
 
 Indicates if the stage is done
 
 Specified by:
 
 isDone in interface Stage<T>
 
 Returns:
 
 true if the stage is completed, failed, or cancelled
 - isCompleted
```
public boolean isCompleted()
```
 Description copied from interface: Stage
 
 Check if stage is completed.
 
 Specified by:
 
 isCompleted in interface Stage<T>
 
 Returns:
 
 true if the stage is in a completed state, otherwise false.
 - isFailed
```
public boolean isFailed()
```
 Description copied from interface: Stage
 
 Check if the stage was exceptionally completed.
 
 Specified by:
 
 isFailed in interface Stage<T>
 
 Returns:
 
 true if the stage is exceptionally completed
 
 See Also:
 
 Completable.fail(Throwable)
 - isCancelled
```
public boolean isCancelled()
```
 Description copied from interface: Stage
 
 Check if stage is in the cancelled state.
 
 Specified by:
 
 isCancelled in interface Stage<T>
 
 Returns:
 
 true if the stage is in a cancelled state, otherwise false.
 - cause
```
public Throwable cause()
```
 Description copied from interface: Stage
 
 Get the cause of a failed stage.
 
 Specified by:
 
 cause in interface Stage<T>
 
 Returns:
 
 the exception that cause the stage to fail
 
 See Also:
 
 Stage.isFailed()
 - join
```
public T join()
```
 Description copied from interface: Stage
 
 Join the result of the current stage.
 
 Specified by:
 
 join in interface Stage<T>
 
 Returns:
 
 the result of the computation
 - join
```
public T join(long timeout,
 TimeUnit unit)
```
 Description copied from interface: Stage
 
 Join the result of the current stage with a timeout.
 
 Specified by:
 
 join in interface Stage<T>
 
 Parameters:
 
 timeout - timeout after which TimeoutException will be thrown.
 
 unit - unit of the timeout
 
 Returns:
 
 the result of the computation
 - joinNow
```
public T joinNow()
```
 Description copied from interface: Stage
 
 Join the result of the current stage, or fail if it's state is still running.
 
 Specified by:
 
 joinNow in interface Stage<T>
 
 Returns:
 
 the result of the computation
 - thenApply
```
public  Stage thenApply(Function<? super T,? extends U> fn)
```
 Description copied from interface: Stage
 Transform the value of the current stage into another type using an immediate function.
 Translates the result of a completed stage as it becomes available:
```
 operation().thenApply(result -> result / 2);
 
```
 Specified by:
 
 thenApply in interface Stage<T>
 
 Type Parameters:
 
 U - the type of the newly applied stage
 
 Parameters:
 
 fn - transformation to use
 
 Returns:
 
 the applied stage
 - thenCompose
```
public  Stage thenCompose(Function<? super T,? extends Stage> fn)
```
 Description copied from interface: Stage
 Compose the current stage with the given function.
 When the current stage has completed, calls the given function with the result of the current stage.
```
 Stage<A> a = op1();
 Stage a.thenCompose(result -> op2(result));
 
```
 Specified by:
 
 thenCompose in interface Stage<T>
 
 Type Parameters:
 
 U - type of the composed stage
 
 Parameters:
 
 fn - the function to use when transforming the value
 
 Returns:
 
 the composed stage
 - thenApplyFailed
```
public Stage<T> thenApplyFailed(Function<? super Throwable,? extends T> fn)
```
 Description copied from interface: Stage
 
 Apply a failed stage.
 This acts like a try-catch, where the provided function is the catch operation.
 
 Specified by:
 
 thenApplyFailed in interface Stage<T>
 
 Parameters:
 
 fn - the transformation to use
 
 Returns:
 
 the applied stage
 - thenComposeCaught
```
public Stage<T> thenComposeCaught(Function<? super Throwable,? extends Stage<T>> fn)
```
 Description copied from interface: Stage
 
 Compose a failed stage.
 This acts like a try-catch, where the composed stage is the catch operation.
 If the intent is to re-throw after running the catch operation, use Stage.withNotComplete(java.util.function.Supplier)
 
 Specified by:
 
 thenComposeCaught in interface Stage<T>
 
 Parameters:
 
 fn - the transformation to use
 
 Returns:
 
 the composed stage
 - withCloser
```
public Stage<T> withCloser(Supplier<? extends Stage<Void>> complete,
 Supplier<? extends Stage<Void>> notComplete)
```
 Description copied from interface: Stage
 Run one of the provided stages when this stage ends up in a given state.
 This is typically used to implement catch-then-rethrow style operations, like the following example:
```
 beginTransaction().thenCompose(tx -> {
 return oper2(tx).withCloser(tx::commit, tx::rollback);
 });
 
```
 Specified by:
 
 withCloser in interface Stage<T>
 
 Parameters:
 
 complete - stage to run when this stage ends in a complete state
 
 notComplete - stage to run when this stage ends in a non-complete state, if the state is failed, any exception thrown in this block will suppress the original exception
 
 Returns:
 
 a new stage that depends on the supplied stage
 - withComplete
```
public Stage<T> withComplete(Supplier<? extends Stage<Void>> supplier)
```
 Description copied from interface: Stage
 
 Run the provided stage when the current stage has completed.
 
 Specified by:
 
 withComplete in interface Stage<T>
 
 Parameters:
 
 supplier - supplier of the stage to run
 
 Returns:
 
 a stage that depends on the current stage and the supplied stage
 - withNotComplete
```
public Stage<T> withNotComplete(Supplier<? extends Stage<Void>> supplier)
```
 Description copied from interface: Stage
 
 Run the provided stage when the current stage ends, but does not complete.
 
 Specified by:
 
 withNotComplete in interface Stage<T>
 
 Parameters:
 
 supplier - supplier of the stage to run
 
 Returns:
 
 a stage that depends on the current stage and the supplied stage
 - thenFail
```
public  Stage thenFail(Throwable cause)
```
 Description copied from interface: Stage
 
 Build a stage is failed, but waits until the current stage completes.
 
 Specified by:
 
 thenFail in interface Stage<T>
 
 Type Parameters:
 
 U - target type
 
 Parameters:
 
 cause - error to fail with
 
 Returns:
 
 a stage that will be failed
 - thenCancel
```
public  Stage thenCancel()
```
 Description copied from interface: Stage
 
 Build a stage is cancelled, but waits until the current stage completes.
 
 Specified by:
 
 thenCancel in interface Stage<T>
 
 Type Parameters:
 
 U - target type
 
 Returns:
 
 a stage that will be cancelled
 - thenComplete
```
public  Stage thenComplete(U result)
```
 Description copied from interface: Stage
 
 Build a stage is completed, but waits until the current stage completes.
 
 Specified by:
 
 thenComplete in interface Stage<T>
 
 Type Parameters:
 
 U - target type
 
 Parameters:
 
 result - result to complete with
 
 Returns:
 
 a stage that will be completed
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object

Class ImmediateCancelled<T>

Field Summary

Fields inherited from interface eu.toolchain.concurrent.Stage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

caller

Constructor Detail

ImmediateCancelled

Method Detail

cancel

handle

whenDone

whenCancelled

whenComplete

whenFailed

isDone

isCompleted

isFailed

isCancelled

cause

join

join

joinNow

thenApply

thenCompose

thenApplyFailed

thenComposeCaught

withCloser

withComplete

withNotComplete

thenFail

thenCancel

thenComplete

toString