edu.iu.dsc.tws.api.comms.packing

Interface DataPacker<D,W>

Type Parameters:

D - data type

W - wrapper to hold partially read data

All Known Subinterfaces:

PrimitiveArrayPacker<A>, PrimitivePacker<T>

All Known Implementing Classes:

ByteArrayPacker, BytePacker, CharArrayPacker, CharPacker, DoubleArrayPacker, DoublePacker, EmptyPacker, FloatArrayPacker, FloatPacker, IntegerArrayPacker, IntegerPacker, LongArrayPacker, LongPacker, ObjectPacker, ShortArrayPacker, ShortPacker, StringPacker

public interface DataPacker<D,W>

The data packer interface. An implementation class should be stateless.

Method Summary

Modifier and Type	Method and Description
int	determineLength(D data, PackerStore store) Pack the data and return the size of the data in bytes once packed.
boolean	isHeaderRequired() Indicates whether length should be packed before the actual key
byte[]	packToByteArray(D data)
java.nio.ByteBuffer	packToByteBuffer(java.nio.ByteBuffer byteBuffer, D data) This method puts a value to the ByteBuffer.
java.nio.ByteBuffer	packToByteBuffer(java.nio.ByteBuffer byteBuffer, int offset, D data) This method puts a value to the ByteBuffer, starting from specified index of the buffer.
int	readDataFromBuffer(ObjectBuilder<D,W> objectBuilder, int currentBufferLocation, DataBuffer dataBuffer) Read the buffer and build the actual object.
D	unpackFromBuffer(java.nio.ByteBuffer byteBuffer, int byteLength) This method will extract a value from buffer starting from buffer's current position.
D	unpackFromBuffer(java.nio.ByteBuffer byteBuffer, int bufferOffset, int byteLength) This method will extract a value from buffer starting from the position specified.
default D	unpackFromByteArray(byte[] array)
W	wrapperForByteLength(int byteLength) Returns an empty wrapper to hold byteLength amount of type T
void	writeDataToBuffer(D data, PackerStore packerStore, int alreadyCopied, int leftToCopy, int spaceLeft, java.nio.ByteBuffer targetBuffer) Transfer the data to the buffer.

Method Detail

determineLength

int determineLength(D data,
                    PackerStore store)

Pack the data and return the size of the data in bytes once packed. However, packing(converting to byte[]) and saving to store inside this method is optional. If your have primitives that can be efficiently copied to the buffers later in writeDataToBuffer(D, edu.iu.dsc.tws.api.comms.packing.PackerStore, int, int, int, java.nio.ByteBuffer), you may just return the byte size of data from this method.

Parameters:

data - the data (can be Integer, Object etc)

store - A store to temporary store the serialized data, if you had to serialize data to determine length.

Returns:

the size of the packed data in bytes

writeDataToBuffer

void writeDataToBuffer(D data,
                       PackerStore packerStore,
                       int alreadyCopied,
                       int leftToCopy,
                       int spaceLeft,
                       java.nio.ByteBuffer targetBuffer)

Transfer the data to the buffer. If you have already packed data to state * with determineLength(Object, PackerStore), you may transfer data from state * to targetBuffer. If not, you may directly transfer data to the targetBuffer.

readDataFromBuffer

int readDataFromBuffer(ObjectBuilder<D,W> objectBuilder,
                       int currentBufferLocation,
                       DataBuffer dataBuffer)

Read the buffer and build the actual object. This method will be called multiple times per object until this method explicitly call ObjectBuilder.setFinalObject(Object) to set and mark the end of the current object

packToByteArray

byte[] packToByteArray(D data)

packToByteBuffer

java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                     D data)

This method puts a value to the ByteBuffer. The position of byteBuffer should be updated.

packToByteBuffer

java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                     int offset,
                                     D data)

This method puts a value to the ByteBuffer, starting from specified index of the buffer. The position of the buffer shouldn't be affected

wrapperForByteLength

W wrapperForByteLength(int byteLength)

Returns an empty wrapper to hold byteLength amount of type T

isHeaderRequired

boolean isHeaderRequired()

Indicates whether length should be packed before the actual key

unpackFromBuffer

D unpackFromBuffer(java.nio.ByteBuffer byteBuffer,
                   int bufferOffset,
                   int byteLength)

This method will extract a value from buffer starting from the position specified. Buffer position shouldn't be affected by this method

Parameters:

byteBuffer - ByteBuffer instance

bufferOffset - position to start reading from buffer

byteLength - amount of data to read

unpackFromBuffer

D unpackFromBuffer(java.nio.ByteBuffer byteBuffer,
                   int byteLength)

This method will extract a value from buffer starting from buffer's current position. Buffer position should be updated.

unpackFromByteArray

default D unpackFromByteArray(byte[] array)