Most visited

Recently visited

Added in API level 8

PeriodicSync

public class PeriodicSync
extends Object implements Parcelable

java.lang.Object
   ↳ android.content.PeriodicSync


Value type that contains information about a periodic sync.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<PeriodicSync> CREATOR

public final Account account

The account to be synced.

public final String authority

The authority of the sync.

public final Bundle extras

Any extras that parameters that are to be passed to the sync adapter.

public final long period

How frequently the sync should be scheduled, in seconds.

Public constructors

PeriodicSync(Account account, String authority, Bundle extras, long periodInSeconds)

Creates a new PeriodicSync, copying the Bundle.

Public methods

int describeContents()

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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 8
Creator<PeriodicSync> CREATOR

account

Added in API level 8
Account account

The account to be synced. Can be null.

authority

Added in API level 8
String authority

The authority of the sync. Can be null.

extras

Added in API level 8
Bundle extras

Any extras that parameters that are to be passed to the sync adapter.

period

Added in API level 8
long period

How frequently the sync should be scheduled, in seconds. Kept around for API purposes.

Public constructors

PeriodicSync

Added in API level 8
PeriodicSync (Account account, 
                String authority, 
                Bundle extras, 
                long periodInSeconds)

Creates a new PeriodicSync, copying the Bundle. This constructor is no longer used.

Parameters
account Account
authority String
extras Bundle
periodInSeconds long

Public methods

describeContents

Added in API level 8
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

Added in API level 8
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

toString

Added in API level 8
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

Added in API level 8
void writeToParcel (Parcel dest, 
                int flags)

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.

Hooray!