Class RowInput

java.lang.Object

RowInput

public class RowInput
extends Object

An input stream with methods that read values from a byte array. It uses a DataInputStream, and it is similar to the TupleInput class from Berkeley DB's Bind API. We're using our own version so that we can make it easier to perform the types of reads that are needed during unmarshalling.

Constructor Summary

Constructors

Constructor and Description
RowInput(byte[] bytes) Constructs a RowInput object

Method Summary

Modifier and Type	Method and Description
boolean	readBooleanAtOffset(int offset) reads a boolean at the specified offset in this RowInput's byte array
byte	readByteAtOffset(int offset) reads one byte at the specified offset in this RowInput's byte array
String	readBytesAtOffset(int offset, int numBytes) returns a String constructed by reading numBytes bytes at the specified offset in this RowInput's byte array
double	readDoubleAtOffset(int offset) reads a value of type double at the specified offset in this RowInput's byte array
int	readIntAtOffset(int offset) reads an int (a four-byte integer) at the specified offset in this RowInput's byte array
boolean	readNextBoolean() reads a boolean at the current offset in this RowInput's byte array
byte	readNextByte() reads one byte at the current offset in this RowInput's byte array
String	readNextBytes(int numBytes) returns a String constructed by reading numBytes bytes at the current offset in this RowInput's byte array
double	readNextDouble() reads a value of type double at the current offset in this RowInput's byte array
int	readNextInt() reads an int (a four-byte integer) at the current offset in this RowInput's byte array
short	readNextShort() reads a short (a two-byte integer) at the current offset in this RowInput's byte array
short	readShortAtOffset(int offset) reads a short (a two-byte integer) at the specified offset in this RowInput's byte array
String	toString() Returns a String representation of this RowInput object that includes the underlying byte array and the current offset.

Methods inherited from class java.lang.Object

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

Constructor Detail

RowInput

public RowInput(byte[] bytes)

Constructs a RowInput object

Method Detail

readBooleanAtOffset

public boolean readBooleanAtOffset(int offset)

reads a boolean at the specified offset in this RowInput's byte array

Returns:

the boolean value that was read

Throws:

IllegalArgumentException - if offset is negative or too large

IllegalStateException - if the read cannot be performed for some other reason

readNextBoolean

public boolean readNextBoolean()

reads a boolean at the current offset in this RowInput's byte array

Returns:

the boolean value that was read

Throws:

IllegalStateException - if the read cannot be performed

readByteAtOffset

public byte readByteAtOffset(int offset)

reads one byte at the specified offset in this RowInput's byte array

Returns:

the byte that was read

Throws:

IllegalArgumentException - if offset is negative or too large

IllegalStateException - if the read cannot be performed for some other reason

readNextByte

public byte readNextByte()

reads one byte at the current offset in this RowInput's byte array

Returns:

the byte that was read

Throws:

IllegalStateException - if the read cannot be performed

readShortAtOffset

public short readShortAtOffset(int offset)

reads a short (a two-byte integer) at the specified offset in this RowInput's byte array

Returns:

the short that was read

Throws:

IllegalArgumentException - if offset is negative or too large

IllegalStateException - if the read cannot be performed for some other reason

readNextShort

public short readNextShort()

reads a short (a two-byte integer) at the current offset in this RowInput's byte array

Returns:

the short that was read

Throws:

IllegalStateException - if the read cannot be performed

readIntAtOffset

public int readIntAtOffset(int offset)

reads an int (a four-byte integer) at the specified offset in this RowInput's byte array

Returns:

the integer that was read

Throws:

IllegalArgumentException - if offset is negative or too large

IllegalStateException - if the read cannot be performed for some other reason

readNextInt

public int readNextInt()

reads an int (a four-byte integer) at the current offset in this RowInput's byte array

Returns:

the integer that was read

Throws:

IllegalStateException - if the read cannot be performed

readDoubleAtOffset

public double readDoubleAtOffset(int offset)

reads a value of type double at the specified offset in this RowInput's byte array

Returns:

the double that was read

Throws:

IllegalArgumentException - if offset is negative or too large

IllegalStateException - if the read cannot be performed for some other reason

readNextDouble

public double readNextDouble()

reads a value of type double at the current offset in this RowInput's byte array

Returns:

the double that was read

Throws:

IllegalStateException - if the read cannot be performed

readBytesAtOffset

public String readBytesAtOffset(int offset,
                                int numBytes)

returns a String constructed by reading numBytes bytes at the specified offset in this RowInput's byte array

Returns:

the String that was read

Throws:

IllegalArgumentException - if either value is negative or if offset is too large to read numBytes bytes

IllegalStateException - if the read cannot be performed for some other reason

readNextBytes

public String readNextBytes(int numBytes)

returns a String constructed by reading numBytes bytes at the current offset in this RowInput's byte array

Returns:

the String that was read

Throws:

IllegalArgumentException - if numBytes is negative or if it is too large given the current offset

IllegalStateException - if the read cannot be performed for some other reason

toString

public String toString()

Returns a String representation of this RowInput object that includes the underlying byte array and the current offset.

Overrides:

toString in class Object

Returns:

a String for this RowInput