public interface

ObjectInput

implements DataInput
java.io.ObjectInput
Known Indirect Subclasses

Class Overview

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(byte[] b)
Reads into an array of bytes.
abstract int read()
Reads a byte of data.
abstract int read(byte[] b, int off, int len)
Reads into an array of bytes.
abstract Object readObject()
Read and return an object.
abstract long skip(long n)
Skips n bytes of input.
[Expand]
Inherited Methods
From interface java.io.DataInput

Public Methods

public abstract int available ()

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

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

public abstract 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.

public abstract int read (byte[] b)

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

Parameters
b the buffer into which the data is read
Returns
  • 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.

public abstract int read ()

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

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

public abstract 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 the buffer into which the data is read
off the start offset of the data
len the maximum number of bytes read
Returns
  • 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.

public abstract Object readObject ()

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

Returns
  • 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.

public abstract long skip (long n)

Skips n bytes of input.

Parameters
n the number of bytes to be skipped
Returns
  • the actual number of bytes skipped.
Throws
IOException If an I/O error has occurred.