Package org.apache.flink.core.memory

Class DataOutputSerializer

java.lang.Object

org.apache.flink.core.memory.DataOutputSerializer

All Implemented Interfaces:

DataOutput, DataOutputView, MemorySegmentWritable

public class DataOutputSerializer
extends Object
implements DataOutputView, MemorySegmentWritable

A simple and efficient serializer for the DataOutput interface.

Constructor Summary

Constructors

Constructor	Description
DataOutputSerializer(int startSize)

Method Summary

Modifier and Type	Method	Description
void	clear()
byte[]	getByteArray()	Deprecated. Replaced by getSharedBuffer() for a better, safer name.
byte[]	getCopyOfBuffer()	Gets a copy of the buffer that has the right length for the data serialized so far.
byte[]	getSharedBuffer()	Gets a reference to the internal byte buffer.
int	length()
void	setPosition(int position)
void	setPositionUnsafe(int position)
void	skipBytesToWrite(int numBytes)	Skips numBytes bytes memory.
String	toString()
ByteBuffer	wrapAsByteBuffer()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)
void	write(DataInputView source, int numBytes)	Copies numBytes bytes from the source to this view.
void	write(MemorySegment segment, int off, int len)	Writes len bytes from memory segment segment starting at offset off, in order, to the output.
void	writeBoolean(boolean v)
void	writeByte(int v)
void	writeBytes(String s)
void	writeChar(int v)
void	writeChars(String s)
void	writeDouble(double v)
void	writeFloat(float v)
void	writeInt(int v)
void	writeIntUnsafe(int v, int pos)
void	writeLong(long v)
void	writeLongUTF(String str)	Similar to writeUTF(String).
void	writeShort(int v)
void	writeUTF(String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataOutputSerializer

public DataOutputSerializer(int startSize)

Method Detail

wrapAsByteBuffer

public ByteBuffer wrapAsByteBuffer()

getByteArray

@Deprecated
public byte[] getByteArray()

Deprecated.

Replaced by getSharedBuffer() for a better, safer name.

getSharedBuffer

public byte[] getSharedBuffer()

Gets a reference to the internal byte buffer. This buffer may be larger than the actual serialized data. Only the bytes from zero to length() are valid. The buffer will also be overwritten with the next write calls.

This method is useful when trying to avid byte copies, but should be used carefully.

Returns:

A reference to the internal shared and reused buffer.

getCopyOfBuffer

public byte[] getCopyOfBuffer()

Gets a copy of the buffer that has the right length for the data serialized so far. The returned buffer is an exclusive copy and can be safely used without being overwritten by future write calls to this serializer.

This method is equivalent to Arrays.copyOf(getSharedBuffer(), length());

Returns:

A non-shared copy of the serialization buffer.

clear

public void clear()

length

public int length()

toString

public String toString()

Overrides:

toString in class Object

write

public void write(int b)
           throws IOException

Specified by:

write in interface DataOutput

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Specified by:

write in interface DataOutput

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Specified by:

write in interface DataOutput

Throws:

IOException

write

public void write(MemorySegment segment,
                  int off,
                  int len)
           throws IOException

Description copied from interface: MemorySegmentWritable

Writes len bytes from memory segment segment starting at offset off, in order, to the output.

Specified by:

write in interface MemorySegmentWritable

Parameters:

segment - memory segment to copy the bytes from.

off - the start offset in the memory segment.

len - The number of bytes to copy.

Throws:

IOException - if an I/O error occurs.

writeBoolean

public void writeBoolean(boolean v)
                  throws IOException

Specified by:

writeBoolean in interface DataOutput

Throws:

IOException

writeByte

public void writeByte(int v)
               throws IOException

Specified by:

writeByte in interface DataOutput

Throws:

IOException

writeBytes

public void writeBytes(String s)
                throws IOException

Specified by:

writeBytes in interface DataOutput

Throws:

IOException

writeChar

public void writeChar(int v)
               throws IOException

Specified by:

writeChar in interface DataOutput

Throws:

IOException

writeChars

public void writeChars(String s)
                throws IOException

Specified by:

writeChars in interface DataOutput

Throws:

IOException

writeDouble

public void writeDouble(double v)
                 throws IOException

Specified by:

writeDouble in interface DataOutput

Throws:

IOException

writeFloat

public void writeFloat(float v)
                throws IOException

Specified by:

writeFloat in interface DataOutput

Throws:

IOException

writeInt

public void writeInt(int v)
              throws IOException

Specified by:

writeInt in interface DataOutput

Throws:

IOException

writeIntUnsafe

public void writeIntUnsafe(int v,
                           int pos)
                    throws IOException

Throws:

IOException

writeLong

public void writeLong(long v)
               throws IOException

Specified by:

writeLong in interface DataOutput

Throws:

IOException

writeShort

public void writeShort(int v)
                throws IOException

Specified by:

writeShort in interface DataOutput

Throws:

IOException

writeUTF

public void writeUTF(String str)
              throws IOException

Specified by:

writeUTF in interface DataOutput

Throws:

IOException

writeLongUTF

public void writeLongUTF(String str)
                  throws IOException

Similar to writeUTF(String). The size is only limited by the maximum java array size of the buffer.

Parameters:

str - the string value to be written.

Throws:

IOException - if an I/O error occurs.

skipBytesToWrite

public void skipBytesToWrite(int numBytes)
                      throws IOException

Description copied from interface: DataOutputView

Skips numBytes bytes memory. If some program reads the memory that was skipped over, the results are undefined.

Specified by:

skipBytesToWrite in interface DataOutputView

Parameters:

numBytes - The number of bytes to skip.

Throws:

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

write

public void write(DataInputView source,
                  int numBytes)
           throws IOException

Description copied from interface: DataOutputView

Copies numBytes bytes from the source to this view.

Specified by:

write in interface DataOutputView

Parameters:

source - The source to copy the bytes from.

numBytes - The number of bytes to copy.

Throws:

IOException - Thrown, if any I/O related problem occurred, such that either the input view could not be read, or the output could not be written.

setPosition

public void setPosition(int position)

setPositionUnsafe

public void setPositionUnsafe(int position)