Skip to content

Most visited

Recently visited

navigation

SyncAdapterType

public class SyncAdapterType
extends Object implements Parcelable

java.lang.Object
   ↳ android.content.SyncAdapterType


Value type that represents a SyncAdapterType. This object overrides equals(Object) and hashCode(), making it suitable for use as the key of a Map

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<SyncAdapterType> CREATOR

public final String accountType

public final String authority

public final boolean isKey

Public constructors

SyncAdapterType(String authority, String accountType, boolean userVisible, boolean supportsUploading)
SyncAdapterType(Parcel source)

Public methods

boolean allowParallelSyncs()
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 getSettingsActivity()
int hashCode()

Returns a hash code value for the object.

boolean isAlwaysSyncable()

If true then the SyncManager will never issue an initialization sync to the SyncAdapter and will instead automatically call setIsSyncable(android.accounts.Account, String, int) with a value of 1 for each account and provider that this sync adapter supports.

boolean isUserVisible()
static SyncAdapterType newKey(String authority, String accountType)
boolean supportsUploading()
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 5
Creator<SyncAdapterType> CREATOR

accountType

Added in API level 5
String accountType

authority

Added in API level 5
String authority

isKey

Added in API level 5
boolean isKey

Public constructors

SyncAdapterType

Added in API level 5
SyncAdapterType (String authority, 
                String accountType, 
                boolean userVisible, 
                boolean supportsUploading)

Parameters
authority String
accountType String
userVisible boolean
supportsUploading boolean

SyncAdapterType

Added in API level 5
SyncAdapterType (Parcel source)

Parameters
source Parcel

Public methods

allowParallelSyncs

Added in API level 11
boolean allowParallelSyncs ()

Returns
boolean True if this SyncAdapter supports syncing multiple accounts simultaneously. If false then the SyncManager will take care to only start one sync at a time using this SyncAdapter.

describeContents

Added in API level 5
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 5
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.

getSettingsActivity

Added in API level 14
String getSettingsActivity ()

Returns
String The activity to use to invoke this SyncAdapter's settings activity. May be null.

hashCode

Added in API level 5
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

isAlwaysSyncable

Added in API level 11
boolean isAlwaysSyncable ()

If true then the SyncManager will never issue an initialization sync to the SyncAdapter and will instead automatically call setIsSyncable(android.accounts.Account, String, int) with a value of 1 for each account and provider that this sync adapter supports.

Returns
boolean true if the SyncAdapter does not require initialization and if it is ok for the SyncAdapter to treat it as syncable automatically.

isUserVisible

Added in API level 5
boolean isUserVisible ()

Returns
boolean

newKey

Added in API level 5
SyncAdapterType newKey (String authority, 
                String accountType)

Parameters
authority String
accountType String
Returns
SyncAdapterType

supportsUploading

Added in API level 5
boolean supportsUploading ()

Returns
boolean

toString

Added in API level 5
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 5
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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.