-
public class Task<TResult>Definition of task is to execute some work & return success or failure callbacks
-
-
Method Summary
Modifier and Type Method Description synchronized Task<TResult>addOnFailureListener(@NonNull() Executor executor, OnFailureListener<Exception> listener)Register listener to get failure callbacks on the provided executor Task<TResult>addOnFailureListener(@NonNull() OnFailureListener<Exception> listener)Register listener to get failure callbacks on main thread Task<TResult>addOnSuccessListener(@NonNull() Executor executor, OnSuccessListener<TResult> listener)Register listener to get success callbacks on the provided executor Task<TResult>addOnSuccessListener(@NonNull() OnSuccessListener<TResult> listener)Register listener to get success callbacks on main thread voidexecute(String logTag, Callable<TResult> callable)Simple method to execute the task booleanisSuccess()Returns the state of taskRefSTATE Task<TResult>removeOnFailureListener(@NonNull() OnFailureListener<Exception> listener)*Removes the failure listener from the task. Task<TResult>removeOnSuccessListener(@NonNull() OnSuccessListener<TResult> listener)*Removes the Success listener from the task. Future<out Object>submit(String logTag, Callable<TResult> callable)Use this method in-case we need future task for the execution TResultsubmitAndGetResult(String logTag, Callable<TResult> callable, long timeoutMillis)Submits piece of code to executor and returns result if code executes successfully within timeout or returns null -
-
Method Detail
-
addOnFailureListener
@NonNull() synchronized Task<TResult> addOnFailureListener(@NonNull() Executor executor, OnFailureListener<Exception> listener)
Register listener to get failure callbacks on the provided executor
- Parameters:
executor- - executor on which the failure callback will be calledlistener- - failure listener
-
addOnFailureListener
@NonNull() Task<TResult> addOnFailureListener(@NonNull() OnFailureListener<Exception> listener)
Register listener to get failure callbacks on main thread
- Parameters:
listener- - failure listener
-
addOnSuccessListener
@NonNull() Task<TResult> addOnSuccessListener(@NonNull() Executor executor, OnSuccessListener<TResult> listener)
Register listener to get success callbacks on the provided executor
- Parameters:
executor- - executor on which the success callback will be calledlistener- - success listener
-
addOnSuccessListener
@NonNull() Task<TResult> addOnSuccessListener(@NonNull() OnSuccessListener<TResult> listener)
Register listener to get success callbacks on main thread
- Parameters:
listener- - success listener
-
execute
void execute(String logTag, Callable<TResult> callable)
Simple method to execute the task
- Parameters:
logTag- - tag name to identify the task state in logs.callable- - piece of code to run
-
isSuccess
boolean isSuccess()
Returns the state of taskRefSTATE
-
removeOnFailureListener
@NonNull() Task<TResult> removeOnFailureListener(@NonNull() OnFailureListener<Exception> listener)
*Removes the failure listener from the task.
- Parameters:
listener- - failure listener
-
removeOnSuccessListener
@NonNull() Task<TResult> removeOnSuccessListener(@NonNull() OnSuccessListener<TResult> listener)
*Removes the Success listener from the task.
- Parameters:
listener- - success listener
-
submit
Future<out Object> submit(String logTag, Callable<TResult> callable)
Use this method in-case we need future task for the execution
- Parameters:
logTag- - tag name to identify the task state in logs.callable- - piece of code to run
-
submitAndGetResult
@Nullable() TResult submitAndGetResult(String logTag, Callable<TResult> callable, long timeoutMillis)
Submits piece of code to executor and returns result if code executes successfully within timeout or returns null
- Parameters:
logTag- tag name to identify logs.callable- - piece of code to runtimeoutMillis- - timeout for piece of code to run
-
-
-
-