CodecUtil (Simple Binary Encoding)

java.lang.Object
- uk.co.real_logic.sbe.codec.java.CodecUtil

```
public class CodecUtil
extends Object
```

Constructor Summary

Constructors
Constructor and Description

CodecUtil()

Constructors
Constructor and Description
`CodecUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte`	`charGet(DirectBuffer buffer, int index)` Get a char from a `DirectBuffer` at a given index.
`static void`	`charPut(DirectBuffer buffer, int index, byte value)` Put a character to a `DirectBuffer` at the given index.
`static void`	`charsGet(DirectBuffer buffer, int index, byte[] dst, int offset, int length)` Get from a `DirectBuffer` at a given index into an array.
`static void`	`charsPut(DirectBuffer buffer, int index, byte[] src, int offset, int length)` Put an array into a `DirectBuffer` at the given index.
`static double`	`doubleGet(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a 64-bit double from a `DirectBuffer` at a given index.
`static void`	`doublePut(DirectBuffer buffer, int index, double value, ByteOrder byteOrder)` Put a double to a `DirectBuffer` at the given index.
`static float`	`floatGet(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a 32-bit float from a `DirectBuffer` at a given index.
`static void`	`floatPut(DirectBuffer buffer, int index, float value, ByteOrder byteOrder)` Put a float to a `DirectBuffer` at the given index.
`static short`	`int16Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a 16-bit integer from a `DirectBuffer` at a given index.
`static void`	`int16Put(DirectBuffer buffer, int index, short value, ByteOrder byteOrder)` Put a 16-bit integer to a `DirectBuffer` at the given index.
`static int`	`int32Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a 32-bit integer from a `DirectBuffer` at a given index.
`static void`	`int32Put(DirectBuffer buffer, int index, int value, ByteOrder byteOrder)` Put a 32-bit integer to a `DirectBuffer` at the given index.
`static long`	`int64Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a 64-bit integer from a `DirectBuffer` at a given index.
`static void`	`int64Put(DirectBuffer buffer, int index, long value, ByteOrder byteOrder)` Put a 64-bit integer to a `DirectBuffer` at the given index.
`static byte`	`int8Get(DirectBuffer buffer, int index)` Get a 8-bit integer from a `DirectBuffer` at a given index.
`static void`	`int8Put(DirectBuffer buffer, int index, byte value)` Put a 8-bit integer to a `DirectBuffer` at the given index.
`static void`	`int8sGet(DirectBuffer buffer, int index, byte[] dst, int offset, int length)` Get from a `DirectBuffer` at a given index into an array.
`static void`	`int8sPut(DirectBuffer buffer, int index, byte[] src, int offset, int length)` Put an array into a `DirectBuffer` at the given index.
`static int`	`uint16Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a unsigned 16-bit integer from a `DirectBuffer` at a given index.
`static boolean`	`uint16GetChoice(DirectBuffer buffer, int index, int bitIndex, ByteOrder byteOrder)` Is a bit set at a given index.
`static void`	`uint16Put(DirectBuffer buffer, int index, int value, ByteOrder byteOrder)` Put a 16-bit signed integer to a `DirectBuffer` at the given index.
`static void`	`uint16PutChoice(DirectBuffer buffer, int index, int bitIndex, boolean switchOn, ByteOrder byteOrder)` Set a bit on or off at a given index.
`static long`	`uint32Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a unsigned 32-bit integer from a `DirectBuffer` at a given index.
`static boolean`	`uint32GetChoice(DirectBuffer buffer, int index, int bitIndex, ByteOrder byteOrder)` Is a bit set at a given index.
`static void`	`uint32Put(DirectBuffer buffer, int index, long value, ByteOrder byteOrder)` Put a 32-bit signed integer to a `DirectBuffer` at the given index.
`static void`	`uint32PutChoice(DirectBuffer buffer, int index, int bitIndex, boolean switchOn, ByteOrder byteOrder)` Set a bit on or off at a given index.
`static long`	`uint64Get(DirectBuffer buffer, int index, ByteOrder byteOrder)` Get a unsigned 64-bit integer from a `DirectBuffer` at a given index.
`static boolean`	`uint64GetChoice(DirectBuffer buffer, int index, int bitIndex, ByteOrder byteOrder)` Is a bit set at a given index.
`static void`	`uint64Put(DirectBuffer buffer, int index, long value, ByteOrder byteOrder)` Put a 64-bit signed integer to a `DirectBuffer` at the given index.
`static void`	`uint64PutChoice(DirectBuffer buffer, int index, int bitIndex, boolean switchOn, ByteOrder byteOrder)` Set a bit on or off at a given index.
`static short`	`uint8Get(DirectBuffer buffer, int index)` Get a unsigned 8-bit integer from a `DirectBuffer` at a given index.
`static boolean`	`uint8GetChoice(DirectBuffer buffer, int index, int bitIndex)` Is a bit set at a given index.
`static void`	`uint8Put(DirectBuffer buffer, int index, short value)` Put a 8-bit signed integer to a `DirectBuffer` at the given index.
`static void`	`uint8PutChoice(DirectBuffer buffer, int index, int bitIndex, boolean switchOn)` Set a bit on or off at a given index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CodecUtil
```
public CodecUtil()
```
- Method Detail
  - charPut
```
public static void charPut(DirectBuffer buffer,
                           int index,
                           byte value)
```
    Put a character to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
  - charsPut
```
public static void charsPut(DirectBuffer buffer,
                            int index,
                            byte[] src,
                            int offset,
                            int length)
```
    Put an array into a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    src - to be be written
    
    offset - in the src buffer to write from
    
    length - of the src buffer to copy.
  - int8Put
```
public static void int8Put(DirectBuffer buffer,
                           int index,
                           byte value)
```
    Put a 8-bit integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
  - int8sPut
```
public static void int8sPut(DirectBuffer buffer,
                            int index,
                            byte[] src,
                            int offset,
                            int length)
```
    Put an array into a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    src - to be be written
    
    offset - in the src buffer to write from
    
    length - of the src buffer to copy.
  - int16Put
```
public static void int16Put(DirectBuffer buffer,
                            int index,
                            short value,
                            ByteOrder byteOrder)
```
    Put a 16-bit integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - int32Put
```
public static void int32Put(DirectBuffer buffer,
                            int index,
                            int value,
                            ByteOrder byteOrder)
```
    Put a 32-bit integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - int64Put
```
public static void int64Put(DirectBuffer buffer,
                            int index,
                            long value,
                            ByteOrder byteOrder)
```
    Put a 64-bit integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - uint8Put
```
public static void uint8Put(DirectBuffer buffer,
                            int index,
                            short value)
```
    Put a 8-bit signed integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    Throws:
    
    IllegalArgumentException - if the number is negative
  - uint16Put
```
public static void uint16Put(DirectBuffer buffer,
                             int index,
                             int value,
                             ByteOrder byteOrder)
```
    Put a 16-bit signed integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - uint32Put
```
public static void uint32Put(DirectBuffer buffer,
                             int index,
                             long value,
                             ByteOrder byteOrder)
```
    Put a 32-bit signed integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - uint64Put
```
public static void uint64Put(DirectBuffer buffer,
                             int index,
                             long value,
                             ByteOrder byteOrder)
```
    Put a 64-bit signed integer to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - floatPut
```
public static void floatPut(DirectBuffer buffer,
                            int index,
                            float value,
                            ByteOrder byteOrder)
```
    Put a float to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - doublePut
```
public static void doublePut(DirectBuffer buffer,
                             int index,
                             double value,
                             ByteOrder byteOrder)
```
    Put a double to a DirectBuffer at the given index.
    
    Parameters:
    
    buffer - to which the value should be written.
    
    index - from which to begin writing.
    
    value - to be be written.
    
    byteOrder - for the buffer encoding
  - charGet
```
public static byte charGet(DirectBuffer buffer,
                           int index)
```
    Get a char from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    Returns:
    
    the byte representation of the value
  - charsGet
```
public static void charsGet(DirectBuffer buffer,
                            int index,
                            byte[] dst,
                            int offset,
                            int length)
```
    Get from a DirectBuffer at a given index into an array.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    dst - into which the copy will occur
    
    offset - at which to start in the destination
    
    length - of the array to copy
  - int8Get
```
public static byte int8Get(DirectBuffer buffer,
                           int index)
```
    Get a 8-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    Returns:
    
    the byte representation of the value
  - int8sGet
```
public static void int8sGet(DirectBuffer buffer,
                            int index,
                            byte[] dst,
                            int offset,
                            int length)
```
    Get from a DirectBuffer at a given index into an array.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    dst - into which the copy will occur
    
    offset - at which to start in the destination
    
    length - of the array to copy
  - int16Get
```
public static short int16Get(DirectBuffer buffer,
                             int index,
                             ByteOrder byteOrder)
```
    Get a 16-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the short representation of the value
  - int32Get
```
public static int int32Get(DirectBuffer buffer,
                           int index,
                           ByteOrder byteOrder)
```
    Get a 32-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the int representation of the value
  - int64Get
```
public static long int64Get(DirectBuffer buffer,
                            int index,
                            ByteOrder byteOrder)
```
    Get a 64-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the long representation of the value
  - uint8Get
```
public static short uint8Get(DirectBuffer buffer,
                             int index)
```
    Get a unsigned 8-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    Returns:
    
    the short representation of the value
  - uint16Get
```
public static int uint16Get(DirectBuffer buffer,
                            int index,
                            ByteOrder byteOrder)
```
    Get a unsigned 16-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the int representation of the value
  - uint32Get
```
public static long uint32Get(DirectBuffer buffer,
                             int index,
                             ByteOrder byteOrder)
```
    Get a unsigned 32-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the long representation of the value
  - uint64Get
```
public static long uint64Get(DirectBuffer buffer,
                             int index,
                             ByteOrder byteOrder)
```
    Get a unsigned 64-bit integer from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the long representation of the value
  - floatGet
```
public static float floatGet(DirectBuffer buffer,
                             int index,
                             ByteOrder byteOrder)
```
    Get a 32-bit float from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the float representation of the value
  - doubleGet
```
public static double doubleGet(DirectBuffer buffer,
                               int index,
                               ByteOrder byteOrder)
```
    Get a 64-bit double from a DirectBuffer at a given index.
    
    Parameters:
    
    buffer - from which the value should be read.
    
    index - from which to begin reading.
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    the double representation of the value
  - uint8GetChoice
```
public static boolean uint8GetChoice(DirectBuffer buffer,
                                     int index,
                                     int bitIndex)
```
    Is a bit set at a given index.
    
    Parameters:
    
    buffer - to read from.
    
    index - of the beginning byte
    
    bitIndex - bit index to read
    
    Returns:
    
    true if the bit is set otherwise false.
  - uint8PutChoice
```
public static void uint8PutChoice(DirectBuffer buffer,
                                  int index,
                                  int bitIndex,
                                  boolean switchOn)
```
    Set a bit on or off at a given index.
    
    Parameters:
    
    buffer - to write the bit too.
    
    index - of the beginning byte.
    
    bitIndex - bit index to set.
    
    switchOn - true sets bit to 1 and false sets it to 0.
  - uint16GetChoice
```
public static boolean uint16GetChoice(DirectBuffer buffer,
                                      int index,
                                      int bitIndex,
                                      ByteOrder byteOrder)
```
    Is a bit set at a given index.
    
    Parameters:
    
    buffer - to read from.
    
    index - of the beginning byte
    
    bitIndex - bit index to read
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    true if the bit is set otherwise false.
  - uint16PutChoice
```
public static void uint16PutChoice(DirectBuffer buffer,
                                   int index,
                                   int bitIndex,
                                   boolean switchOn,
                                   ByteOrder byteOrder)
```
    Set a bit on or off at a given index.
    
    Parameters:
    
    buffer - to write the bit too.
    
    index - of the beginning byte.
    
    bitIndex - bit index to set.
    
    switchOn - true sets bit to 1 and false sets it to 0.
    
    byteOrder - for the buffer encoding
  - uint32GetChoice
```
public static boolean uint32GetChoice(DirectBuffer buffer,
                                      int index,
                                      int bitIndex,
                                      ByteOrder byteOrder)
```
    Is a bit set at a given index.
    
    Parameters:
    
    buffer - to read from.
    
    index - of the beginning byte
    
    bitIndex - bit index to read
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    true if the bit is set otherwise false.
  - uint32PutChoice
```
public static void uint32PutChoice(DirectBuffer buffer,
                                   int index,
                                   int bitIndex,
                                   boolean switchOn,
                                   ByteOrder byteOrder)
```
    Set a bit on or off at a given index.
    
    Parameters:
    
    buffer - to write the bit too.
    
    index - of the beginning byte.
    
    bitIndex - bit index to set.
    
    switchOn - true sets bit to 1 and false sets it to 0.
    
    byteOrder - for the buffer encoding
  - uint64GetChoice
```
public static boolean uint64GetChoice(DirectBuffer buffer,
                                      int index,
                                      int bitIndex,
                                      ByteOrder byteOrder)
```
    Is a bit set at a given index.
    
    Parameters:
    
    buffer - to read from.
    
    index - of the beginning byte
    
    bitIndex - bit index to read
    
    byteOrder - for the buffer encoding
    
    Returns:
    
    true if the bit is set otherwise false.
  - uint64PutChoice
```
public static void uint64PutChoice(DirectBuffer buffer,
                                   int index,
                                   int bitIndex,
                                   boolean switchOn,
                                   ByteOrder byteOrder)
```
    Set a bit on or off at a given index.
    
    Parameters:
    
    buffer - to write the bit too.
    
    index - of the beginning byte.
    
    bitIndex - bit index to set.
    
    switchOn - true sets bit to 1 and false sets it to 0.
    
    byteOrder - for the buffer encoding

Class CodecUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodecUtil

Method Detail

charPut

charsPut

int8Put

int8sPut

int16Put

int32Put

int64Put

uint8Put

uint16Put

uint32Put

uint64Put

floatPut

doublePut

charGet

charsGet

int8Get

int8sGet

int16Get

int32Get

int64Get

uint8Get

uint16Get

uint32Get

uint64Get

floatGet

doubleGet

uint8GetChoice

uint8PutChoice

uint16GetChoice

uint16PutChoice

uint32GetChoice

uint32PutChoice

uint64GetChoice

uint64PutChoice