ObjectInput interface in Java

java.io.ObjectInput

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

Super Interfaces:

AutoCloseable, DataInput

Implementing Classes:

ObjectInputStream

Declaration

    public interface ObjectInput extends 
                         DataInput, AutoCloseable {

        public Object readObject() throws ClassNotFoundException, IOException;

        public int read() throws IOException;

        public int read(byte b[]) throws IOException;

        public int read(byte b[], int off, int len) 
                                      throws IOException;

        public long skip(long n) throws IOException;

        public int available() throws IOException;

        public void close() throws IOException;
    }

Methods of ObjectInput

1. readObject()

Object java.io.ObjectInput.readObject() throws ClassNotFoundException, IOException

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:

1. java.lang.ClassNotFoundException - If the class of a serialized object cannot be found.

2. IOException - If any of the usual Input/Output related exceptions occur.

2. read()

int java.io.ObjectInput.read() throws IOException

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.

3. read(byte[] b)

int java.io.ObjectInput.read(byte[] b) throws IOException

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.

4. read(byte[] b, int off, int len)

int java.io.ObjectInput.read(byte[] b, int off, int len) throws IOException

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.

5. skip(long n)

long java.io.ObjectInput.skip(long n) throws IOException

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.

6. available()

int java.io.ObjectInput.available() throws IOException

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.

7. close()

void java.io.ObjectInput.close() throws IOException

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

Throws:

IOException - If an I/O error has occurred.

Flushable interface in Java

FilenameFilter interface in Java

FileFilter interface in Java

DataInput interface in Java

Closeable interface in java

Externalizable interface in Java

Serializable interface in Java

ObjectInputValidation interface in Java

ObjectInputFilter interface in Java

DataOutput interface in Java

ObjectInput interface in Java

ObjectStreamConstants interface in Java

ObjectOutput interface in Java