info.pppc.base.io

Class ObjectInputStream

java.lang.Object

java.io.InputStream

info.pppc.base.io.ObjectInputStream

All Implemented Interfaces:

IObjectInput, java.io.Closeable, java.lang.AutoCloseable

public final class ObjectInputStream
extends java.io.InputStream
implements IObjectInput

This simple (and rather slow) ObjectInputStream is capable of reading objects that have been serialized with an ObjectOutputStream. It supports primitive arrays, object arrays, primitive type wrapper arrays and objects with one of the following types java.util.Hashtable, java.util.Stack, java.util.Vector and base.system.io.Serializable.

Author:

Marcus Handte

Constructor Summary

Constructors

Constructor and Description
ObjectInputStream(java.io.InputStream stream) Creates a new ObjectInputStream that uses the passed DataInputStream to read from.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the underlying DataInputStream.
int	read() Reads a byte from the underlying DataInputStream.
boolean	readBoolean() Reads a boolean.
byte	readByte() Reads a byte.
void	readBytes(byte[] buffer) Reads a number of bytes and writes them into the buffer.
void	readBytes(byte[] buffer, int offset, int length) Reads a number of bytes and writes them into the buffer starting from the specified offset.
char	readChar() Reads a char.
int	readInt() Reads a 32 bit integer.
long	readLong() Reads a 64 bit integer.
java.lang.Object	readObject() Reads an object from the underlying DataInputStream.
short	readShort() Reads a 16 bit integer.
java.lang.String	readUTF() Reads a utf encoded string.

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectInputStream

public ObjectInputStream(java.io.InputStream stream)

Creates a new ObjectInputStream that uses the passed DataInputStream to read from.

Parameters:

stream - The DataInputStream to read from.

Method Detail

read

public int read()
         throws java.io.IOException

Reads a byte from the underlying DataInputStream.

Specified by:

read in class java.io.InputStream

Returns:

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

Throws:

java.io.IOException - Thrown if the underlying stream throws an exception.

readObject

public java.lang.Object readObject()
                            throws java.io.IOException

Reads an object from the underlying DataInputStream.

Specified by:

readObject in interface IObjectInput

Returns:

The object that has been read from the stream.

Throws:

java.io.IOException - Thrown if the object could not be read.

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Reads a boolean.

Specified by:

readBoolean in interface IObjectInput

Returns:

The next boolean.

Throws:

java.io.IOException - Thrown if a problem occurs.

readChar

public char readChar()
              throws java.io.IOException

Reads a char.

Specified by:

readChar in interface IObjectInput

Returns:

The next char.

Throws:

java.io.IOException - Thrown if a problem occurs.

readInt

public int readInt()
            throws java.io.IOException

Reads a 32 bit integer.

Specified by:

readInt in interface IObjectInput

Returns:

The next 32 bit integer.

Throws:

java.io.IOException - Thrown if a problem occurs.

readLong

public long readLong()
              throws java.io.IOException

Reads a 64 bit integer.

Specified by:

readLong in interface IObjectInput

Returns:

The next 64 bit integer.

Throws:

java.io.IOException - Thrown if a problem occurs.

readShort

public short readShort()
                throws java.io.IOException

Reads a 16 bit integer.

Specified by:

readShort in interface IObjectInput

Returns:

The next 16 bit integer.

Throws:

java.io.IOException - Thrown if a problem occurs.

readUTF

public java.lang.String readUTF()
                         throws java.io.IOException

Reads a utf encoded string.

Specified by:

readUTF in interface IObjectInput

Returns:

The next utf encoded string.

Throws:

java.io.IOException - Thrown if a problem occurs.

readByte

public byte readByte()
              throws java.io.IOException

Reads a byte.

Specified by:

readByte in interface IObjectInput

Returns:

The next byte.

Throws:

java.io.IOException - Thrown if a problem occurs.

readBytes

public void readBytes(byte[] buffer)
               throws java.io.IOException

Reads a number of bytes and writes them into the buffer. The number of bytes read is defined by the length of the buffer.

Specified by:

readBytes in interface IObjectInput

Parameters:

buffer - The buffer to fill.

Throws:

java.io.IOException - Thrown if a problem occurs.

readBytes

public void readBytes(byte[] buffer,
             int offset,
             int length)
               throws java.io.IOException

Reads a number of bytes and writes them into the buffer starting from the specified offset. The number of bytes read is defined by the length parameter.

Specified by:

readBytes in interface IObjectInput

Parameters:

buffer - The buffer to fill.

offset - The offset to start from.

length - The number of bytes to fill.

Throws:

java.io.IOException - Thrown if a problem occurs.

close

public void close()
           throws java.io.IOException

Closes the underlying DataInputStream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - Thrown if closing the underlying stream caused an exception.