java.lang.Object | ||
↳ | java.io.InputStream | |
↳ | android.app.backup.BackupDataInputStream |
Provides an InputStream
-like interface for accessing an
entity's data during a restore operation. Used by BackupHelper
classes within the BackupAgentHelper
mechanism.
When BackupHelper.restoreEntity()
is called, the current entity's header has already been read from the underlying
BackupDataInput
. The entity's key string and total data size are available
through this class's getKey()
and size()
methods, respectively.
Note: The caller should take care not to seek or close the underlying data
source, nor read more than size()
bytes from the stream.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Report the key string associated with this entity within the backup data set.
| |||||||||||
Read enough entity data into a byte array to fill the array.
| |||||||||||
Read one byte of entity data from the stream, returning it as
an integer value.
| |||||||||||
Read up to
size bytes of data into a byte array, beginning at position
offset within the array. | |||||||||||
Report the total number of bytes of data available for the current entity.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.io.InputStream
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
| |||||||||||
From interface
java.lang.AutoCloseable
|
Report the key string associated with this entity within the backup data set.
getKey()
on the underlying BackupDataInput
.
Read enough entity data into a byte array to fill the array.
b | Byte array to fill with data from the stream. If the stream does not have sufficient data to fill the array, then the contents of the remainder of the array will be undefined. |
---|
IOException |
---|
Read one byte of entity data from the stream, returning it as
an integer value. If more than size()
bytes of data
are read from the stream, the output of this method is undefined.
IOException |
---|
Read up to size
bytes of data into a byte array, beginning at position
offset
within the array.
b | Byte array into which the data will be read |
---|---|
offset | The data will be stored in b beginning at this index
within the array. |
size | The number of bytes to read in this operation. If insufficient data exists within the entity to fulfill this request, only as much data will be read as is available. |
IOException |
---|
Report the total number of bytes of data available for the current entity.
getDataSize()
on the underlying BackupDataInput
.