Module org.tquadrat.foundation.util
Package org.tquadrat.foundation.util

Class HexUtils

java.lang.Object
org.tquadrat.foundation.util.HexUtils
@ClassVersion(sourceVersion="$Id: HexUtils.java 1086 2024-01-05 23:18:33Z tquadrat $") @UtilityClass public final class HexUtils extends Object

A set of utility methods that are useful for the conversion of byte arrays to and from strings of hexadecimal digits.

Parts of the code were adopted from the class org.apache.catalina.util.HexUtils (written by Craig R. McClanahan) out of the Tomcat source and modified to match the requirements of this project.

Partially, the methods got obsolete with the introduction of HexFormat in Java 17.

Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Thanks to:
Craig R. McClanahan
Version:
$Id: HexUtils.java 1086 2024-01-05 23:18:33Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.util.HexUtils"⁠

UML Diagram for "org.tquadrat.foundation.util.HexUtils"

UML Diagram for "org.tquadrat.foundation.util.HexUtils"⁠

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    HexUtils()
    No instance of this class is allowed.

  • Method Summary

    Modifier and Type
    Method
    Description
    static final byte[]
    convertFromHexCharArray(char[] digits)
    Converts an array of hexadecimal digits into the corresponding byte array by encoding each two hexadecimal digits as a byte.
    static byte[]
    convertFromHexString(CharSequence digits)
    Converts a String of hexadecimal digits into the corresponding byte array by encoding each two hexadecimal digits as a byte.
    static final char
    convertToHexDigit(int value)
    Converts an integer in the range form 0 to 15 to a hex digit.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • HexUtils

      private HexUtils()
      No instance of this class is allowed.

  • Method Details

    • convertFromHexString

      @API(status=STABLE, since="0.0.5") public static byte[] convertFromHexString(CharSequence digits)

      Converts a String of hexadecimal digits into the corresponding byte array by encoding each two hexadecimal digits as a byte. The method will not distinguish between upper or lower case for the digit from 0xA to 0xF.

      If the number of digits in the String is odd, the String will be prefixed by an additional 0.

      Parameters:
      digits - Hexadecimal digits representation.
      Returns:
      The resulting byte array.
      Throws:
      IllegalArgumentException - The input String is null, empty, or it contains an invalid character that cannot be interpreted as a hexadecimal digit.

    • convertFromHexCharArray

      @API(status=STABLE, since="0.0.5") public static final byte[] convertFromHexCharArray(char[] digits)
      Converts an array of hexadecimal digits into the corresponding byte array by encoding each two hexadecimal digits as a byte. The method will not distinguish between upper or lower case for the digit from 0xA to 0xF.

      If the number of digits in the array is odd, an additional 0 will prepended to it.
      Parameters:
      digits - Hexadecimal digits representation.
      Returns:
      The resulting byte array.
      Throws:
      IllegalArgumentException - The input array is null, empty, or it contains an invalid character that cannot be interpreted as a hexadecimal digit.

    • convertToHexDigit

      @API(status=STABLE, since="0.0.5") public static final char convertToHexDigit(int value)
      Converts an integer in the range form 0 to 15 to a hex digit.
      Parameters:
      value - The value to convert.
      Returns:
      The hex digit (uppercase).