SyncTask (library API)

java.lang.Object
- universum.studios.android.officium.sync.SyncTask<R>

Type Parameters:

R - Type of the request specific for the SyncTask implementation.

All Implemented Interfaces:

Cloneable
```
public class SyncTask<R extends SyncTask.Request>
extends Object
implements Cloneable
```
Task that can be used to request synchronization via implementation of BaseSyncManager. Each instance of SyncTask may be identified by its id that can be obtained via getId().
Creation of instances of SyncTasks is restricted via SyncTask.Builder only.
If synchronization related to a particular SyncTask depends on some additional data that are needed to perform synchronization logic, these data can be specified via Builder#request(Request). The synchronization request object should be a simple POJO object that can be processed by Gson into its String representation and also from it. The request object will be processed into Json data whenever instance of SyncTask is requested to put its data into extras Bundle via intoExtras(Bundle) and instantiated from that Json data whenever getRequest(Class) is called and the request instance has not been parsed yet.
Inheritance instance should override both SyncTask(Builder) and SyncTask(Bundle) constructors along with intoExtras(Bundle) method to perform custom instantiation logic via custom implementation of SyncTask.Builder or from/into extras Bundle.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SyncTask.Builder<R extends SyncTask.Request>` Builder that can be used to create a new instance of `SyncTask`.
`static class`	`SyncTask.EmptyRequest` A `SyncTask.Request` implementation that can be used for `SyncHandlers` that do not require any synchronization request.
`static interface`	`SyncTask.Request` Required interface for all synchronization requests.
`static interface`	`SyncTask.State` Defines an annotation for determining set of available states for `SyncTask`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANCELED` State indicating that `SyncTask` has been canceled.
`static int`	`DEFAULT_ID` Default id for synchronization task.
`static SyncTask<SyncTask.EmptyRequest>`	`EMPTY` Empty instance of `SyncTask` that may be used to pass a sync task to a sync handler that does not require any data from a caller to perform its synchronization.
`static int`	`FAILED` State indicating that `SyncTask` has been already executed but an error occurred during its execution.
`static int`	`FINISHED` State indicating that `SyncTask` has been already executed without any error.
`static int`	`IDLE` Initial state for each new `SyncTask`.
`static int`	`PENDING` State indicating that `SyncTask` is in pending state waiting to be executed.
`static int`	`RUNNING` State indicating that `SyncTask` is currently being executed.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SyncTask(Bundle extras)` Creates a new instance of SyncTask with data specified within the given `extras` Bundle.
`protected`	`SyncTask(SyncTask.Builder<R> builder)` Creates a new instance of SyncTask with data specified within the given `builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected SyncTask`	`clone()` Makes a clone of this task with the same id and request body but with the initial state, which is `IDLE`.
`boolean`	`equals(Object other)`
`int`	`getId()` Returns the id of this task.
`R`	`getRequest(Class<R> classOfRequest)` Returns the request specified for this task.
`String`	`getRequestBody()` Returns a body of the request specified for this task.
`int`	`getState()` Returns the current state of this task.
`int`	`hashCode()`
`Bundle`	`intoExtras(Bundle extras)` Puts all data of this task into the given `extras` Bundle.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IDLE
```
public static final int IDLE
```
    Initial state for each new SyncTask.
    
    See Also:
    
    Constant Field Values
  - PENDING
```
public static final int PENDING
```
    State indicating that SyncTask is in pending state waiting to be executed.
    Task becomes pending when BaseSyncManager.requestSync(SyncTask) has been called with that particular task.
    
    See Also:
    
    Constant Field Values
  - RUNNING
```
public static final int RUNNING
```
    State indicating that SyncTask is currently being executed.
    Task becomes running when BaseSyncAdapter.onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) has been called with extras containing that particular task.
    
    See Also:
    
    Constant Field Values
  - FINISHED
```
public static final int FINISHED
```
    State indicating that SyncTask has been already executed without any error.
    Task becomes finished when BaseSyncAdapter.onSyncFinished(SyncOperation) has been called with sync operation containing that particular task.
    
    See Also:
    
    Constant Field Values
  - FAILED
```
public static final int FAILED
```
    State indicating that SyncTask has been already executed but an error occurred during its execution.
    Task becomes finished when BaseSyncAdapter.onSyncFailed(SyncOperation, Exception) has been called with sync operation containing that particular task.
    
    See Also:
    
    Constant Field Values
  - CANCELED
```
public static final int CANCELED
```
    State indicating that SyncTask has been canceled.
    Task becomes canceled when BaseSyncManager.cancelSync() has been called.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ID
```
public static final int DEFAULT_ID
```
    Default id for synchronization task. This id may be used to identify global synchronization task.
    
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static SyncTask<SyncTask.EmptyRequest> EMPTY
```
    Empty instance of SyncTask that may be used to pass a sync task to a sync handler that does not require any data from a caller to perform its synchronization.
- Constructor Detail
  - SyncTask
```
protected SyncTask(@NonNull
                   SyncTask.Builder<R> builder)
```
    Creates a new instance of SyncTask with data specified within the given builder.
    
    Parameters:
    
    builder - The builder containing data for the new SyncTask instance.
  - SyncTask
```
protected SyncTask(@NonNull
                   Bundle extras)
```
    Creates a new instance of SyncTask with data specified within the given extras Bundle.
    Note, that proper instantiation of SyncTask from the given extras Bundle may be performed only if data for the new SyncTask instance has been previously stored within the given bundle via intoExtras(Bundle) method.
    
    Parameters:
    
    extras - The synchronization extras Bundle containing data for the new SyncTask instance.
    
    See Also:
    
    intoExtras(Bundle)
- Method Detail
  - getId
```
public final int getId()
```
    Returns the id of this task.
    
    Returns:
    
    Id specified for this task.
  - getState
```
public final int getState()
```
    Returns the current state of this task.
    
    Returns:
    
    This task's state. May be one of states defined by @State annotation.
  - getRequest
```
@Nullable
public final R getRequest(@NonNull
                                     Class<R> classOfRequest)
```
    Returns the request specified for this task. If request is null but there is request body available after this sync task has been created from the extras Bundle the desired request will be parsed from its body using Gson.
    
    Parameters:
    
    classOfRequest - Class used to parse the desired request if it is not parsed yet and there is request body available.
    
    Returns:
    
    This task's request or null if there is no request specified.
  - getRequestBody
```
@Nullable
public final String getRequestBody()
```
    Returns a body of the request specified for this task.
    
    Returns:
    
    This task's request body in Json format or null if there is not request specified.
  - intoExtras
```
@NonNull
public Bundle intoExtras(@NonNull
                                   Bundle extras)
```
    Puts all data of this task into the given extras Bundle. Instance of this SyncTask may be than instantiated from the specified extras via SyncTask(Bundle) constructor.
    
    Parameters:
    
    extras - The synchronization extras Bundle into which to put data of this task.
    
    Returns:
    
    The given extras Bundle with this task's data.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
protected SyncTask clone()
```
    Makes a clone of this task with the same id and request body but with the initial state, which is IDLE.
    
    Overrides:
    
    clone in class Object

Class SyncTask<R extends SyncTask.Request>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IDLE

PENDING

RUNNING

FINISHED

FAILED

CANCELED

DEFAULT_ID

EMPTY

Constructor Detail

SyncTask

SyncTask

Method Detail

getId

getState

getRequest

getRequestBody

intoExtras

hashCode

equals

toString

clone