Package org.infinispan.interceptors

Class InvocationStage

java.lang.Object

org.infinispan.interceptors.InvocationStage

Direct Known Subclasses:

ExceptionSyncInvocationStage, SimpleAsyncInvocationStage, SyncInvocationStage

public abstract class InvocationStage
extends Object

A partial command invocation, either completed or in progress.

It is similar to a CompletionStage, but it allows more callback functions to be stateless by passing the context and the invoked command as parameters.

Unlike CompletionStage, adding a callback can delay the completion of the initial stage and change its result.

Since:

9.0

Author:

Dan Berindei

Constructor Summary

Constructors

Constructor	Description
InvocationStage()

Method Summary

Modifier and Type	Method	Description
abstract <C extends VisitableCommand> Object	addCallback(InvocationContext ctx, C command, InvocationCallback<C> function)	After the current stage completes, invoke function and return its result.
<C extends VisitableCommand> Object	andExceptionally(InvocationContext ctx, C command, InvocationExceptionFunction<C> function)	After the current stage completes exceptionally, invoke function and return its result.
<C extends VisitableCommand> InvocationStage	andExceptionallyMakeStage(InvocationContext ctx, C command, InvocationExceptionFunction<C> function)	After the current stage completes exceptionally, invoke function and return its result.
<C extends VisitableCommand> Object	andFinally(InvocationContext ctx, C command, InvocationFinallyAction<C> action)	After the current stage completes, invoke action.
<C extends VisitableCommand> InvocationStage	andFinallyMakeStage(InvocationContext ctx, C command, InvocationFinallyAction<C> action)	After the current stage completes, invoke action.
<C extends VisitableCommand> Object	andHandle(InvocationContext ctx, C command, InvocationFinallyFunction<C> function)	After the current stage completes, invoke function and return its result.
<C extends VisitableCommand> InvocationStage	andHandleMakeStage(InvocationContext ctx, C command, InvocationFinallyFunction<C> function)	After the current stage completes, invoke function and return its result.
static InvocationStage	completedNullStage()
abstract Object	get()	Wait for the invocation to complete and return its value.
abstract boolean	isDone()
static InvocationStage	makeStage(Object maybeStage)	If maybeStage is not an InvocationStage, wrap it, otherwise cast it to an InvocationStage.
<C extends VisitableCommand> Object	thenAccept(InvocationContext ctx, C command, InvocationSuccessAction<C> action)	After the current stage completes successfully, invoke action.
<C extends VisitableCommand> InvocationStage	thenAcceptMakeStage(InvocationContext ctx, C command, InvocationSuccessAction<C> action)	After the current stage completes successfully, invoke action.
<C extends VisitableCommand> Object	thenApply(InvocationContext ctx, C command, InvocationSuccessFunction<C> function)	After the current stage completes successfully, invoke function and return its result.
<C extends VisitableCommand> InvocationStage	thenApplyMakeStage(InvocationContext ctx, C command, InvocationSuccessFunction<C> function)	After the current stage completes successfully, invoke function and return its result.
Object	thenReturn(InvocationContext ctx, VisitableCommand command, Object returnValue)	Overrides the return value of this InvocationStage if it is completed successfully.
abstract CompletableFuture<Object>	toCompletableFuture()	CompletableFuture conversion.

Methods inherited from class java.lang.Object

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

Constructor Details

InvocationStage

public InvocationStage()

Method Details

get

public abstract Object get()
                    throws Throwable

Wait for the invocation to complete and return its value.

Throws:

Throwable - Any exception raised during the invocation.

isDone

public abstract boolean isDone()

Returns:

true if the invocation is complete.

toCompletableFuture

public abstract CompletableFuture<Object> toCompletableFuture()

CompletableFuture conversion.

thenApply

public <C extends VisitableCommand> Object thenApply(InvocationContext ctx,
 C command,
 InvocationSuccessFunction<C> function)

After the current stage completes successfully, invoke function and return its result.

The result may be either a plain value, this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

thenAccept

public <C extends VisitableCommand> Object thenAccept(InvocationContext ctx,
 C command,
 InvocationSuccessAction<C> action)

After the current stage completes successfully, invoke action.

The result may be either a plain value, this, or a new InvocationStage. If action throws an exception, the result InvocationStage will complete with the same exception.

andExceptionally

public <C extends VisitableCommand> Object andExceptionally(InvocationContext ctx,
 C command,
 InvocationExceptionFunction<C> function)

After the current stage completes exceptionally, invoke function and return its result.

The result may be either a plain value, this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

andFinally

public <C extends VisitableCommand> Object andFinally(InvocationContext ctx,
 C command,
 InvocationFinallyAction<C> action)

After the current stage completes, invoke action.

The result may be either a plain value, this, or a new InvocationStage. If action throws an exception, the result InvocationStage will complete with the same exception.

andHandle

public <C extends VisitableCommand> Object andHandle(InvocationContext ctx,
 C command,
 InvocationFinallyFunction<C> function)

After the current stage completes, invoke function and return its result.

The result may be either a plain value, this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

addCallback

public abstract <C extends VisitableCommand> Object addCallback(InvocationContext ctx,
 C command,
 InvocationCallback<C> function)

After the current stage completes, invoke function and return its result.

The result may be either a plain value, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

thenApplyMakeStage

public <C extends VisitableCommand> InvocationStage thenApplyMakeStage(InvocationContext ctx,
 C command,
 InvocationSuccessFunction<C> function)

After the current stage completes successfully, invoke function and return its result.

The result may be either this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

thenAcceptMakeStage

public <C extends VisitableCommand> InvocationStage thenAcceptMakeStage(InvocationContext ctx,
 C command,
 InvocationSuccessAction<C> action)

After the current stage completes successfully, invoke action.

The result may be either this, or a new InvocationStage. If action throws an exception, the result InvocationStage will complete with the same exception.

andExceptionallyMakeStage

public <C extends VisitableCommand> InvocationStage andExceptionallyMakeStage(InvocationContext ctx,
 C command,
 InvocationExceptionFunction<C> function)

After the current stage completes exceptionally, invoke function and return its result.

The result may be either this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

andFinallyMakeStage

public <C extends VisitableCommand> InvocationStage andFinallyMakeStage(InvocationContext ctx,
 C command,
 InvocationFinallyAction<C> action)

After the current stage completes, invoke action.

The result may be either this, or a new InvocationStage. If action throws an exception, the result InvocationStage will complete with the same exception.

andHandleMakeStage

public <C extends VisitableCommand> InvocationStage andHandleMakeStage(InvocationContext ctx,
 C command,
 InvocationFinallyFunction<C> function)

After the current stage completes, invoke function and return its result.

The result may be either this, or a new InvocationStage. If function throws an exception, the result InvocationStage will complete with the same exception.

makeStage

public static InvocationStage makeStage(Object maybeStage)

If maybeStage is not an InvocationStage, wrap it, otherwise cast it to an InvocationStage.

completedNullStage

public static InvocationStage completedNullStage()

Returns:

an InvocationStage instance completed successfully with value null.

thenReturn

public Object thenReturn(InvocationContext ctx,
 VisitableCommand command,
 Object returnValue)

Overrides the return value of this InvocationStage if it is completed successfully. The result may be either rv, a new InvocationStage or this