Android APIs
public class

SyncStats

extends Object
implements Parcelable
java.lang.Object
   ↳ android.content.SyncStats

Class Overview

Used to record various statistics about the result of a sync operation. The SyncManager gets access to these via a SyncResult and uses some of them to determine the disposition of the sync. See SyncResult for further dicussion on how the SyncManager uses these values.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<SyncStats> CREATOR
public long numAuthExceptions The SyncAdapter was unable to authenticate the Account that was specified in the request.
public long numConflictDetectedExceptions The SyncAdapter detected that there was an unrecoverable version conflict when it attempted to update or delete a version of a resource on the server.
public long numDeletes Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter.
public long numEntries Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter.
public long numInserts Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter.
public long numIoExceptions The SyncAdapter had a problem, most likely with the network connectivity or a timeout while waiting for a network response.
public long numParseExceptions The SyncAdapter had a problem with the data it received from the server or the storage later.
public long numSkippedEntries Counter for tracking how many entries, either from the server or the local store, were ignored during the sync operation.
public long numUpdates Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter.
Public Constructors
SyncStats()
SyncStats(Parcel in)
Public Methods
void clear()
Reset all the counters to 0.
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<SyncStats> CREATOR

Added in API level 5

public long numAuthExceptions

Added in API level 5

The SyncAdapter was unable to authenticate the Account that was specified in the request. The user needs to take some action to resolve before a future request can expect to succeed. This is considered a hard error.

public long numConflictDetectedExceptions

Added in API level 5

The SyncAdapter detected that there was an unrecoverable version conflict when it attempted to update or delete a version of a resource on the server. This is expected to clear itself automatically once the new state is retrieved from the server, though it may remain until the user intervenes manually, perhaps by clearing the local storage and starting over frmo scratch. This is considered a hard error.

public long numDeletes

Added in API level 5

Counter for tracking how many deletes were performed by the sync operation, as defined by the SyncAdapter.

public long numEntries

Added in API level 5

Counter for tracking how many entries were affected by the sync operation, as defined by the SyncAdapter.

public long numInserts

Added in API level 5

Counter for tracking how many inserts were performed by the sync operation, as defined by the SyncAdapter.

public long numIoExceptions

Added in API level 5

The SyncAdapter had a problem, most likely with the network connectivity or a timeout while waiting for a network response. The request may succeed if it is tried again later. This is considered a soft error.

public long numParseExceptions

Added in API level 5

The SyncAdapter had a problem with the data it received from the server or the storage later. This problem will likely repeat if the request is tried again. The problem will need to be cleared up by either the server or the storage layer (likely with help from the user). If the SyncAdapter cleans up the data itself then it typically won't increment this value although it may still do so in order to record that it had to perform some cleanup. E.g., if the SyncAdapter received a bad entry from the server when processing a feed of entries, it may choose to drop the entry and thus make progress and still increment this value just so the SyncAdapter can record that an error occurred. This is considered a hard error.

public long numSkippedEntries

Added in API level 5

Counter for tracking how many entries, either from the server or the local store, were ignored during the sync operation. This could happen if the SyncAdapter detected some unparsable data but decided to skip it and move on rather than failing immediately.

public long numUpdates

Added in API level 5

Counter for tracking how many updates were performed by the sync operation, as defined by the SyncAdapter.

Public Constructors

public SyncStats ()

Added in API level 5

public SyncStats (Parcel in)

Added in API level 5

Parameters
in Parcel

Public Methods

public void clear ()

Added in API level 5

Reset all the counters to 0.

public int describeContents ()

Added in API level 5

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public String toString ()

Added in API level 5

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Added in API level 5

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.