io.datakernel.async

Class SettableStage<T>

java.lang.Object

io.datakernel.async.SettableStage<T>

Type Parameters:

T - Result type

All Implemented Interfaces:

Callback<T>, Stage<T>

public final class SettableStage<T>
extends Object
implements Callback<T>

Stage that can be completed or completedExceptionally manually.

Can be used as root stage to start execution of chain of stages or when you want wrap your actions in Stage

Nested Class Summary

Nested classes/interfaces inherited from interface io.datakernel.async.Stage

Stage.ThrowingFunction<T,R>

Field Summary

Fields

Modifier and Type	Field and Description
protected Throwable	exception
protected BiConsumer<? super T,Throwable>	next
protected T	result

Fields inherited from interface io.datakernel.async.Callback

IGNORE_CALLBACK

Fields inherited from interface io.datakernel.async.Stage

TIMEOUT_EXCEPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettableStage()

Method Summary

Modifier and Type	Method and Description
Stage<Void>	both(Stage<?> other) Combines two Stage in one and completes when both have been completed.
<U,V> Stage<V>	combine(Stage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn) Combines two Stage in one using fn.
protected void	complete(T value)
protected void	complete(T value, Throwable error)
protected void	completeExceptionally(Throwable error)
static <T> SettableStage<T>	create()
Stage<T>	either(Stage<? extends T> other) Combines two Stage in one.
boolean	isComplete()
boolean	isSet()
Stage<T>	post() When this stage is completed it's completion will be postponed to the next eventloop tick.
Stage<T>	postTo(Eventloop eventloop)
void	set(T result) Sets the result of this SettableStage and completes it.
void	setException(Throwable t) Sets exception and completes this SettableStage exceptionally.
protected void	subscribe(BiConsumer<? super T,Throwable> next)
<U,S extends BiConsumer<? super T,Throwable> & Stage<U>> Stage<U>	then(S stage) Executes given stage after execution of this stage completes
<U> Stage<U>	thenApply(Function<? super T,? extends U> fn) Applies fn to the result of this Stage
<U> Stage<U>	thenApplyEx(BiFunction<? super T,Throwable,? extends U> fn) Applies fn to the result or exception of this Stage
<U> Stage<U>	thenCompose(Function<? super T,? extends Stage<U>> fn) Applies function to the result of this stage if it completes successfully.
<U> Stage<U>	thenComposeEx(BiFunction<? super T,Throwable,? extends Stage<U>> fn) Applies function to the result of this stage.
Stage<T>	thenException(Function<? super T,Throwable> fn)
Stage<T>	thenRun(Runnable action) Runs action after successful completion of this stage
Stage<T>	thenRunEx(Runnable action) Runs action after completion of this stage
<U> Stage<U>	thenTry(Stage.ThrowingFunction<? super T,? extends U> fn)
Stage<T>	timeout(Duration timeout) Returns stage that completes successfully if this stage completes before timeout.
CompletableFuture<T>	toCompletableFuture() Wraps Stage into CompletableFuture
String	toString()
Stage<Try<T>>	toTry() Returns stage that always completes successfully with result or exception wrapped in Try
Stage<Void>	toVoid() Waits for result and discard it.
protected void	tryComplete(T value)
protected void	tryComplete(T value, Throwable error)
protected void	tryCompleteExceptionally(Throwable error)
boolean	trySet(T result) The same as trySet(Object, Throwable) )} but for result only.
boolean	trySet(T result, Throwable throwable) Tries to set result or exception for this SettableStage if it not yet set.
boolean	trySetException(Throwable t) The same as trySet(Object, Throwable) )} but for exception only.
Stage<T>	whenComplete(BiConsumer<? super T,Throwable> action) Subscribes given action to be executed after this stage completes
Stage<T>	whenException(Consumer<Throwable> action) Subscribes given action to be executed after this stage completes exceptionally
Stage<T>	whenResult(Consumer<? super T> action) Subscribes given action to be executed after this stage completes successfully

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.datakernel.async.Callback

assertNoCalls, assertNoExceptions, forBiConsumer, forFuture, ignore, set, stageToCallback

Methods inherited from interface io.datakernel.async.Stage

of, of, ofCallable, ofCallback, ofCompletionStage, ofException, ofFuture, ofFuture, ofRunnable, ofThrowingRunnable, thenCallback

Field Detail

result

@Nullable
protected T result

exception

@Nullable
protected Throwable exception

next

protected BiConsumer<? super T,Throwable> next

Constructor Detail

SettableStage

protected SettableStage()

Method Detail

create

public static <T> SettableStage<T> create()

set

public void set(@Nullable
                T result)

Sets the result of this SettableStage and completes it.

AssertionError is thrown when you try to set result for already completed stage.

Specified by:

set in interface Callback<T>

setException

public void setException(Throwable t)

Sets exception and completes this SettableStage exceptionally.

AssertionError is thrown when you try to set exception for already completed stage.

Specified by:

setException in interface Callback<T>

Parameters:

t - exception

trySet

public boolean trySet(@Nullable
                      T result)

The same as trySet(Object, Throwable) )} but for result only.

trySetException

public boolean trySetException(Throwable t)

The same as trySet(Object, Throwable) )} but for exception only.

trySet

public boolean trySet(@Nullable
                      T result,
                      @Nullable
                      Throwable throwable)

Tries to set result or exception for this SettableStage if it not yet set.

Otherwise do nothing

Returns:

true if result or exception was set, false otherwise

subscribe

protected void subscribe(BiConsumer<? super T,Throwable> next)

isSet

public boolean isSet()

Returns:

true if this SettableStage result is not set, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

isComplete

public boolean isComplete()

complete

