Package org.apache.flink.core.memory

Class DataInputDeserializer

java.lang.Object

org.apache.flink.core.memory.DataInputDeserializer

All Implemented Interfaces:

DataInput, Serializable, DataInputView

public class DataInputDeserializer
extends Object
implements DataInputView, Serializable

A simple and efficient deserializer for the DataInput interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DataInputDeserializer()
DataInputDeserializer(byte[] buffer)
DataInputDeserializer(byte[] buffer, int start, int len)
DataInputDeserializer(ByteBuffer buffer)

Method Summary

Modifier and Type	Method	Description
int	available()
int	getPosition()
int	read(byte[] b)	Tries to fill the given byte array b.
int	read(byte[] b, int off, int len)	Reads up to len bytes of memory and stores it into b starting at offset off.
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
int	readInt()
String	readLine()
long	readLong()
String	readLongUTF()	Similar to readUTF().
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()
void	releaseArrays()
void	setBuffer(byte[] buffer)
void	setBuffer(byte[] buffer, int start, int len)
void	setBuffer(ByteBuffer buffer)
int	skipBytes(int n)
void	skipBytesToRead(int numBytes)	Skips numBytes bytes of memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataInputDeserializer

public DataInputDeserializer()

DataInputDeserializer

public DataInputDeserializer(@Nonnull
                             byte[] buffer)

DataInputDeserializer

public DataInputDeserializer(@Nonnull
                             byte[] buffer,
                             int start,
                             int len)

DataInputDeserializer

public DataInputDeserializer(@Nonnull
                             ByteBuffer buffer)

Method Detail

setBuffer

public void setBuffer(@Nonnull
                      ByteBuffer buffer)

setBuffer

public void setBuffer(@Nonnull
                      byte[] buffer,
                      int start,
                      int len)

setBuffer

public void setBuffer(@Nonnull
                      byte[] buffer)

releaseArrays

public void releaseArrays()

available

public int available()

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

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readFully

public void readFully(@Nonnull
                      byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(@Nonnull
                      byte[] b,
                      int off,
                      int len)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLine

@Nullable
public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUTF

@Nonnull
public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

readLongUTF

public String readLongUTF()
                   throws IOException

Similar to readUTF(). The size is stored in the manner of the readInt() method, the character conversion is the same.

Returns:

a Unicode string.

Throws:

EOFException - – if this stream reaches the end before reading all the bytes.

IOException - – if an I/O error occurs.

UTFDataFormatException - – if the bytes do not represent a valid modified UTF-8 encoding of a string.

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)

Specified by:

skipBytes in interface DataInput

skipBytesToRead

public void skipBytesToRead(int numBytes)
                     throws IOException

Description copied from interface: DataInputView

Skips numBytes bytes of memory. In contrast to the DataInput.skipBytes(int) method, this method always skips the desired number of bytes or throws an EOFException.

Specified by:

skipBytesToRead in interface DataInputView

Parameters:

numBytes - The number of bytes to skip.

Throws:

IOException - Thrown, if any I/O related problem occurred such that the input could not be advanced to the desired position.

read

public int read(@Nonnull
                byte[] b,
                int off,
                int len)
         throws IOException

Description copied from interface: DataInputView

Reads up to len bytes of memory and stores it into b starting at offset off.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If there is no more data left, the value -1 is returned; otherwise, at least one byte is read and stored into b.

Specified by:

read in interface DataInputView

Parameters:

b - byte array to store the data to

off - offset into byte array

len - byte length to read

Returns:

the number of actually read bytes of -1 if there is no more data left

Throws:

IOException

read

public int read(@Nonnull
                byte[] b)
         throws IOException

Description copied from interface: DataInputView

Tries to fill the given byte array b. Returns the actually number of read bytes or -1 if there is no more data.

Specified by:

read in interface DataInputView

Parameters:

b - byte array to store the data to

Returns:

the number of read bytes or -1 if there is no more data left

Throws:

IOException

getPosition

public int getPosition()