com.google.android.gms.games.snapshot.SnapshotContents |
Class Overview
Data interface for a representation of Snapshot
contents.
Summary
[Expand]
Inherited Constants |
From interface
android.os.Parcelable
int |
CONTENTS_FILE_DESCRIPTOR |
|
int |
PARCELABLE_WRITE_RETURN_VALUE |
|
|
Public Methods |
abstract
ParcelFileDescriptor
|
getParcelFileDescriptor()
|
abstract
boolean
|
isClosed()
|
abstract
boolean
|
modifyBytes(int dstOffset, byte[] content, int srcOffset, int count)
Write the specified data into the snapshot.
|
abstract
byte[]
|
readFully()
Read the contents of a snapshot.
|
abstract
boolean
|
writeBytes(byte[] content)
Write the specified data into the snapshot.
|
[Expand]
Inherited Methods |
From interface
android.os.Parcelable
abstract
int
|
describeContents()
|
abstract
void
|
writeToParcel(Parcel arg0, int arg1)
|
|
Public Methods
public
abstract
ParcelFileDescriptor
getParcelFileDescriptor
()
Retrieve the ParcelFileDescriptor
associated with the underlying file for this
snapshot contents. This object can be used to update the data of a snapshot, but the snapshot
should still be committed using commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
or
resolveConflict(GoogleApiClient, String, Snapshot)
(in case of conflict resolution).
If this SnapshotContentsEntity was not obtained via
getSnapshotContents()
or
getResolutionSnapshotContents()
, or if the contents have
already been committed and closed via
commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
or
resolveConflict(GoogleApiClient, String, Snapshot)
, this method will throw an exception.
Returns |
ParcelFileDescriptor |
The ParcelFileDescriptor for this snapshot, or null if the snapshot is not
opened.
|
public
abstract
boolean
isClosed
()
Returns |
boolean |
whether this snapshot contents has been closed.
|
public
abstract
boolean
modifyBytes
(int dstOffset, byte[] content, int srcOffset, int count)
Write the specified data into the snapshot. The contents of the snapshot will be replaced
with the data provided in content
. The data will be persisted on disk, but is not
uploaded to the server until the snapshot is committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
.
Note that this form of the API does not necessarily overwrite the entire contents of the
file. If you are writing less data than was previously stored in the snapshot, the excess
data will remain. Use
writeBytes(byte[])
to fully overwrite the file.
If the snapshot was not opened via
open(GoogleApiClient, SnapshotMetadata)
, or if the contents have already
been committed via
commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
, this method will throw an exception.
Parameters |
dstOffset |
int :
Position in the snapshot file to start writing data to. 0 indicates the head
of the file. |
content |
byte :
The data to write. |
srcOffset |
int :
Position in content to start writing from. |
count |
int :
Number of bytes from content to write to this snapshot. |
Returns |
boolean |
Whether or not the data was successfully written to disk.
|
public
abstract
byte[]
readFully
()
public
abstract
boolean
writeBytes
(byte[] content)
Write the specified data into the snapshot. The contents of the snapshot will be replaced
with the data provided in content
. The data will be persisted on disk, but is not
uploaded to the server until the snapshot is committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
.
Note that this form of the API will fully overwrite the contents of the file. No previous
data will be retained. Use
modifyBytes(int, byte[], int, int)
to overwrite parts of
the file.
If the snapshot was not opened via
open(GoogleApiClient, SnapshotMetadata)
, or if the contents have already
been committed via
commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange)
, this method will throw an exception.
Parameters |
content |
byte :
The data to write. |
Returns |
boolean |
Whether or not the data was successfully written to disk.
|