com.digi.wva.async

Class WvaCallback<T>

java.lang.Object

com.digi.wva.async.WvaCallback<T>

All Implemented Interfaces:

com.digi.wva.internal.MainThreadOptional

public abstract class WvaCallback<T>
extends Object
implements com.digi.wva.internal.MainThreadOptional

Callback class used to receive response information from asynchronous calls into the library.

Constructor Summary

Constructors

Constructor and Description
WvaCallback()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onResponse(Throwable error, T response) Method to be called upon completion of the call that this callback is associated with.
boolean	runsOnUiThread() Specifies whether this callback should be executed on the application's main thread (also called the UI thread), or if it should be executed on a background thread.
static <T> WvaCallback<T>	wrap(WvaCallback<T> callback, android.os.Handler uiThread) Normal library users should not need to call this method. Used internally by the library to convert a normal callback into one where onResponse is executed on the main thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

WvaCallback

public WvaCallback()

Method Detail

onResponse

public abstract void onResponse(Throwable error,
              T response)

Method to be called upon completion of the call that this callback is associated with.

Parameters:

error - a notable exception encountered during the call, or null if there is none

response - the "return value" for this call

runsOnUiThread

public boolean runsOnUiThread()

Specifies whether this callback should be executed on the application's main thread (also called the UI thread), or if it should be executed on a background thread. By default, this returns true.

If you know a callback does not need to be run on the UI thread, in your WvaCallback, override this method. Here's an example:

     makeSomeCall(new WvaCallback() {
         @Override
         public void runsOnUiThread() {
             return false;
         }

         @Override
         public void onResponse(Throwable error, Void response) {
             // ...
         }
     });
 

Specified by:

runsOnUiThread in interface com.digi.wva.internal.MainThreadOptional

Returns:

true if this callback should be executed on the UI thread, false otherwise

wrap

public static <T> WvaCallback<T> wrap(WvaCallback<T> callback,
                      android.os.Handler uiThread)

Normal library users should not need to call this method. Used internally by the library to convert a normal callback into one where onResponse is executed on the main thread.

If the callback's runsOnUiThread() returns true, returns a new WvaCallback instance to run callback's onResponse method on the UI thread. Otherwise, if runsOnUiThread() returns false, this method returns the callback.

Parameters:

uiThread - the main thread handler, to be used when wrapping the callback to execute on the main thread

callback - the callback to wrap

Returns:

a wrapped callback, or callback if it does not need to run on the UI thread. If callback is null, this returns null as well