Added in API level 19

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

Rating

---

Kotlin |Java

public final class Rating
extends Object implements Parcelable

java.lang.Object
↳	android.media.Rating

---

A class to encapsulate rating information used as content metadata. A rating is defined by its rating style (see RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS or RATING_PERCENTAGE) and the actual rating value (which may be defined as "unrated"), both of which are defined when the rating instance is constructed through one of the factory methods.

Summary

Constants
int	RATING_3_STARS A rating style with 0 to 3 stars.
int	RATING_4_STARS A rating style with 0 to 4 stars.
int	RATING_5_STARS A rating style with 0 to 5 stars.
int	RATING_HEART A rating style with a single degree of rating, "heart" vs "no heart".
int	RATING_NONE Indicates a rating style is not supported.
int	RATING_PERCENTAGE A rating style expressed as a percentage.
int	RATING_THUMB_UP_DOWN A rating style for "thumb up" vs "thumb down".

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<Rating>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
float	getPercentRating() Return the percentage-based rating value.
int	getRatingStyle() Return the rating style.
float	getStarRating() Return the star-based rating value.
boolean	hasHeart() Return whether the rating is "heart selected".
boolean	isRated() Return whether there is a rating value available.
boolean	isThumbUp() Return whether the rating is "thumb up".
static Rating	newHeartRating(boolean hasHeart) Return a Rating instance with a heart-based rating.
static Rating	newPercentageRating(float percent) Return a Rating instance with a percentage-based rating.
static Rating	newStarRating(int starRatingStyle, float starRating) Return a Rating instance with a star-based rating.
static Rating	newThumbRating(boolean thumbIsUp) Return a Rating instance with a thumb-based rating.
static Rating	newUnratedRating(int ratingStyle) Return a Rating instance with no rating.
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 Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

RATING_3_STARS

Added in API level 19

public static final int RATING_3_STARS

A rating style with 0 to 3 stars.

Constant Value: 3 (0x00000003)

RATING_4_STARS

Added in API level 19

public static final int RATING_4_STARS

A rating style with 0 to 4 stars.

Constant Value: 4 (0x00000004)

RATING_5_STARS

Added in API level 19

public static final int RATING_5_STARS

A rating style with 0 to 5 stars.

Constant Value: 5 (0x00000005)

RATING_HEART

Added in API level 19

public static final int RATING_HEART

A rating style with a single degree of rating, "heart" vs "no heart". Can be used to indicate the content referred to is a favorite (or not).

Constant Value: 1 (0x00000001)

RATING_NONE

Added in API level 21

public static final int RATING_NONE

Indicates a rating style is not supported. A Rating will never have this type, but can be used by other classes to indicate they do not support Rating.

Constant Value: 0 (0x00000000)

RATING_PERCENTAGE

Added in API level 19

public static final int RATING_PERCENTAGE

A rating style expressed as a percentage.

Constant Value: 6 (0x00000006)

RATING_THUMB_UP_DOWN

Added in API level 19

public static final int RATING_THUMB_UP_DOWN

A rating style for "thumb up" vs "thumb down".

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 19

public static final Creator<Rating> CREATOR

Public methods

describeContents

Added in API level 19

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

getPercentRating

Added in API level 19

public float getPercentRating ()

Return the percentage-based rating value.

Returns
float	a rating value greater or equal to 0.0f, or a negative value if the rating style is not percentage-based, or if it is unrated.

getRatingStyle

Added in API level 19

public int getRatingStyle ()

Return the rating style.

Returns
int	one of RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE. Value is RATING_NONE, RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE

getStarRating

Added in API level 19

public float getStarRating ()

Return the star-based rating value.

Returns
float	a rating value greater or equal to 0.0f, or a negative value if the rating style is not star-based, or if it is unrated.

hasHeart

Added in API level 19

public boolean hasHeart ()

Return whether the rating is "heart selected".

Returns
boolean	true if the rating is "heart selected", false if the rating is "heart unselected", if the rating style is not RATING_HEART or if it is unrated.

isRated

Added in API level 19

public boolean isRated ()

Return whether there is a rating value available.

Returns
boolean	true if the instance was not created with newUnratedRating(int).

isThumbUp

Added in API level 19

public boolean isThumbUp ()

Return whether the rating is "thumb up".

Returns
boolean	true if the rating is "thumb up", false if the rating is "thumb down", if the rating style is not RATING_THUMB_UP_DOWN or if it is unrated.

newHeartRating

Added in API level 19

public static Rating newHeartRating (boolean hasHeart)

Return a Rating instance with a heart-based rating. Create and return a new Rating instance with a rating style of RATING_HEART, and a heart-based rating.

Parameters
hasHeart	boolean: true for a "heart selected" rating, false for "heart unselected".

Returns
Rating	a new Rating instance.

newPercentageRating

Added in API level 19

public static Rating newPercentageRating (float percent)

Return a Rating instance with a percentage-based rating. Create and return a new Rating instance with a RATING_PERCENTAGE rating style, and a rating of the given percentage.

Parameters
percent	float: the value of the rating

Returns
Rating	null if the rating is out of range, a new Rating instance otherwise.

newStarRating

Added in API level 19

public static Rating newStarRating (int starRatingStyle, 
                float starRating)

Return a Rating instance with a star-based rating. Create and return a new Rating instance with one of the star-base rating styles and the given integer or fractional number of stars. Non integer values can for instance be used to represent an average rating value, which might not be an integer number of stars.

Parameters
starRatingStyle	int: one of RATING_3_STARS, RATING_4_STARS, RATING_5_STARS. Value is RATING_3_STARS, RATING_4_STARS, or RATING_5_STARS
starRating	float: a number ranging from 0.0f to 3.0f, 4.0f or 5.0f according to the rating style.

Returns
Rating	null if the rating style is invalid, or the rating is out of range, a new Rating instance otherwise.

newThumbRating

Added in API level 19

public static Rating newThumbRating (boolean thumbIsUp)

Return a Rating instance with a thumb-based rating. Create and return a new Rating instance with a RATING_THUMB_UP_DOWN rating style, and a "thumb up" or "thumb down" rating.

Parameters
thumbIsUp	boolean: true for a "thumb up" rating, false for "thumb down".

Returns
Rating	a new Rating instance.

newUnratedRating

Added in API level 19

public static Rating newUnratedRating (int ratingStyle)

Return a Rating instance with no rating. Create and return a new Rating instance with no rating known for the given rating style.

Parameters
ratingStyle	int: one of RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE. Value is RATING_NONE, RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE

Returns
Rating	null if an invalid rating style is passed, a new Rating instance otherwise.

toString

Added in API level 19

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 19

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