Package com.vaadin.signals.operations

Class SignalOperation<T>

java.lang.Object

com.vaadin.signals.operations.SignalOperation<T>

Type Parameters:

T - the result type

Direct Known Subclasses:

CancelableOperation, InsertOperation, TransactionOperation

public class SignalOperation<T>
extends Object

An operation triggered on a signal instance. The result will be populated when the operation has been confirmed. The type of the result depends on the operation type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SignalOperation.Error<T>	A failed signal operation result.
static final record	SignalOperation.Result<T>	A successful signal operation result.
static interface	SignalOperation.ResultOrError<T>	The result of a signal operation.

Constructor Summary

Constructors

Constructor	Description
SignalOperation()	Creates a new signal operation that will get a result later.
SignalOperation(SignalOperation.ResultOrError<T> resultOrError)	Creates a new signal operation that already has a result.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SignalOperation.ResultOrError<T>>	result()	Gets the eventual operation result.

Methods inherited from class java.lang.Object

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

Constructor Details

SignalOperation

public SignalOperation()

Creates a new signal operation that will get a result later.

SignalOperation

public SignalOperation(SignalOperation.ResultOrError<T> resultOrError)

Creates a new signal operation that already has a result.

Parameters:

resultOrError - the result of the operation, not null

Method Details

result

public CompletableFuture<SignalOperation.ResultOrError<T>> result()

Gets the eventual operation result.

Returns:

a completable future with the operation result, not null