org.jivesoftware.smack

Class SmackFuture<V>

java.lang.Object

org.jivesoftware.smack.SmackFuture<V>

All Implemented Interfaces:

java.util.concurrent.Future<V>

Direct Known Subclasses:

SmackFuture.InternalSmackFuture

public abstract class SmackFuture<V>
extends java.lang.Object
implements java.util.concurrent.Future<V>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Exception	exception

Constructor Summary

Constructors

Constructor and Description
SmackFuture()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
V	get()
V	get(long timeout, java.util.concurrent.TimeUnit unit)
protected abstract void	handleStanza(Stanza stanza)
boolean	isCancelled()
boolean	isDone()
protected abstract boolean	isNonFatalException(java.lang.Exception exception) This method checks if the given exception is not fatal.
protected void	maybeInvokeCallbacks()
void	onError(ExceptionCallback exceptionCallback)
void	onSuccess(SuccessCallback<V> successCallback)
void	onSuccessOrError(SuccessCallback<V> successCallback, ExceptionCallback exceptionCallback)
protected void	setResult(V result)

Methods inherited from class java.lang.Object

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

Field Detail

exception

protected java.lang.Exception exception

Constructor Detail

SmackFuture

public SmackFuture()

Method Detail

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<V>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

isDone

public final boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

onSuccessOrError

public void onSuccessOrError(SuccessCallback<V> successCallback,
                             ExceptionCallback exceptionCallback)

onSuccess

public void onSuccess(SuccessCallback<V> successCallback)

onError

public void onError(ExceptionCallback exceptionCallback)

get

public final V get()
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public final V get(long timeout,
                   java.util.concurrent.TimeUnit unit)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException,
                   java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

maybeInvokeCallbacks

protected final void maybeInvokeCallbacks()

isNonFatalException

protected abstract boolean isNonFatalException(java.lang.Exception exception)

This method checks if the given exception is not fatal. If this method returns false, then the future will automatically set the given exception as failure reason and notify potential waiting threads.

Parameters:

exception - the exception to check.

Returns:

true if the exception is not fatal, false otherwise.

handleStanza

protected abstract void handleStanza(Stanza stanza)
                              throws SmackException.NotConnectedException,
                                     java.lang.InterruptedException

Throws:

SmackException.NotConnectedException

java.lang.InterruptedException

setResult

protected final void setResult(V result)