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

Class ObjectPacker

java.lang.Object

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

All Implemented Interfaces:

DataPacker<java.lang.Object,byte[]>

public final class ObjectPacker
extends java.lang.Object
implements DataPacker<java.lang.Object,byte[]>

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.dsc.tws.api.comms.packing.DataPacker

unpackFromByteArray

Method Detail

getInstance

public static DataPacker<java.lang.Object,byte[]> getInstance()

determineLength

public int determineLength(java.lang.Object data,
                           PackerStore store)

Description copied from interface: DataPacker

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 DataPacker.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.

Specified by:

determineLength in interface DataPacker<java.lang.Object,byte[]>

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

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

Description copied from interface: DataPacker

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

Specified by:

writeDataToBuffer in interface DataPacker<java.lang.Object,byte[]>

readDataFromBuffer

public int readDataFromBuffer(ObjectBuilder objectBuilder,
                              int currentBufferLocation,
                              DataBuffer dataBuffer)

Description copied from interface: DataPacker

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

Specified by:

readDataFromBuffer in interface DataPacker<java.lang.Object,byte[]>

packToByteArray

public byte[] packToByteArray(java.lang.Object data)

Specified by:

packToByteArray in interface DataPacker<java.lang.Object,byte[]>

packToByteBuffer

public java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                            java.lang.Object data)

Description copied from interface: DataPacker

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

Specified by:

packToByteBuffer in interface DataPacker<java.lang.Object,byte[]>

packToByteBuffer

public java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                            int offset,
                                            java.lang.Object data)

Description copied from interface: DataPacker

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

Specified by:

packToByteBuffer in interface DataPacker<java.lang.Object,byte[]>

wrapperForByteLength

public byte[] wrapperForByteLength(int byteLength)

Description copied from interface: DataPacker

Returns an empty wrapper to hold byteLength amount of type T

Specified by:

wrapperForByteLength in interface DataPacker<java.lang.Object,byte[]>

isHeaderRequired

public boolean isHeaderRequired()

Description copied from interface: DataPacker

Indicates whether length should be packed before the actual key

Specified by:

isHeaderRequired in interface DataPacker<java.lang.Object,byte[]>

unpackFromBuffer

public java.lang.Object unpackFromBuffer(java.nio.ByteBuffer byteBuffer,
                                         int bufferOffset,
                                         int byteLength)

Description copied from interface: DataPacker

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

Specified by:

unpackFromBuffer in interface DataPacker<java.lang.Object,byte[]>

Parameters:

byteBuffer - ByteBuffer instance

bufferOffset - position to start reading from buffer

byteLength - amount of data to read

unpackFromBuffer

public java.lang.Object unpackFromBuffer(java.nio.ByteBuffer byteBuffer,
                                         int byteLength)

Description copied from interface: DataPacker

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

Specified by:

unpackFromBuffer in interface DataPacker<java.lang.Object,byte[]>