WallpaperDescription

public final class WallpaperDescription
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.wallpaper.WallpaperDescription

Describes a wallpaper, including associated metadata and optional content to be used by its WallpaperService.Engine, the ComponentName to be used by WallpaperManager, and an optional id to differentiate between different distinct wallpapers rendered by the same wallpaper service.

This class is used to communicate among a wallpaper rendering service, a wallpaper chooser UI, and WallpaperManager. This class describes a specific instance of a live wallpaper, unlike WallpaperInfo which is common to all instances of a wallpaper component. Each WallpaperDescription can have distinct metadata.

Summary

Nested classes

class WallpaperDescription.Builder

Builder for the immutable WallpaperDescription class 

Inherited constants

Fields

public static final Creator<WallpaperDescription> CREATOR

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.

ComponentName getComponent()
PersistableBundle getContent()
CharSequence getContextDescription()
Uri getContextUri()
List<CharSequence> getDescription()
String getId()
Uri getThumbnail()
CharSequence getTitle()
int hashCode()

Returns a hash code value for the object.

WallpaperDescription.Builder toBuilder()

Convert the current description to a Builder.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in Android Baklava 
public static final Creator<WallpaperDescription> CREATOR

Public methods

describeContents

public 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public 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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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.

getComponent

public ComponentName getComponent ()

Returns
ComponentName the component for this wallpaper, or null for a static wallpaper

getContent

public PersistableBundle getContent ()

Returns
PersistableBundle any additional content required to render this wallpaper

getContextDescription

public CharSequence getContextDescription ()

Returns
CharSequence the description for the action associated with the wallpaper, or null if not provided

getContextUri

public Uri getContextUri ()

Returns
Uri the Uri for the action associated with the wallpaper, or null if not provided

getDescription

public List<CharSequence> getDescription ()

Returns
List<CharSequence> the description for this wallpaper, with each list element intended to be shown on a separate line in the UI

getId

public String getId ()

Returns
String the id for this wallpaper, or null if not provided

getThumbnail

public Uri getThumbnail ()

Returns
Uri the thumbnail for this wallpaper, or null if not provided

getTitle

public CharSequence getTitle ()

Returns
CharSequence the title for this wallpaper, or null if not provided

hashCode

public 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 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 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.

Returns
int a hash code value for this object.

toBuilder

public WallpaperDescription.Builder toBuilder ()

Convert the current description to a Builder.

Returns
WallpaperDescription.Builder the Builder representing this description

writeToParcel

public 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. This value cannot be null.
flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES