BackupDataInputStream

Class Overview

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.

Summary

Public Methods
String	getKey () Report the key string associated with this entity within the backup data set.
int	read (byte[] b) Read enough entity data into a byte array to fill the array.
int	read () Read one byte of entity data from the stream, returning it as an integer value.
int	read (byte[] b, int offset, int size) Read up to `size` bytes of data into a byte array, beginning at position `offset` within the array.
int	size () Report the total number of bytes of data available for the current entity.

Public Methods

String

getKey ()

Report the key string associated with this entity within the backup data set.

int

read (byte[] b)

Read enough entity data into a byte array to fill the array.

int

read ()

Read one byte of entity data from the stream, returning it as an integer value.

int

read (byte[] b, int offset, int size)

Read up to


           size

bytes of data into a byte array, beginning at position


           offset

within the array.

int

size ()

Report the total number of bytes of data available for the current entity.

[Expand]

Inherited Methods

From class java.io.InputStream

int	available () Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close () Closes this stream.
void	mark (int readlimit) Sets a mark position in this InputStream.
boolean	markSupported () Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read (byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)` .
abstract int	read () Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read (byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes from this stream and stores them in the byte array `buffer` starting at `byteOffset` .
synchronized void	reset () Resets this stream to the last marked location.
long	skip (long byteCount) Skips at most `byteCount` bytes in this stream.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Public Methods

public String getKey ()

Added in API level 8

Report the key string associated with this entity within the backup data set.

Returns

The key string for this entity, equivalent to calling getKey() on the underlying BackupDataInput .

public int read (byte[] b)

Added in API level 8

Read enough entity data into a byte array to fill the array.

Parameters

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.

Returns

The number of bytes of data read, or zero if all of the entity's data has already been read.

Throws

IOException

public int read ()

Added in API level 8

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.

Returns

The byte read, or undefined if the end of the stream has been reached.

Throws

IOException

public int read (byte[] b, int offset, int size)

Added in API level 8

Read up to size bytes of data into a byte array, beginning at position offset within the array.

Parameters

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.

Returns

The number of bytes of data read, or zero if all of the entity's data has already been read.

Throws

IOException

public int size ()

Added in API level 8

Report the total number of bytes of data available for the current entity.

Returns

The number of data bytes available, equivalent to calling getDataSize() on the underlying BackupDataInput .

java.lang.Object
↳	java.io.InputStream
	↳	android.app.backup.BackupDataInputStream

Results

Interfaces

Classes

Class Overview

See Also

Summary

Public Methods

public String getKey ()

Returns

public int read (byte[] b)

Parameters

Returns

Throws

public int read ()

Returns

Throws

public int read (byte[] b, int offset, int size)

Parameters

Returns

Throws

public int size ()

Returns