com.tangosol.io

Class PackedDataInputStream

java.lang.Object

java.io.InputStream

com.tangosol.io.WrapperInputStream

com.tangosol.io.PackedDataInputStream

All Implemented Interfaces:

com.oracle.coherence.common.io.InputStreaming, Closeable, DataInput, AutoCloseable

public class PackedDataInputStream
extends WrapperInputStream
implements DataInput

This is an imitation DataInputStream class that reads from streams that were produced by a corresponding PackedDataOutputStream.

Author:

cp 2004.09.09

Constructor Summary

Constructors

Constructor and Description
PackedDataInputStream(InputStream in) Construct a WrapperDataInputStream that will read from the specified InputStream object.

Method Summary

Modifier and Type	Method and Description
boolean	readBoolean() Read a boolean value.
byte	readByte() Read a byte value.
char	readChar() Read a char value.
double	readDouble() Read a double value.
float	readFloat() Read a float value.
void	readFully(byte[] ab) Read ab.length bytes and store them in ab.
void	readFully(byte[] ab, int of, int cb) Read cb bytes and store them in ab starting at offset of.
int	readInt() Read an int value.
String	readLine() Reads the next "line" of text.
long	readLong() Read a long value.
short	readShort() Read a short value.
int	readUnsignedByte() Read an unsigned byte value.
int	readUnsignedShort() Read an unsigned short value.
String	readUTF() Reads a String value.
int	skipBytes(int cb) Skips over up to the specified number of bytes of data.

Methods inherited from class com.tangosol.io.WrapperInputStream

available, close, ensureInputStream, getInputStream, mark, markSupported, read, read, read, reset, setInputStream, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

PackedDataInputStream

public PackedDataInputStream(InputStream in)

Construct a WrapperDataInputStream that will read from the specified InputStream object.

Parameters:

in - an InputStream to read from

Method Detail

readFully

public void readFully(byte[] ab)
               throws IOException

Read ab.length bytes and store them in ab.

This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

readFully in interface DataInput

Parameters:

ab - the array to store the bytes which are read from the stream

Throws:

NullPointerException - if the passed array is null

EOFException - if the stream is exhausted before the number of bytes indicated by the array length could be read

IOException - if an I/O error occurs

readFully

public void readFully(byte[] ab,
                      int of,
                      int cb)
               throws IOException

Read cb bytes and store them in ab starting at offset of.

This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

readFully in interface DataInput

Parameters:

ab - the array to store the bytes which are read from the stream

of - the offset into the array that the read bytes will be stored

cb - the maximum number of bytes to read

Throws:

NullPointerException - if the passed array is null

IndexOutOfBoundsException - if of or cb is negative, or of+cb is greater than the length of the ab

EOFException - if the stream is exhausted before the number of bytes indicated by the array length could be read

IOException - if an I/O error occurs

skipBytes

public int skipBytes(int cb)
              throws IOException

Skips over up to the specified number of bytes of data. The number of bytes actually skipped over may be fewer than the number specified to skip, and may even be zero; this can be caused by an end-of-file condition, but can also occur even when there is data remaining to be read. As a result, the caller should check the return value from this method, which indicates the actual number of bytes skipped.

Specified by:

skipBytes in interface DataInput

Parameters:

cb - the maximum number of bytes to skip over

Returns:

the actual number of bytes that were skipped over

Throws:

IOException - if an I/O error occurs

readBoolean

public boolean readBoolean()
                    throws IOException

Read a boolean value.

This method is the counterpart for the DataOutput.writeBoolean(boolean) method.

Specified by:

readBoolean in interface DataInput

Returns:

either true or false

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readByte

public byte readByte()
              throws IOException

Read a byte value.

This method is the counterpart for the DataOutput.writeByte(int) method.

Specified by:

readByte in interface DataInput

Returns:

a byte value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Read an unsigned byte value.

This method is the counterpart for the DataOutput.writeByte(int) method when it is used with unsigned 8-bit values.

Specified by:

readUnsignedByte in interface DataInput

Returns:

an int value in the range 0x00 to 0xFF

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readShort

public short readShort()
                throws IOException

Read a short value.

This method is the counterpart for the DataOutput.writeShort(int) method.

Specified by:

readShort in interface DataInput

Returns:

a short value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Read an unsigned short value.

This method is the counterpart for the DataOutput.writeShort(int) method when it is used with unsigned 16-bit values.

Specified by:

readUnsignedShort in interface DataInput

Returns:

an int value in the range of 0x0000 to 0xFFFF

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readChar

public char readChar()
              throws IOException

Read a char value.

This method is the counterpart for the DataOutput.writeChar(int) method.

Specified by:

readChar in interface DataInput

Returns:

a char value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readInt

public int readInt()
            throws IOException

Read an int value.

This method is the counterpart for the DataOutput.writeInt(int) method.

Specified by:

readInt in interface DataInput

Returns:

an int value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readLong

public long readLong()
              throws IOException

Read a long value.

This method is the counterpart for the DataOutput.writeLong(long) method.

Specified by:

readLong in interface DataInput

Returns:

a long value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readFloat

public float readFloat()
                throws IOException

Read a float value.

This method is the counterpart for the DataOutput.writeFloat(float) method.

Specified by:

readFloat in interface DataInput

Returns:

a float value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readDouble

public double readDouble()
                  throws IOException

Read a double value.

This method is the counterpart for the DataOutput.writeDouble(double) method.

Specified by:

readDouble in interface DataInput

Returns:

a double value

Throws:

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs

readLine

public String readLine()
                throws IOException

Reads the next "line" of text.

This method does not have a counterpart in the DataOutput interface. Furthermore, this method is defined as operating on bytes and not on characters, and thus it should be selected for use only after careful consideration, as if it were deprecated.

Specified by:

readLine in interface DataInput

Returns:

a line of text as a String

Throws:

IOException - if an I/O error occurs.

readUTF

public String readUTF()
               throws IOException

Reads a String value.

This method is the counterpart for the DataOutput.writeUTF(java.lang.String) method.

Specified by:

readUTF in interface DataInput

Returns:

a String value

Throws:

UTFDataFormatException - if the bytes that were read were not a valid UTF-8 encoded string

EOFException - if the value could not be read because no more data remains to be read

IOException - if an I/O error occurs