info.pppc.base.io

Interface IObjectInput

All Known Implementing Classes:

ObjectInputStream

public interface IObjectInput

The object input interface is a common interface used to read primitive types and composed objects from some abstract source.

Author:

Marcus Handte

Method Summary

Methods

Modifier and Type	Method and Description
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.
short	readShort() Reads a 16 bit integer.
java.lang.String	readUTF() Reads a utf encoded string.

Method Detail

readBoolean

boolean readBoolean()
                    throws java.io.IOException

Reads a boolean.

Returns:

The next boolean.

Throws:

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

readChar

char readChar()
              throws java.io.IOException

Reads a char.

Returns:

The next char.

Throws:

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

readInt

int readInt()
            throws java.io.IOException

Reads a 32 bit integer.

Returns:

The next 32 bit integer.

Throws:

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

readLong

long readLong()
              throws java.io.IOException

Reads a 64 bit integer.

Returns:

The next 64 bit integer.

Throws:

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

readShort

short readShort()
                throws java.io.IOException

Reads a 16 bit integer.

Returns:

The next 16 bit integer.

Throws:

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

readUTF

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

Reads a utf encoded string.

Returns:

The next utf encoded string.

Throws:

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

readByte

byte readByte()
              throws java.io.IOException

Reads a byte.

Returns:

The next byte.

Throws:

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

readBytes

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 lenght of the buffer.

Parameters:

buffer - The buffer to fill.

Throws:

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

readBytes

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.

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.

readObject

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

Reads an object.

Returns:

The object that has been read.

Throws:

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