universum.studios.android.officium.sync

Class SyncEvent

java.lang.Object

universum.studios.android.officium.sync.SyncEvent

public final class SyncEvent
extends Object

Event that can be fired/post for receivers that listen for state of a concrete synchronization process/task. Each instance of SyncEvent can be identified by its id and type. Additionally for events type of PROGRESS can be specified progress value and for events type of ERROR can be specified occurred synchronization error.

Creation of instances of SyncEvents is restricted via SyncEvent.Builder only.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncEvent.Builder Builder that can be used to create a new instance of SyncEvent.

Field Summary

Fields

Modifier and Type	Field and Description
android.accounts.Account	account Account used during execution of synchronization task with id.
Exception	error Error that has occurred during execution of synchronization task with id.
static int	ERROR Type flag for SyncEvent determining error occurred during synchronization.
android.os.Bundle	extras Bundle with additional extra information.
static int	FINISH Type flag for SyncEvent determining finish of synchronization.
int	id Id of the synchronization task for which has been this synchronization event fired.
int	progress Current progress of synchronization task with id.
static int	PROGRESS Type flag for SyncEvent determining progress of synchronization.
static int	START Type flag for SyncEvent determining start of synchronization.
int	type Type of this synchronization event.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final int START

Type flag for SyncEvent determining start of synchronization.

See Also:

Constant Field Values

PROGRESS

public static final int PROGRESS

Type flag for SyncEvent determining progress of synchronization.

See Also:

Constant Field Values

FINISH

public static final int FINISH

Type flag for SyncEvent determining finish of synchronization.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Type flag for SyncEvent determining error occurred during synchronization.

See Also:

Constant Field Values

id

public final int id

Id of the synchronization task for which has been this synchronization event fired.

type

public final int type

Type of this synchronization event. One of START, PROGRESS, FINISH or ERROR or some custom specified type.

progress

public final int progress

Current progress of synchronization task with id.

error

public final Exception error

Error that has occurred during execution of synchronization task with id.

account

public final android.accounts.Account account

Account used during execution of synchronization task with id.

extras

public final android.os.Bundle extras

Bundle with additional extra information.