ByteArrayUtils (GeoWave Parent POM 1.2.0 API)

java.lang.Object
- org.locationtech.geowave.core.index.ByteArrayUtils

```
public class ByteArrayUtils
extends Object
```
Convenience methods for converting binary data to and from strings. The encoding and decoding is done in base-64. These methods should be used for converting data that is binary in nature to a String representation for transport. Use StringUtils for serializing and deserializing text-based data.
Additionally, this class has methods for manipulating byte arrays, such as combining or incrementing them.

Constructor Summary

Constructors
Constructor and Description

ByteArrayUtils()

Constructors
Constructor and Description
`ByteArrayUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addAllIntermediaryByteArrays(List<byte[]> retVal, ByteArrayRange range)`
`static byte[]`	`byteArrayFromString(String str)` Convert a string representation of binary data back to a String
`static long`	`byteArrayToLong(byte[] bytes)` Converts a byte array to a long
`static short`	`byteArrayToShort(byte[] bytes)`
`static String`	`byteArrayToString(byte[] byteArray)` Convert binary data to a string for transport
`static byte[]`	`combineArrays(byte[] id1, byte[] id2)` Combine 2 arrays into one large array.
`static byte[]`	`combineVariableLengthArrays(byte[] array1, byte[] array2)` Combines two variable length byte arrays into one large byte array and appends the length of each individual byte array in sequential order at the end of the combined byte array.
`static int`	`compare(byte[] array1, byte[] array2)`
`static String`	`getHexString(byte[] bytes)`
`static byte[]`	`getNextPrefix(byte[] rowKeyPrefix)`
`static byte[]`	`getPreviousPrefix(byte[] rowKeyPrefix)`
`static ByteArrayRange`	`getSingleRange(List<ByteArrayRange> ranges)`
`static boolean`	`increment(byte[] value)` add 1 to the least significant bit in this byte array (the last byte in the array)
`static byte[]`	`longToByteArray(long l)` Converts a long to a byte array
`static byte[]`	`safeRead(ByteBuffer buffer, int length)` Read bytes from the buffer, but only if the buffer's remaining length supports it.
`static short`	`shortFromString(String input)`
`static byte[]`	`shortToByteArray(short input)`
`static String`	`shortToString(short input)`
`static org.apache.commons.lang3.tuple.Pair<byte[],byte[]>`	`splitVariableLengthArrays(byte[] combinedArray)`
`static boolean`	`startsWith(byte[] bytes, byte[] prefix)`
`static byte[]`	`uuidToByteArray(UUID uuid)` Converts a UUID to a byte array
`static long`	`variableLengthDecode(byte[] b)`
`static byte[]`	`variableLengthEncode(long n)`
`static void`	`verifyBufferSize(ByteBuffer buffer, int length)` Throw an exception if the requested length is longer than the remaining buffer size.

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

- Constructor Detail
  - ByteArrayUtils
```
public ByteArrayUtils()
```
- Method Detail
  - byteArrayToString
```
public static String byteArrayToString(byte[] byteArray)
```
    Convert binary data to a string for transport
    
    Parameters:
    
    byteArray - the binary data
    
    Returns:
    
    the base64url encoded string
  - byteArrayFromString
```
public static byte[] byteArrayFromString(String str)
```
    Convert a string representation of binary data back to a String
    
    Parameters:
    
    str - the string representation of binary data
    
    Returns:
    
    the base64url decoded binary data
  - verifyBufferSize
```
public static void verifyBufferSize(ByteBuffer buffer,
                                    int length)
```
    Throw an exception if the requested length is longer than the remaining buffer size.
    
    Parameters:
    
    buffer - the byte buffer
    
    length - the number of bytes to read
  - safeRead
```
public static byte[] safeRead(ByteBuffer buffer,
                              int length)
```
    Read bytes from the buffer, but only if the buffer's remaining length supports it.
    
    Parameters:
    
    buffer - the byte buffer
    
    length - the number of bytes to read
    
    Returns:
    
    the bytes that were read
  - combineArrays
