PrimitiveArrayPacker

All Superinterfaces:

DataPacker<A,A>

All Known Implementing Classes:

ByteArrayPacker, CharArrayPacker, DoubleArrayPacker, FloatArrayPacker, IntegerArrayPacker, LongArrayPacker, ShortArrayPacker
```
public interface PrimitiveArrayPacker<A>
extends DataPacker<A,A>
```

Method Summary

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

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

- Method Detail
  - getMessageType
```
MessageType<A,A> getMessageType()
```
  - addToBuffer
```
java.nio.ByteBuffer addToBuffer(java.nio.ByteBuffer byteBuffer,
                                A data,
                                int index)
```
    Adds data[index] to the byteBuffer, position will be updated
  - addToBuffer
```
java.nio.ByteBuffer addToBuffer(java.nio.ByteBuffer byteBuffer,
                                int offset,
                                A data,
                                int index)
```
    Adds data[index] to the byteBuffer, position will not be updated
  - readFromBufferAndSet
```
void readFromBufferAndSet(java.nio.ByteBuffer byteBuffer,
                          int offset,
                          A array,
                          int index)
```
    Read data from buffer and set to the array. Buffer position shouldn't be affected
    
    Parameters:
    
    byteBuffer - ByteBuffer instance
    
    offset - offset of byteBuffer
    
    array - destination array
    
    index - index of array to update
  - readFromBufferAndSet
```
void readFromBufferAndSet(java.nio.ByteBuffer byteBuffer,
                          A array,
                          int index)
```
    Read data from buffer and set to the array. Buffer position should be updated.
    
    Parameters:
    
    byteBuffer - ByteBuffer instance
    
    array - destination array
    
    index - index of array to update
  - wrapperForLength
```
A wrapperForLength(int length)
```
  - wrapperForByteLength
```
default A 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<A,A>
  - determineLength
```
default int determineLength(A 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<A,A>
    
    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
  - bulkCopyToBuffer
```
default boolean bulkCopyToBuffer(A src,
                                 java.nio.ByteBuffer buffer,
                                 int offset,
                                 int length)
```
  - writeDataToBuffer
```
default void writeDataToBuffer(A 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<A,A>
  - bulkReadFromBuffer
```
default boolean bulkReadFromBuffer(java.nio.ByteBuffer buffer,
                                   A dest,
                                   int offset,
                                   int length)
```
  - readDataFromBuffer
```
default 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<A,A>
  - packToByteArray
```
default byte[] packToByteArray(A data)
```
    Specified by:
    
    packToByteArray in interface DataPacker<A,A>
  - packToByteBuffer
```
default java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                             A 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<A,A>
  - packToByteBuffer
```
default java.nio.ByteBuffer packToByteBuffer(java.nio.ByteBuffer byteBuffer,
                                             int offset,
                                             A 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<A,A>
  - isHeaderRequired
```
default boolean isHeaderRequired()
```
    Description copied from interface: DataPacker
    
    Indicates whether length should be packed before the actual key
    
    Specified by:
    
    isHeaderRequired in interface DataPacker<A,A>
  - unpackFromBuffer
```
default A 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<A,A>
    
    Parameters:
    
    byteBuffer - ByteBuffer instance
    
    bufferOffset - position to start reading from buffer
    
    byteLength - amount of data to read
  - unpackFromBuffer
```
default A 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<A,A>

Interface PrimitiveArrayPacker<A>

Method Summary

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

Method Detail

getMessageType

addToBuffer

addToBuffer

readFromBufferAndSet

readFromBufferAndSet

wrapperForLength

wrapperForByteLength

determineLength

bulkCopyToBuffer

writeDataToBuffer

bulkReadFromBuffer

readDataFromBuffer

packToByteArray

packToByteBuffer

packToByteBuffer

isHeaderRequired

unpackFromBuffer

unpackFromBuffer