protected void complete(@Nullable
                        T value,
                        @Nullable
                        Throwable error)

complete

protected void complete(@Nullable
                        T value)

completeExceptionally

protected void completeExceptionally(@Nullable
                                     Throwable error)

tryComplete

protected void tryComplete(@Nullable
                           T value,
                           @Nullable
                           Throwable error)

tryComplete

protected void tryComplete(@Nullable
                           T value)

tryCompleteExceptionally

protected void tryCompleteExceptionally(Throwable error)

then

public <U,S extends BiConsumer<? super T,Throwable> & Stage<U>> Stage<U> then(S stage)

Description copied from interface: Stage

Executes given stage after execution of this stage completes

Specified by:

then in interface Stage<T>

Type Parameters:

U - type of result

Parameters:

stage - given stage

Returns:

subscribed Stage

thenApply

public <U> Stage<U> thenApply(Function<? super T,? extends U> fn)

Description copied from interface: Stage

Applies fn to the result of this Stage

Specified by:

thenApply in interface Stage<T>

Parameters:

fn - function to apply

Returns:

Stage that will apply given function

thenApplyEx

public <U> Stage<U> thenApplyEx(BiFunction<? super T,Throwable,? extends U> fn)

Description copied from interface: Stage

Applies fn to the result or exception of this Stage

Specified by:

thenApplyEx in interface Stage<T>

Parameters:

fn - function to apply

Returns:

Stage that will apply given function

whenResult

public Stage<T> whenResult(Consumer<? super T> action)

Description copied from interface: Stage

Subscribes given action to be executed after this stage completes successfully

Specified by:

whenResult in interface Stage<T>

Parameters:

action - to be executed

Returns:

this Stage

thenRun

public Stage<T> thenRun(Runnable action)

Description copied from interface: Stage

Runs action after successful completion of this stage

Specified by:

thenRun in interface Stage<T>

Parameters:

action - to be executed

Returns:

this stage

thenRunEx

public Stage<T> thenRunEx(Runnable action)

Description copied from interface: Stage

Runs action after completion of this stage

Specified by:

thenRunEx in interface Stage<T>

Parameters:

action - to be executed

Returns:

this stage

thenCompose

public <U> Stage<U> thenCompose(Function<? super T,? extends Stage<U>> fn)

Description copied from interface: Stage

Applies function to the result of this stage if it completes successfully. Returned stage will be completed when stage returned from function completes.

Specified by:

thenCompose in interface Stage<T>

Parameters:

fn - to be applied

thenComposeEx

public <U> Stage<U> thenComposeEx(BiFunction<? super T,Throwable,? extends Stage<U>> fn)

Description copied from interface: Stage

Applies function to the result of this stage. Returned stage will be completed when stage returned from function completes.

Specified by:

thenComposeEx in interface Stage<T>

Parameters:

fn - to be applied

Returns:

this stage

whenComplete

public Stage<T> whenComplete(BiConsumer<? super T,Throwable> action)

Description copied from interface: Stage

Subscribes given action to be executed after this stage completes

Specified by:

whenComplete in interface Stage<T>

Parameters:

action - to be executed

Returns:

this Stage

whenException

public Stage<T> whenException(Consumer<Throwable> action)

Description copied from interface: Stage

Subscribes given action to be executed after this stage completes exceptionally

Specified by:

whenException in interface Stage<T>

Parameters:

action - to be executed

Returns:

this Stage

thenException

public Stage<T> thenException(Function<? super T,Throwable> fn)

Specified by:

thenException in interface Stage<T>

thenTry

public <U> Stage<U> thenTry(Stage.ThrowingFunction<? super T,? extends U> fn)

Specified by:

thenTry in interface Stage<T>

combine

public <U,V> Stage<V> combine(Stage<? extends U> other,
                              BiFunction<? super T,? super U,? extends V> fn)

Description copied from interface: Stage

Combines two Stage in one using fn.

Specified by:

combine in interface Stage<T>

Parameters:

other - Stage to combine

fn - function to combine results of both stages into one

Returns:

Stage that completes when fn was applied on the result of both stages

both

public Stage<Void> both(Stage<?> other)

Description copied from interface: Stage

Combines two Stage in one and completes when both have been completed.

Specified by:

both in interface Stage<T>

Parameters:

other - Stage to combine

either

public Stage<T> either(Stage<? extends T> other)

Description copied from interface: Stage

Combines two Stage in one.

Specified by:

either in interface Stage<T>

Parameters:

other - Stage to combine

Returns:

result of the first completed Stage

post

public Stage<T> post()

Description copied from interface: Stage

When this stage is completed it's completion will be postponed to the next eventloop tick.

Specified by:

post in interface Stage<T>

postTo

public Stage<T> postTo(Eventloop eventloop)

Specified by:

postTo in interface Stage<T>

toTry

public Stage<Try<T>> toTry()

Description copied from interface: Stage

Returns stage that always completes successfully with result or exception wrapped in Try

Specified by:

toTry in interface Stage<T>

See Also:

Try

toVoid

public Stage<Void> toVoid()

Description copied from interface: Stage

Waits for result and discard it.

Specified by:

toVoid in interface Stage<T>

timeout

public Stage<T> timeout(@Nullable
                        Duration timeout)

Description copied from interface: Stage

Returns stage that completes successfully if this stage completes before timeout. Otherwise it completes with timeout exception. If null is given, no timeout is applied.

Specified by:

timeout in interface Stage<T>

Parameters:

timeout - timeout in milliseconds

toCompletableFuture

public CompletableFuture<T> toCompletableFuture()

Description copied from interface: Stage

Wraps Stage into CompletableFuture

Specified by:

toCompletableFuture in interface Stage<T>