ByteArrayUtils (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.io.ByteArrayUtils

```
public class ByteArrayUtils
extends java.lang.Object
```
Utility methods for dealing with raw byte arrays. This is located in the I/O package, as the typical application for these methods is binary I/O on byte array level.

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 double`	`byteArrayToDouble(byte[] value)` Converts a byte array to a double value.
`static int`	`byteArrayToInt(byte[] bytes)` Converts a byte array to an integer value.
`static long`	`byteArrayToLong(byte[] bytes)` Converts a byte array to a long value.
`static java.util.OptionalInt`	`byteArrayToOptionalInt(byte[] bytes)` Converts a byte array to an optional int value, by mapping a null input array to empty.
`static java.util.OptionalLong`	`byteArrayToOptionalLong(byte[] bytes)` Converts a byte array to an optional long value, by mapping a null input array to empty.
`static byte[]`	`compress(byte[] value)` Compresses a single byte[] using GZIP.
`static byte[]`	`concat(byte[]... arrays)` Returns the concatenation of the given arrays.
`static byte[]`	`concat(java.lang.Iterable<byte[]> arrays)` Returns the concatenation of the given arrays.
`static byte[]`	`decompress(byte[] value)` Decompresses a single byte[] using GZIP.
`static byte[]`	`doubleToByteArray(double value)` Converts a double value to a byte array.
`static java.lang.String`	`hexDump(byte[] data)` Creates a hex dump of the provided bytes.
`static java.lang.String`	`hexDump(byte[] data, int width)` Creates a hex dump of the provided bytes.
`static int`	`indexOf(byte[] searchFor, byte[] searchIn, int startIndex)` Returns the first index in `searchIn` at or after the start index containing `searchFor` (or -1 if not found).
`static int`	`indexOf(byte[] searchFor, byte[] searchIn, int startIndex, int endIndex)` Returns the first index in `searchIn` at or after the start index containing `searchFor` (or -1 if not found).
`static byte[]`	`intToByteArray(int value)` Converts an integer value to a byte array.
`static boolean`	`isLess(byte[] a1, byte[] a2, boolean resultIfEqual)` Returns true if a1 is (lexicographically) less than a2.
`static boolean`	`isPrefix(byte[] prefix, byte[] key)` Returns whether the prefix is a prefix of the given key.
`static boolean`	`isPrefix(byte[] prefix, byte[] key, int startIndex)` Returns whether the `prefix` is a prefix of the given `key` when only looking at the part of `key` starting at `startIndex`.
`static byte[]`	`longToByteArray(long value)` Converts a long value to a byte array.
`static int`	`readIntFromStartOfArray(byte[] bytes)` Reads an int stored with `storeIntInStartOfArray(int, byte[])` from the first 4 bytes of the array.
`static java.util.List<byte[]>`	`split(byte[] bytes, byte[] separatorBytes)` Perform a split with no limit according to `split(byte[], byte[], int)`.
`static java.util.List<byte[]>`	`split(byte[] bytes, byte[] separatorBytes, int maxSplits)` Splits the byte array at the separator bytes given maximum split amount of times.
`static boolean`	`startsWithZipMagicBytes(byte[] data)` Returns whether the given bytes start with the magic bytes that mark a ZIP file.
`static void`	`storeIntInStartOfArray(int value, byte[] bytes)` Stores the given int at the first 4 bytes of the array.
`static int`	`unsignedByte(byte b)` Returns the unsigned byte interpretation of the parameter.
`static long`	`unsignedByteAsLong(byte b)` Returns the unsigned byte interpretation of the parameter as long.

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
  - intToByteArray
```
public static byte[] intToByteArray(int value)
```
    Converts an integer value to a byte array. The returned array has a length of Integer.BYTES.
  - storeIntInStartOfArray
```
public static void storeIntInStartOfArray(int value,
                                          byte[] bytes)
```
    Stores the given int at the first 4 bytes of the array.
  - doubleToByteArray
```
public static byte[] doubleToByteArray(double value)
```
    Converts a double value to a byte array. The returned array has a length of Double.BYTES
  - longToByteArray
```
public static byte[] longToByteArray(long value)
```
    Converts a long value to a byte array. The returned array has a length of Long.BYTES
  - byteArrayToInt
```
public static int byteArrayToInt(byte[] bytes)
```
    Converts a byte array to an integer value. Overall, this method is only guaranteed to work if the input array was created by intToByteArray(int).
  - byteArrayToOptionalInt
```
public static java.util.OptionalInt byteArrayToOptionalInt(byte[] bytes)
```
    Converts a byte array to an optional int value, by mapping a null input array to empty.
  - readIntFromStartOfArray
```
public static int readIntFromStartOfArray(byte[] bytes)
```
    Reads an int stored with storeIntInStartOfArray(int, byte[]) from the first 4 bytes of the array.
  - byteArrayToDouble
```
public static double byteArrayToDouble(byte[] value)
```
    Converts a byte array to a double value. Overall, this method is only guaranteed to work if the input array was created by doubleToByteArray(double).
  - byteArrayToLong
```
public static long byteArrayToLong(byte[] bytes)
```
    Converts a byte array to a long value. Overall, this method is only guaranteed to work if the input array was created by longToByteArray(long).
  - byteArrayToOptionalLong
```
public static java.util.OptionalLong byteArrayToOptionalLong(byte[] bytes)
```
    Converts a byte array to an optional long value, by mapping a null input array to empty.
  - decompress
```
public static byte[] decompress(byte[] value)
                         throws java.io.IOException
```
    Decompresses a single byte[] using GZIP. A null input array will cause this method to return null.
    
    Throws:
    
    java.io.IOException - if the input array is not valid GZIP compressed data (as created by compress(byte[])).
  - compress
```
public static byte[] compress(byte[] value)
```
    Compresses a single byte[] using GZIP. A null input array will cause this method to return null.
  - isPrefix
```
public static boolean isPrefix(byte[] prefix,
                               byte[] key)
```
    Returns whether the prefix is a prefix of the given key.
  - isPrefix
```
public static boolean isPrefix(byte[] prefix,
                               byte[] key,
                               int startIndex)
```
    Returns whether the prefix is a prefix of the given key when only looking at the part of key starting at startIndex.
  - isLess
```
public static boolean isLess(byte[] a1,
                             byte[] a2,
                             boolean resultIfEqual)
```
    Returns true if a1 is (lexicographically) less than a2.
  - unsignedByte
```
public static int unsignedByte(byte b)
```
    Returns the unsigned byte interpretation of the parameter.
  - unsignedByteAsLong
```
public static long unsignedByteAsLong(byte b)
```
    Returns the unsigned byte interpretation of the parameter as long.
  - concat
```
public static byte[] concat(byte[]... arrays)
```
    Returns the concatenation of the given arrays.
  - concat
```
public static byte[] concat(java.lang.Iterable<byte[]> arrays)
```
    Returns the concatenation of the given arrays.
  - hexDump
```
public static java.lang.String hexDump(byte[] data)
```
    Creates a hex dump of the provided bytes. This is similar to output from hexdump tools and primarily used for debugging. The output string will contain in each line 16 bytes of data first printed as hex numbers and then as a string interpretation. Each line is also prefixed with an offset.
  - hexDump
```
public static java.lang.String hexDump(byte[] data,
                                       int width)
```
    Creates a hex dump of the provided bytes. This is similar to output from hexdump tools and primarily used for debugging. The output string will contain in each line width bytes of data first printed as hex numbers and then as a string interpretation. Each line is also prefixed with an offset.
  - startsWithZipMagicBytes
```
public static boolean startsWithZipMagicBytes(byte[] data)
```
    Returns whether the given bytes start with the magic bytes that mark a ZIP file.
  - indexOf
```
public static int indexOf(byte[] searchFor,
                          byte[] searchIn,
                          int startIndex)
```
    Returns the first index in searchIn at or after the start index containing searchFor (or -1 if not found).
  - indexOf
```
public static int indexOf(byte[] searchFor,
                          byte[] searchIn,
                          int startIndex,
                          int endIndex)
```
    Returns the first index in searchIn at or after the start index containing searchFor (or -1 if not found). endIndex is the index of the first byte that is not considered in the match (exclusive).
  - split
```
public static java.util.List<byte[]> split(byte[] bytes,
                                           byte[] separatorBytes)
```
    Perform a split with no limit according to split(byte[], byte[], int).
  - split
```
public static java.util.List<byte[]> split(byte[] bytes,
                                           byte[] separatorBytes,
                                           int maxSplits)
```
    Splits the byte array at the separator bytes given maximum split amount of times. The result ArrayList is never longer than the maximum split.
    
    Parameters:
    
    bytes - The bytes to split. An empty list is returned if this is null.
    
    separatorBytes - Non null array of bytes to split at. Must have positive length.
    
    maxSplits - the maximum number of splits to perform starting at the beginning of the bytes array. An empty list is returned if this is 0 or negative.

Class ByteArrayUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteArrayUtils

Method Detail

intToByteArray

storeIntInStartOfArray

doubleToByteArray

longToByteArray

byteArrayToInt

byteArrayToOptionalInt

readIntFromStartOfArray

byteArrayToDouble

byteArrayToLong

byteArrayToOptionalLong

decompress

compress

isPrefix

isPrefix

isLess

unsignedByte

unsignedByteAsLong

concat

concat

hexDump

hexDump

startsWithZipMagicBytes

indexOf

indexOf

split

split