Package io.vertx.rxjava3.core
Class Promise<T>
- java.lang.Object
-
- io.vertx.rxjava3.core.Promise<T>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
- Direct Known Subclasses:
BaseBridgeEvent,ConnectionInitEvent
public class Promise<T> extends Object implements io.vertx.lang.rx.RxDelegate
Represents the writable side of an action that may, or may not, have occurred yet.The
future()method returns theFutureassociated with a promise, the future can be used for getting notified of the promise completion and retrieve its value.A promise extends
Handlerso it can be used as a callback.> NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Promise>__TYPE_ARGio.vertx.lang.rx.TypeArg<T>__typeArg_0
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcomplete()Callscomplete(null)voidcomplete(T result)Set the result.voidcomplete(T result, Throwable failure)booleanequals(Object o)voidfail(String message)voidfail(Throwable failure)Single<T>future()PromisegetDelegate()voidhandle(AsyncResult<T> asyncResult)Succeed or fail this promise with theAsyncResultevent.inthashCode()static <T> Promise<T>newInstance(Promise arg)static <T> Promise<T>newInstance(Promise arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)static <T> Promise<T>promise()Create a promise that hasn't completed yetSingle<T>rxFuture()voidsucceed()voidsucceed(T result)StringtoString()booleantryComplete()CallstryComplete(null).booleantryComplete(T result)Likecomplete(T, java.lang.Throwable)but returnsfalsewhen the promise is already completed instead of throwing anIllegalStateException, it returnstrueotherwise.booleantryFail(String message)Callsfail(java.lang.Throwable)with themessage.booleantryFail(Throwable cause)Likefail(java.lang.Throwable)but returnsfalsewhen the promise is already completed instead of throwing anIllegalStateException, it returnstrueotherwise.
-
-
-
Method Detail
-
getDelegate
public Promise getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
promise
public static <T> Promise<T> promise()
Create a promise that hasn't completed yet- Returns:
- the promise
-
complete
public void complete(T result)
Set the result. Any handler will be called, if there is one, and the promise will be marked as completed. Any handler set on the associated promise will be called.- Parameters:
result- the result
-
complete
public void complete()
Callscomplete(null)
-
succeed
public void succeed(T result)
-
succeed
public void succeed()
-
fail
public void fail(Throwable failure)
-
fail
public void fail(String message)
-
tryComplete
public boolean tryComplete(T result)
Likecomplete(T, java.lang.Throwable)but returnsfalsewhen the promise is already completed instead of throwing anIllegalStateException, it returnstrueotherwise.- Parameters:
result- the result- Returns:
falsewhen the future is already completed
-
tryComplete
public boolean tryComplete()
CallstryComplete(null).- Returns:
falsewhen the future is already completed
-
tryFail
public boolean tryFail(Throwable cause)
Likefail(java.lang.Throwable)but returnsfalsewhen the promise is already completed instead of throwing anIllegalStateException, it returnstrueotherwise.- Parameters:
cause- the failure cause- Returns:
falsewhen the future is already completed
-
tryFail
public boolean tryFail(String message)
Callsfail(java.lang.Throwable)with themessage.- Parameters:
message- the failure message- Returns:
- false when the future is already completed
-
future
public Single<T> future()
- Returns:
- the
Futureassociated with this promise, it can be used to be aware of the promise completion
-
rxFuture
public Single<T> rxFuture()
- Returns:
- the
Futureassociated with this promise, it can be used to be aware of the promise completion
-
handle
public void handle(AsyncResult<T> asyncResult)
Succeed or fail this promise with theAsyncResultevent.- Parameters:
asyncResult- the async result to handle
-
-