public final class

SnapshotEntity

extends Object
implements Parcelable Snapshot
java.lang.Object
   ↳ com.google.android.gms.games.snapshot.SnapshotEntity

Class Overview

Data object representing the data for a saved game. 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.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<SnapshotEntity> CREATOR
Public Methods
boolean equals(Object obj)
Snapshot freeze()
Freeze a volatile representation into an immutable representation.
SnapshotMetadata getMetadata()
Retrieves the metadata for this snapshot.
SnapshotContents getSnapshotContents()
Retrieve the SnapshotContents associated with this snapshot.
int hashCode()
boolean isDataValid()
Check to see if this object is valid for use.
String toString()
void writeToParcel(Parcel out, int flags)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable
From interface com.google.android.gms.games.snapshot.Snapshot
From interface com.google.android.gms.common.data.Freezable

Fields

public static final Creator<SnapshotEntity> CREATOR

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public Snapshot 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
Snapshot A concrete implementation of the data object.

public SnapshotMetadata getMetadata ()

Retrieves the metadata for this snapshot.

Returns
SnapshotMetadata The SnapshotMetadata associated with this snapshot.

public SnapshotContents getSnapshotContents ()

Retrieve the SnapshotContents associated with this snapshot. This object can be used to update the data of a snapshot. Note that this will return null if this snapshot was not obtained via open(GoogleApiClient, SnapshotMetadata).

Returns
SnapshotContents The SnapshotContents for this snapshot, or null if the snapshot is not opened.

public int hashCode ()

Returns
int

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
boolean whether or not the object is valid for use.

public String toString ()

Returns
String

public void writeToParcel (Parcel out, int flags)

Parameters
out Parcel
flags int