com.tangosol.io
Class PackedDataInputStream

java.lang.Object
  java.io.InputStream
      com.tangosol.io.WrapperInputStream
          com.tangosol.io.PackedDataInputStream

All Implemented Interfaces:

InputStreaming, java.io.Closeable, java.io.DataInput

public class PackedDataInputStream
extends WrapperInputStream
implements java.io.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

PackedDataInputStream(java.io.InputStream in)
Construct a WrapperDataInputStream that will read from the specified InputStream object.

Method Summary

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.
java.lang.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.
java.lang.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

Constructor Detail

PackedDataInputStream

public PackedDataInputStream(java.io.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 java.io.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 java.io.DataInput

Parameters:

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

Throws:

java.lang.NullPointerException - if the passed array is null

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

java.io.IOException - if an I/O error occurs

readFully

public void readFully(byte[] ab,
                      int of,
                      int cb)
               throws java.io.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 java.io.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:

java.lang.NullPointerException - if the passed array is null

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

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

java.io.IOException - if an I/O error occurs

skipBytes

public int skipBytes(int cb)
              throws java.io.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 java.io.DataInput

Parameters:

cb - the maximum number of bytes to skip over

Returns:

the actual number of bytes that were skipped over

Throws:

java.io.IOException - if an I/O error occurs

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Read a boolean value.

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

Specified by:

readBoolean in interface java.io.DataInput

Returns:

either true or false

Throws:

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

java.io.IOException - if an I/O error occurs

readByte

public byte readByte()
              throws java.io.IOException

Read a byte value.

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

Specified by:

readByte in interface java.io.DataInput

Returns:

a byte value

Throws:

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

java.io.IOException - if an I/O error occurs

readUnsignedByte

public int readUnsignedByte()
                     throws java.io.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 java.io.DataInput

Returns:

an int value in the range 0x00 to 0xFF

Throws:

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

java.io.IOException - if an I/O error occurs

readShort

public short readShort()
                throws java.io.IOException

Read a short value.

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

Specified by:

readShort in interface java.io.DataInput

Returns:

a short value

Throws:

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

java.io.IOException - if an I/O error occurs

readUnsignedShort

public int readUnsignedShort()
                      throws java.io.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 java.io.DataInput

Returns:

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

Throws:

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

java.io.IOException - if an I/O error occurs

readChar

public char readChar()
              throws java.io.IOException

Read a char value.

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

Specified by:

readChar in interface java.io.DataInput

Returns:

a char value

Throws:

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

java.io.IOException - if an I/O error occurs

readInt

public int readInt()
            throws java.io.IOException

Read an int value.

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

Specified by:

readInt in interface java.io.DataInput

Returns:

an int value

Throws:

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

java.io.IOException - if an I/O error occurs

readLong

public long readLong()
              throws java.io.IOException

Read a long value.

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

Specified by:

readLong in interface java.io.DataInput

Returns:

a long value

Throws:

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

java.io.IOException - if an I/O error occurs

readFloat

public float readFloat()
                throws java.io.IOException

Read a float value.

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

Specified by:

readFloat in interface java.io.DataInput

Returns:

a float value

Throws:

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

java.io.IOException - if an I/O error occurs

readDouble

public double readDouble()
                  throws java.io.IOException

Read a double value.

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

Specified by:

readDouble in interface java.io.DataInput

Returns:

a double value

Throws:

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

java.io.IOException - if an I/O error occurs

readLine

public java.lang.String readLine()
                          throws java.io.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 java.io.DataInput

Returns:

a line of text as a String

Throws:

java.io.IOException - if an I/O error occurs.

readUTF

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

Reads a String value.

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

Specified by:

readUTF in interface java.io.DataInput

Returns:

a String value

Throws:

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

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

java.io.IOException - if an I/O error occurs