```
public static byte[] combineArrays(byte[] id1,
                                   byte[] id2)
```
    Combine 2 arrays into one large array. If both are not null it will append id2 to id1 and the result will be of length id1.length + id2.length
    
    Parameters:
    
    id1 - the first byte array to use (the start of the result)
    
    id2 - the second byte array to combine (appended to id1)
    
    Returns:
    
    the concatenated byte array
  - increment
```
public static boolean increment(byte[] value)
```
    add 1 to the least significant bit in this byte array (the last byte in the array)
    
    Parameters:
    
    value - the array to increment
    
    Returns:
    
    will return true as long as the value did not overflow
  - uuidToByteArray
```
public static byte[] uuidToByteArray(UUID uuid)
```
    Converts a UUID to a byte array
    
    Parameters:
    
    uuid - the uuid
    
    Returns:
    
    the byte array representing that UUID
  - longToByteArray
```
public static byte[] longToByteArray(long l)
```
    Converts a long to a byte array
    
    Parameters:
    
    l - the long
    
    Returns:
    
    the byte array representing that long
  - byteArrayToLong
```
public static long byteArrayToLong(byte[] bytes)
```
    Converts a byte array to a long
    
    Parameters:
    
    bytes - the byte array the long
    
    Returns:
    
    the long represented by the byte array
  - combineVariableLengthArrays
```
public static byte[] combineVariableLengthArrays(byte[] array1,
                                                 byte[] array2)
```
    Combines two variable length byte arrays into one large byte array and appends the length of each individual byte array in sequential order at the end of the combined byte array.
    Given byte_array_1 of length 8 + byte_array_2 of length 16, the result will be byte_array1 + byte_array_2 + 8 + 16.
    Lengths are put after the individual arrays so they don't impact sorting when used within the key of a sorted key-value data store.
    
    Parameters:
    
    array1 - the first byte array
    
    array2 - the second byte array
    
    Returns:
    
    the combined byte array including the individual byte array lengths
  - splitVariableLengthArrays
```
public static org.apache.commons.lang3.tuple.Pair<byte[],byte[]> splitVariableLengthArrays(byte[] combinedArray)
```
  - shortToString
```
public static String shortToString(short input)
```
  - shortFromString
```
public static short shortFromString(String input)
```
  - shortToByteArray
```
public static byte[] shortToByteArray(short input)
```
  - byteArrayToShort
```
public static short byteArrayToShort(byte[] bytes)
```
  - variableLengthEncode
```
public static byte[] variableLengthEncode(long n)
```
  - variableLengthDecode
```
public static long variableLengthDecode(byte[] b)
```
  - getNextPrefix
```
public static byte[] getNextPrefix(byte[] rowKeyPrefix)
```
  - getPreviousPrefix
```
public static byte[] getPreviousPrefix(byte[] rowKeyPrefix)
```
  - compare
```
public static int compare(byte[] array1,
                          byte[] array2)
```
  - startsWith
```
public static boolean startsWith(byte[] bytes,
                                 byte[] prefix)
```
  - getHexString
```
public static String getHexString(byte[] bytes)
```
  - getSingleRange
```
public static ByteArrayRange getSingleRange(List<ByteArrayRange> ranges)
```
  - addAllIntermediaryByteArrays
```
public static void addAllIntermediaryByteArrays(List<byte[]> retVal,
                                                ByteArrayRange range)
```

Class ByteArrayUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteArrayUtils

Method Detail

byteArrayToString

byteArrayFromString

verifyBufferSize

safeRead

combineArrays

increment

uuidToByteArray

longToByteArray

byteArrayToLong

combineVariableLengthArrays

splitVariableLengthArrays

shortToString

shortFromString

shortToByteArray

byteArrayToShort

variableLengthEncode

variableLengthDecode

getNextPrefix

getPreviousPrefix

compare

startsWith

getHexString

getSingleRange

addAllIntermediaryByteArrays