com.microsoft.rest.v2

Class ServiceFuture<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

com.microsoft.rest.v2.ServiceFuture<T>

Type Parameters:

T - the type of the returning object

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class ServiceFuture<T>
extends CompletableFuture<T>

An instance of this class provides access to the underlying REST call invocation. This class wraps around the Retrofit Call object and allows updates to it in the progress of a long running operation or a paging operation.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceFuture()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
static ServiceFuture<Void>	fromBody(io.reactivex.Completable completable, ServiceCallback<Void> callback) Creates a ServiceFuture from an Completable object and a callback.
static <T> ServiceFuture<T>	fromBody(io.reactivex.Maybe<T> maybe, ServiceCallback<T> callback) Creates a ServiceCall from a Single object and a callback.
static <T> ServiceFuture<T>	fromBody(io.reactivex.Single<T> single, ServiceCallback<T> callback) Creates a ServiceCall from a Single object and a callback.
io.reactivex.disposables.Disposable	getSubscription()
boolean	isCancelled()
protected void	setSubscription(io.reactivex.disposables.Disposable subscription)

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, complete, completedFuture, completeExceptionally, exceptionally, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCompletedExceptionally, isDone, join, obtrudeException, obtrudeValue, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceFuture

protected ServiceFuture()

Method Detail

fromBody

public static <T> ServiceFuture<T> fromBody(io.reactivex.Single<T> single,
                                            ServiceCallback<T> callback)

Creates a ServiceCall from a Single object and a callback.

Type Parameters:

T - the type of the response

Parameters:

single - the single to create from

callback - the callback to call when events happen

Returns:

the created ServiceCall

fromBody

public static <T> ServiceFuture<T> fromBody(io.reactivex.Maybe<T> maybe,
                                            ServiceCallback<T> callback)

Creates a ServiceCall from a Single object and a callback.

Type Parameters:

T - the type of the response

Parameters:

maybe - the maybe to create from

callback - the callback to call when events happen

Returns:

the created ServiceCall

fromBody

public static ServiceFuture<Void> fromBody(io.reactivex.Completable completable,
                                           ServiceCallback<Void> callback)

Creates a ServiceFuture from an Completable object and a callback.

Parameters:

completable - the completable to create from

callback - the callback to call when event happen

Returns:

the created ServiceFuture

getSubscription

public io.reactivex.disposables.Disposable getSubscription()

Returns:

the current Rx subscription associated with the ServiceCall.

setSubscription

protected void setSubscription(io.reactivex.disposables.Disposable subscription)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class CompletableFuture<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

Overrides:

isCancelled in class CompletableFuture<T>