Class HexDump

java.lang.Object
org.apache.poi.util.HexDump

@Internal public class HexDump extends Object
dump data in hexadecimal format
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final Charset
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    byteToHex(int value)
     
    static String
    dump(byte[] data, long offset, int index)
    dump an array of bytes to a String
    static String
    dump(byte[] data, long offset, int index, int length)
    dump an array of bytes to a String
    static void
    dump(byte[] data, long offset, OutputStream stream, int index)
    dump an array of bytes to an OutputStream
    static void
    dump(byte[] data, long offset, OutputStream stream, int index, int length)
    dump an array of bytes to an OutputStream
    static void
    dump(InputStream in, PrintStream out, int start, int bytesToDump)
    Dumps bytesToDump bytes to an output stream.
    static String
    intToHex(int value)
     
    static String
    longToHex(long value)
     
    static void
    main(String[] args)
     
    static String
    shortToHex(int value)
     
    static char
    toAscii(int dataB)
     
    static String
    toHex(byte value)
    Converts the parameter to a hex value.
    static String
    toHex(byte[] value)
    Converts the parameter to a hex value.
    static String
    toHex(byte[] value, int bytesPerLine)
    Converts the parameter to a hex value breaking the results into lines.
    static String
    toHex(int value)
    Converts the parameter to a hex value.
    static String
    toHex(long value)
    Converts the parameter to a hex value.
    static String
    toHex(short value)
    Converts the parameter to a hex value.
    static String
    toHex(short[] value)
    Converts the parameter to a hex value.
    static String
    toHex(String value)
    Converts the string to a string of hex values.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • EOL

      public static final String EOL
    • UTF8

      public static final Charset UTF8
  • Method Details

    • dump

      public static void dump(byte[] data, long offset, OutputStream stream, int index, int length) throws IOException, ArrayIndexOutOfBoundsException, IllegalArgumentException
      dump an array of bytes to an OutputStream
      Parameters:
      data - the byte array to be dumped
      offset - its offset, whatever that might mean
      stream - the OutputStream to which the data is to be written
      index - initial index into the byte array
      length - number of characters to output
      Throws:
      IOException - is thrown if anything goes wrong writing the data to stream
      ArrayIndexOutOfBoundsException - if the index is outside the data array's bounds
      IllegalArgumentException - if the output stream is null
    • dump

      public static void dump(byte[] data, long offset, OutputStream stream, int index) throws IOException, ArrayIndexOutOfBoundsException, IllegalArgumentException
      dump an array of bytes to an OutputStream
      Parameters:
      data - the byte array to be dumped
      offset - its offset, whatever that might mean
      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
      IllegalArgumentException - if the output stream is null
    • dump

      public static String dump(byte[] data, long offset, int index)
      dump an array of bytes to a String
      Parameters:
      data - the byte array to be dumped
      offset - its offset, whatever that might mean
      index - initial index into the byte array
      Returns:
      output string
      Throws:
      ArrayIndexOutOfBoundsException - if the index is outside the data array's bounds
    • dump

      public static String dump(byte[] data, long offset, int index, int length)
      dump an array of bytes to a String
      Parameters:
      data - the byte array to be dumped
      offset - its offset, whatever that might mean
      index - initial index into the byte array
      length - number of characters to output
      Returns:
      output string
      Throws:
      ArrayIndexOutOfBoundsException - if the index is outside the data array's bounds
    • toAscii

      public static char toAscii(int dataB)
    • toHex

      public static String toHex(byte[] value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      A String representing the array of bytes
    • toHex

      public static String toHex(short[] value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      A String representing the array of shorts
    • toHex

      public static String toHex(byte[] value, int bytesPerLine)

      Converts the parameter to a hex value breaking the results into lines.

      Parameters:
      value - The value to convert
      bytesPerLine - The maximum number of bytes per line. The next byte will be written to a new line
      Returns:
      A String representing the array of bytes
    • toHex

      public static String toHex(short value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      The result right padded with 0
    • toHex

      public static String toHex(byte value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      The result right padded with 0
    • toHex

      public static String toHex(int value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      The result right padded with 0
    • toHex

      public static String toHex(long value)
      Converts the parameter to a hex value.
      Parameters:
      value - The value to convert
      Returns:
      The result right padded with 0
    • toHex

      public static String toHex(String value)
      Converts the string to a string of hex values.
      Parameters:
      value - The value to convert
      Returns:
      The resulted hex string
    • dump

      public static void dump(InputStream in, PrintStream out, int start, int bytesToDump) throws IOException
      Dumps bytesToDump bytes to an output stream.
      Parameters:
      in - The stream to read from
      out - The output stream
      start - The index to use as the starting position for the left hand side label
      bytesToDump - The number of bytes to output. Use -1 to read until the end of file.
      Throws:
      IOException
    • longToHex

      public static String longToHex(long value)
      Returns:
      string of 16 (zero padded) uppercase hex chars and prefixed with '0x'
    • intToHex

      public static String intToHex(int value)
      Returns:
      string of 8 (zero padded) uppercase hex chars and prefixed with '0x'
    • shortToHex

      public static String shortToHex(int value)
      Returns:
      string of 4 (zero padded) uppercase hex chars and prefixed with '0x'
    • byteToHex

      public static String byteToHex(int value)
      Returns:
      string of 2 (zero padded) uppercase hex chars and prefixed with '0x'
    • main

      public static void main(String[] args) throws IOException
      Throws:
      IOException