Field Detail

• EMPTY

  public static final byte[] EMPTY

  An empty byte array. This is the minimum value according to COMPARATOR.

• COMPARATOR

  public static final Comparator<byte[]> COMPARATOR

  Comparator that compares two byte arrays lexicographically using unsigned values.

• STRING_CONVERTER

  public static final Converter<byte[],String> STRING_CONVERTER

  A Converter that converts between byte[] arrays and hexadecimal Strings.

Method Detail

• compare

  public static int compare(byte[] b1,
            byte[] b2)

  Compare two byte arrays lexicographically using unsigned values.

  Parameters:

  b1 - first byte array

  b2 - second byte array

  Returns:

  -1 if b1 < b2, 1 if b1 > b2, or zero if b1 = b2

  Throws:

  NullPointerException - if b1 or b2 is null

• min

  public static byte[] min(byte[] b1,
           byte[] b2)

  Determine the smaller of two byte arrays when compared lexicographically using unsigned values.

  Parameters:

  b1 - first byte array

  b2 - second byte array

  Returns:

  b1 if b1 <= b2, otherwise b2

  Throws:

  NullPointerException - if b1 or b2 is null

• max

  public static byte[] max(byte[] b1,
           byte[] b2)

  Determine the larger of two byte arrays when compared lexicographically using unsigned values.

  Parameters:

  b1 - first byte array

  b2 - second byte array

  Returns:

  b1 if b1 >= b2, otherwise b2

  Throws:

  NullPointerException - if b1 or b2 is null

• isPrefixOf

  public static boolean isPrefixOf(byte[] prefix,
                   byte[] value)

  Determine if the first of two byte[] arrays is a prefix of the second.

  Parameters:

  prefix - prefix to check

  value - value to check for having prefix as a prefix

  Returns:

  true if prefix is a prefix of value

  Throws:

  NullPointerException - if prefix or value is null

• getNextKey

  public static byte[] getNextKey(byte[] key)

  Get the next key greater than the given key in unsigned lexicographic ordering. This creates a new key simply by appending a 0x00 byte to the data contained in the given key.

  Parameters:

  key - previous key

  Returns:

  next key after key

  Throws:

  NullPointerException - if key is null

• isConsecutive

  public static boolean isConsecutive(byte[] key1,
                      byte[] key2)

  Determine whether key2 is the next key after key1.

  Parameters:

  key1 - first key

  key2 - second key

  Returns:

  true if key2 immediately follows key1

  Throws:

  NullPointerException - if either parameter is null

• getKeyAfterPrefix

  public static byte[] getKeyAfterPrefix(byte[] prefix)

  Get the first key that would be greater than the given key in unsigned lexicographic ordering and that does not have the given key as a prefix.

  Parameters:

  prefix - lower bound prefix key

  Returns:

  next key not having prefix as a prefix

  Throws:

  IllegalArgumentException - if prefix has zero length

  IllegalArgumentException - if prefix contains only 0xff bytes

  NullPointerException - if prefix is null

• toString

  public static String toString(byte[] buf)

  Convert a byte array into a string of hex digits, or "null" if buf is null.

  Parameters:

  buf - bytes

  Returns:

  string encoding of buf

  See Also:

  parse()

• parse

  public static byte[] parse(String text)

  Decode a hexadecimal String into a byte[] array. The string must have an even number of digits and contain no other characters (e.g., whitespace).

  Parameters:

  text - string previously encoded by toString(byte[])

  Returns:

  byte[] decoding of text

  Throws:

  IllegalArgumentException - if any non-hexadecimal characters are found or the number of characters is odd

  NullPointerException - if text is null

  See Also:

  toString()

• readInt

  public static int readInt(ByteReader reader)

  Read an int as four big-endian bytes.

  Parameters:

  reader - input

  Returns:

  decoded integer

  Throws:

  IndexOutOfBoundsException - if less than four bytes remain in reader

  NullPointerException - if reader is null

  See Also:

  writeInt()

• writeInt

  public static void writeInt(ByteWriter writer,
              int value)

  Write an int as four big-endian bytes.

  Parameters:

  writer - byte destination

  value - value to write

  Throws:

  NullPointerException - if writer is null

  See Also:

  readInt()

• readLong

  public static long readLong(ByteReader reader)

  Read a long as eight big-endian bytes.

  Parameters:

  reader - input

  Returns:

  decoded long

  Throws:

  IndexOutOfBoundsException - if less than eight bytes remain in reader

  See Also:

  writeLong()

• writeLong

  public static void writeLong(ByteWriter writer,
               long value)

  Write a long as eight big-endian bytes.

  Parameters:

  writer - byte destination

  value - value to write

  Throws:

  NullPointerException - if writer is null

  See Also:

  readLong()