Skip to content

Most visited

Recently visited

navigation

ObjectInput

public interface ObjectInput
implements DataInput, AutoCloseable

java.io.ObjectInput
Known Indirect Subclasses


ObjectInput extends the DataInput interface to include the reading of objects. DataInput includes methods for the input of primitive types, ObjectInput extends that interface to include objects, arrays, and Strings.

See also:

Summary

Public methods

abstract int available()

Returns the number of bytes that can be read without blocking.

abstract void close()

Closes the input stream.

abstract int read()

Reads a byte of data.

abstract int read(byte[] b, int off, int len)

Reads into an array of bytes.

abstract int read(byte[] b)

Reads into an array of bytes.

abstract Object readObject()

Read and return an object.

abstract long skip(long n)

Skips n bytes of input.

Inherited methods

From interface java.io.DataInput
From interface java.lang.AutoCloseable

Public methods

available

Added in API level 1
int available ()

Returns the number of bytes that can be read without blocking.

Returns
int the number of available bytes.
Throws
IOException If an I/O error has occurred.

close

Added in API level 1
void close ()

Closes the input stream. Must be called to release any resources associated with the stream.

Throws
IOException If an I/O error has occurred.

read

Added in API level 1
int read ()

Reads a byte of data. This method will block if no input is available.

Returns
int the byte read, or -1 if the end of the stream is reached.
Throws
IOException If an I/O error has occurred.

read

Added in API level 1
int read (byte[] b, 
                int off, 
                int len)

Reads into an array of bytes. This method will block until some input is available.

Parameters
b byte: the buffer into which the data is read
off int: the start offset of the data
len int: the maximum number of bytes read
Returns
int the actual number of bytes read, -1 is returned when the end of the stream is reached.
Throws
IOException If an I/O error has occurred.

read

Added in API level 1
int read (byte[] b)

Reads into an array of bytes. This method will block until some input is available.

Parameters
b byte: the buffer into which the data is read
Returns
int the actual number of bytes read, -1 is returned when the end of the stream is reached.
Throws
IOException If an I/O error has occurred.

readObject

Added in API level 1
Object readObject ()

Read and return an object. The class that implements this interface defines where the object is "read" from.

Returns
Object the object read from the stream
Throws
ClassNotFoundException If the class of a serialized object cannot be found.
IOException If any of the usual Input/Output related exceptions occur.

skip

Added in API level 1
long skip (long n)

Skips n bytes of input.

Parameters
n long: the number of bytes to be skipped
Returns
long the actual number of bytes skipped.
Throws
IOException If an I/O error has occurred.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.