Package org.jivesoftware.smack

Class SmackFuture<V,E extends Exception>

java.lang.Object

org.jivesoftware.smack.SmackFuture<V,E>

All Implemented Interfaces:

Future<V>, CallbackRecipient<V,E>

Direct Known Subclasses:

SmackFuture.InternalSmackFuture

public abstract class SmackFuture<V,E extends Exception>
extends Object
implements Future<V>, CallbackRecipient<V,E>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmackFuture.InternalProcessStanzaSmackFuture<V,E extends Exception>
static class	SmackFuture.InternalSmackFuture<V,E extends Exception>
static class	SmackFuture.SimpleInternalProcessStanzaSmackFuture<V,E extends Exception>	A simple version of InternalSmackFuture which implements isNonFatalException(E) as always returning false method.
static class	SmackFuture.SocketFuture

Field Summary

Fields

Modifier and Type	Field	Description
protected E	exception
protected V	result

Constructor Summary

Constructors

Constructor	Description
SmackFuture()

Method Summary

Modifier and Type	Method	Description
static boolean	await(Collection<? extends SmackFuture<?,?>> futures, long timeout)
static boolean	await(Collection<? extends SmackFuture<?,?>> futures, long timeout, TimeUnit unit)
final boolean	cancel(boolean mayInterruptIfRunning)
static <V, E extends Exception> SmackFuture<V,E>	from(V result)
protected final void	futureWait()
protected void	futureWait(long timeout)
final V	get()
final V	get(long timeout, TimeUnit unit)
E	getExceptionIfAvailable()
V	getIfAvailable()
final V	getOrThrow()
final boolean	isCancelled()
final boolean	isDone()
protected final void	maybeInvokeCallbacks()
void	onCompletion(Consumer<SmackFuture<V,E>> completionCallback)
CallbackRecipient<V,E>	onError(ExceptionCallback<E> exceptionCallback)
CallbackRecipient<V,E>	onSuccess(SuccessCallback<V> successCallback)
final boolean	wasSuccessful()

Methods inherited from class java.lang.Object

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

Field Details

result

protected V result

exception

protected E extends Exception exception

Constructor Details

SmackFuture

public SmackFuture()

Method Details

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

isDone

public final boolean isDone()

Specified by:

isDone in interface Future<V>

wasSuccessful

public final boolean wasSuccessful()

onSuccess

public CallbackRecipient<V,E> onSuccess(SuccessCallback<V> successCallback)

Specified by:

onSuccess in interface CallbackRecipient<V,E extends Exception>

onError

public CallbackRecipient<V,E> onError(ExceptionCallback<E> exceptionCallback)

Specified by:

onError in interface CallbackRecipient<V,E extends Exception>

onCompletion

public void onCompletion(Consumer<SmackFuture<V,E>> completionCallback)

get

public final V get()
            throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

getOrThrow

public final V getOrThrow()
                   throws E,
InterruptedException

Throws:

E extends Exception

InterruptedException

get

public final V get(long timeout,
 TimeUnit unit)
            throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

TimeoutException

getIfAvailable

public V getIfAvailable()

getExceptionIfAvailable

public E getExceptionIfAvailable()

maybeInvokeCallbacks

protected final void maybeInvokeCallbacks()

futureWait

protected final void futureWait()
                         throws InterruptedException

Throws:

InterruptedException

futureWait

protected void futureWait(long timeout)
                   throws InterruptedException

Throws:

InterruptedException

from

public static <V,
E extends Exception>
SmackFuture<V,E> from(V result)

await

public static boolean await(Collection<? extends SmackFuture<?,?>> futures,
 long timeout)
                     throws InterruptedException

Throws:

InterruptedException

await

public static boolean await(Collection<? extends SmackFuture<?,?>> futures,
 long timeout,
 TimeUnit unit)
                     throws InterruptedException

Throws:

InterruptedException