Package org.apache.commons.io

Class HexDump

  • public class HexDump
extends java.lang.Object
    Dumps data in hexadecimal format.

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

    Provenance: POI.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String EOL
      Deprecated.
      Use System.lineSeparator().

    • Constructor Summary

      Constructors 
      Constructor Description
      HexDump()
      Instances should NOT be constructed in standard programming.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void dump​(byte[] data, long offset, java.io.OutputStream stream, int index)
      Dumps an array of bytes to an OutputStream.
      static void dump​(byte[] data, long offset, java.lang.Appendable appendable, int index, int length)
      Dumps an array of bytes to an Appendable.
      static void dump​(byte[] data, java.lang.Appendable appendable)
      Dumps an array of bytes to an Appendable.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EOL

        @Deprecated
public static final java.lang.String EOL
        Deprecated.
        Use System.lineSeparator().
        The line-separator (initializes to "line.separator" system property).

    • Constructor Detail

      • HexDump

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

    • Method Detail

      • dump

        public static void dump​(byte[] data,
                        java.lang.Appendable appendable)
                 throws java.io.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:
        java.io.IOException - is thrown if anything goes wrong writing the data to appendable
        java.lang.NullPointerException - if the output appendable is null
        Since:
        2.12.0

      • dump

        public static void dump​(byte[] data,
                        long offset,
                        java.lang.Appendable appendable,
                        int index,
                        int length)
                 throws java.io.IOException,
                        java.lang.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:
        java.io.IOException - is thrown if anything goes wrong writing the data to appendable
        java.lang.ArrayIndexOutOfBoundsException - if the index or length is outside the data array's bounds
        java.lang.NullPointerException - if the output appendable is null
        Since:
        2.12.0

      • dump

        public static void dump​(byte[] data,
                        long offset,
                        java.io.OutputStream stream,
                        int index)
                 throws java.io.IOException,
                        java.lang.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:
        java.io.IOException - is thrown if anything goes wrong writing the data to stream
        java.lang.ArrayIndexOutOfBoundsException - if the index is outside the data array's bounds
        java.lang.NullPointerException - if the output stream is null