Class HexDump

java.lang.Object
org.apache.commons.io.HexDump

public class HexDump extends Object
Dumps data in hexadecimal format.

Provides a single function to take an array of bytes and display it in hexadecimal form.

Origin of code: POI.

  • Field Details

    • EOL

      @Deprecated public static final String EOL
      Deprecated.
      The line-separator (initializes to "line.separator" system property).
    • HEX_CODES

      private static final char[] HEX_CODES
    • SHIFTS

      private static final int[] SHIFTS
  • Constructor Details

    • HexDump

      public HexDump()
      Instances should NOT be constructed in standard programming.
  • Method Details

    • dump

      public static void dump(byte[] data, Appendable appendable) throws IOException
      Dumps an array of bytes to an Appendable. The output is formatted for human inspection, with a hexadecimal offset followed by the hexadecimal values of the next 16 bytes of data and the printable ASCII characters (if any) that those bytes represent printed per each line of output.
      Parameters:
      data - the byte array to be dumped
      appendable - the Appendable to which the data is to be written
      Throws:
      IOException - is thrown if anything goes wrong writing the data to appendable
      NullPointerException - if the output appendable is null
      Since:
      2.12.0
    • dump

      public static void dump(byte[] data, long offset, Appendable appendable, int index, int length) throws IOException, ArrayIndexOutOfBoundsException
      Dumps an array of bytes to an Appendable. The output is formatted for human inspection, with a hexadecimal offset followed by the hexadecimal values of the next 16 bytes of data and the printable ASCII characters (if any) that those bytes represent printed per each line of output.

      The offset argument specifies the start offset of the data array within a larger entity like a file or an incoming stream. For example, if the data array contains the third kibibyte of a file, then the offset argument should be set to 2048. The offset value printed at the beginning of each line indicates where in that larger entity the first byte on that line is located.

      Parameters:
      data - the byte array to be dumped
      offset - offset of the byte array within a larger entity
      appendable - the Appendable to which the data is to be written
      index - initial index into the byte array
      length - number of bytes to dump from the array
      Throws:
      IOException - is thrown if anything goes wrong writing the data to appendable
      ArrayIndexOutOfBoundsException - if the index or length is outside the data array's bounds
      NullPointerException - if the output appendable is null
      Since:
      2.12.0
    • dump

      public static void dump(byte[] data, long offset, OutputStream stream, int index) throws IOException, ArrayIndexOutOfBoundsException
      Dumps an array of bytes to an OutputStream. The output is formatted for human inspection, with a hexadecimal offset followed by the hexadecimal values of the next 16 bytes of data and the printable ASCII characters (if any) that those bytes represent printed per each line of output.

      The offset argument specifies the start offset of the data array within a larger entity like a file or an incoming stream. For example, if the data array contains the third kibibyte of a file, then the offset argument should be set to 2048. The offset value printed at the beginning of each line indicates where in that larger entity the first byte on that line is located.

      All bytes between the given index (inclusive) and the end of the data array are dumped.

      Parameters:
      data - the byte array to be dumped
      offset - offset of the byte array within a larger entity
      stream - the OutputStream to which the data is to be written
      index - initial index into the byte array
      Throws:
      IOException - is thrown if anything goes wrong writing the data to stream
      ArrayIndexOutOfBoundsException - if the index is outside the data array's bounds
      NullPointerException - if the output stream is null
    • dump

      private static StringBuilder dump(StringBuilder _cbuffer, byte value)
      Dumps a byte value into a StringBuilder.
      Parameters:
      _cbuffer - the StringBuilder to dump the value in
      value - the byte value to be dumped
      Returns:
      StringBuilder containing the dumped value.
    • dump

      private static StringBuilder dump(StringBuilder _lbuffer, long value)
      Dumps a long value into a StringBuilder.
      Parameters:
      _lbuffer - the StringBuilder to dump the value in
      value - the long value to be dumped
      Returns:
      StringBuilder containing the dumped value.