java.io

Interface ObjectInput

All Superinterfaces:

AutoCloseable, DataInput

All Known Implementing Classes:

ObjectInputStream

public interface ObjectInput
extends DataInput, AutoCloseable

Defines an interface for classes that allow reading serialized objects.

See Also:

ObjectInputStream, ObjectOutput

Method Summary

Modifier and Type	Method and Description
int	available() Indicates the number of bytes of primitive data that can be read without blocking.
void	close() Closes this stream.
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) Reads bytes from this stream into the byte array buffer.
int	read(byte[] buffer, int byteOffset, int byteCount) Reads up to byteCount bytes from this stream and stores them in byte array buffer starting at offset byteOffset.
Object	readObject() Reads the next object from this stream.
long	skip(long byteCount) Skips byteCount bytes on this stream.

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes

Method Detail

available

int available()
       throws IOException

Indicates the number of bytes of primitive data that can be read without blocking.

Returns:

the number of bytes available.

Throws:

IOException - if an I/O error occurs.

close

void close()
    throws IOException

Closes this stream. Implementations of this method should free any resources used by the stream.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs while closing the input stream.

read

int read()
  throws IOException

Reads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of this stream has been reached. Blocks if no input is available.

Returns:

the byte read or -1 if the end of this stream has been reached.

Throws:

IOException - if this stream is closed or another I/O error occurs.

read

int read(byte[] buffer)
  throws IOException

Reads bytes from this stream into the byte array buffer. Blocks while waiting for input. Returns the number of bytes read, or -1 if the end of this stream has been reached.

Throws:

IOException - if this stream is closed or another I/O error occurs.

read

int read(byte[] buffer,
         int byteOffset,
         int byteCount)
  throws IOException

Reads up to byteCount bytes from this stream and stores them in byte array buffer starting at offset byteOffset. Blocks while waiting for input. Returns the number of bytes read or -1 if the end of this stream has been reached.

Throws:

IOException - if this stream is closed or another I/O error occurs.

readObject

Object readObject()
           throws ClassNotFoundException,
                  IOException

Reads the next object from this stream.

Returns:

the object read.

Throws:

ClassNotFoundException - if the object's class cannot be found.

IOException - if this stream is closed or another I/O error occurs.

skip

long skip(long byteCount)
   throws IOException

Skips byteCount bytes on this stream. Less than byteCount byte are skipped if the end of this stream is reached before the operation completes.

Returns:

the number of bytes actually skipped.

Throws:

IOException - if this stream is closed or another I/O error occurs.