MilestoneEntity

public final class MilestoneEntity extends AbstractSafeParcelable
implements Milestone

Data object representing the data for a milestone. This is immutable, and therefore safe to cache or store. Note, however, that the data it represents may grow stale.

This class exists solely to support parceling these objects and should not be used directly.

Inherited Constant Summary

From interface com.google.android.gms.common.internal.safeparcel.SafeParcelable

String

NULL

From interface com.google.android.gms.games.quest.Milestone

int	STATE_CLAIMED	Constant returned by server indicating the milestone was successfully claimed.
int	STATE_COMPLETED_NOT_CLAIMED	Constant returned by server indicating the milestone has not been claimed yet.
int	STATE_NOT_COMPLETED	Constant returned by server indicating the player has not completed the milestone.
int	STATE_NOT_STARTED	Constant returned by server when the milestone has not been started.

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static final Creator<MilestoneEntity>

CREATOR

Public Method Summary

boolean	equals(Object obj)
Milestone	freeze() Freeze a volatile representation into an immutable representation.
byte[]	getCompletionRewardData() Retrieves the completion reward data for this milestone.
long	getCurrentProgress() Retrieves the current progress of getTargetProgress() required to complete the milestone.
String	getEventId() Retrieve the ID of the associated event.
String	getMilestoneId() Retrieves the ID of this milestone.
int	getState() Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED.
long	getTargetProgress() Retrieves the number of increments of the event associated with the milestone getEventId() required to complete the milestone.
int	hashCode()
boolean	isDataValid() Check to see if this object is valid for use.
String	toString()
void	writeToParcel(Parcel out, int flags)

Inherited Method Summary

From class com.google.android.gms.common.internal.safeparcel.AbstractSafeParcelable

final int

describeContents()

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface com.google.android.gms.games.quest.Milestone

abstract byte[]	getCompletionRewardData() Retrieves the completion reward data for this milestone.
abstract long	getCurrentProgress() Retrieves the current progress of getTargetProgress() required to complete the milestone.
abstract String	getEventId() Retrieve the ID of the associated event.
abstract String	getMilestoneId() Retrieves the ID of this milestone.
abstract int	getState() Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED.
abstract long	getTargetProgress() Retrieves the number of increments of the event associated with the milestone getEventId() required to complete the milestone.

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

From interface com.google.android.gms.common.data.Freezable

abstract Milestone	freeze() Freeze a volatile representation into an immutable representation.
abstract boolean	isDataValid() Check to see if this object is valid for use.

Fields

public static final Creator<MilestoneEntity> CREATOR

Public Methods

public boolean equals (Object obj)

public Milestone freeze ()

Freeze a volatile representation into an immutable representation. Objects returned from this call are safe to cache.

Note that the output of freeze may not be identical to the parent object, but should be equal. In other words:

 
 Freezable f1 = new Freezable();
 Freezable f2 = f1.freeze();
 f1 == f2 may not be true.
 f1.equals(f2) will be true.
 
 

Returns

• A concrete implementation of the data object.

public byte[] getCompletionRewardData ()

Retrieves the completion reward data for this milestone.

Returns

• The completion reward data.

public long getCurrentProgress ()

Retrieves the current progress of getTargetProgress() required to complete the milestone.

When the milestone state is STATE_CLAIMED or STATE_COMPLETED_NOT_CLAIMED the value of getTargetProgress() is returned. When the milestone state is STATE_NOT_COMPLETED the return value is the number of increments to the event getEventId() associated with the milestone that have occurred since the quest was accepted. When the milestone state is STATE_NOT_STARTED the return value is 0.

Returns

• An indicator of progress through the milestone.

public String getEventId ()

Retrieve the ID of the associated event. Increments to this event will increase the user's progress toward this milestone when the milestone is in the STATE_NOT_COMPLETED state.

Returns

• The ID of the Event associated with this milestone.

public String getMilestoneId ()

Retrieves the ID of this milestone.

Returns

• The milestone ID.

public int getState ()

Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED.

Returns

• The state of this milestone.

public long getTargetProgress ()

Retrieves the number of increments of the event associated with the milestone getEventId() required to complete the milestone.

Returns

• The number of increments required to complete the milestone.

public int hashCode ()

public boolean isDataValid ()

Check to see if this object is valid for use. If the object is still volatile, this method will indicate whether or not the object can be safely used. The output of a call to freeze() will always be valid.

Returns

• whether or not the object is valid for use.

public String toString ()

public void writeToParcel (Parcel out, int flags)