Package org.apache.cassandra.io.util

Class TeeDataInputPlus

java.lang.Object

org.apache.cassandra.io.util.TeeDataInputPlus

All Implemented Interfaces:

DataInput, DataInputPlus

public class TeeDataInputPlus
extends Object
implements DataInputPlus

DataInput that also stores the raw inputs into an output buffer This is useful for storing serialized buffers as they are deserialized. Note: If a non-zero limit is included it is important to for callers to check isLimitReached() before using the tee buffer as it could be cropped.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.io.util.DataInputPlus

DataInputPlus.DataInputStreamPlus

Constructor Summary

Constructors

Constructor	Description
TeeDataInputPlus(DataInputPlus source, DataOutputPlus teeBuffer)
TeeDataInputPlus(DataInputPlus source, DataOutputPlus teeBuffer, long limit)

Method Summary

Modifier and Type	Method	Description
boolean	isLimitReached()	Used to detect if the teeBuffer hit the supplied limit.
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] bytes)
void	readFully(byte[] bytes, int offset, int length)
int	readInt()
String	readLine()
long	readLong()
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
long	readUnsignedVInt()	Think hard before opting for an unsigned encoding.
String	readUTF()
long	readVInt()	Read a 64-bit integer back.
int	skipBytes(int n)	Always skips the requested number of bytes, unless EOF is reached
void	skipBytesFully(int n)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cassandra.io.util.DataInputPlus

readUnsignedVInt32, readVInt32

Constructor Details

TeeDataInputPlus

public TeeDataInputPlus(DataInputPlus source,
 DataOutputPlus teeBuffer)

TeeDataInputPlus

public TeeDataInputPlus(DataInputPlus source,
 DataOutputPlus teeBuffer,
 long limit)

Method Details

readFully

public void readFully(byte[] bytes)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] bytes,
 int offset,
 int length)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Description copied from interface: DataInputPlus

Always skips the requested number of bytes, unless EOF is reached

Specified by:

skipBytes in interface DataInput

Specified by:

skipBytes in interface DataInputPlus

Parameters:

n - number of bytes to skip

Returns:

number of bytes skipped

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

readVInt

public long readVInt()
              throws IOException

Description copied from interface: DataInputPlus

Read a 64-bit integer back. This method assumes it was originally written using DataOutputPlus.writeVInt(long) or similar that zigzag encodes the vint.

Specified by:

readVInt in interface DataInputPlus

Throws:

IOException

readUnsignedVInt

public long readUnsignedVInt()
                      throws IOException

Description copied from interface: DataInputPlus

Think hard before opting for an unsigned encoding. Is this going to bite someone because some day they might need to pass in a sentinel value using negative numbers? Is the risk worth it to save a few bytes? Signed, not a fan of unsigned values in protocols and formats

Specified by:

readUnsignedVInt in interface DataInputPlus

Throws:

IOException

skipBytesFully

public void skipBytesFully(int n)
                    throws IOException

Specified by:

skipBytesFully in interface DataInputPlus

Throws:

IOException

isLimitReached

public boolean isLimitReached()

Used to detect if the teeBuffer hit the supplied limit. If true this means the teeBuffer does not contain the full input.