net.lbruun.hexutils

Class HexDump

java.lang.Object

net.lbruun.hexutils.HexDump

public class HexDump
extends Object

Utilities for pretty printing a byte array, also known as "hex dumps". Often such dumps are printed in the debug mode of an application, for example when representing wire data.

Output look similar to the following example:

 0000 : BF A4 3B 16 1C 88 5C 56 11 78 41 62 72 61 63 61  |..;...\V.xAbraca|
 0016 : 64 61 62 72 61 1A 06 94 80 CA 1A 38 42 ED 58 25  |dabra......8B.X%|
 0032 : 92 03 AD BF 7F 60 F4 73 AD 55 B0 A9 5C C4 86 B4  |.....`.s.U..\...|
 0048 : 5B 11 62 55 B3 BD C4 EA C3 EA 4D 66 2A 02 1C 6C  |[.bU......Mf*..l|
 0064 : 0E 84 B1 F8 D8 05 91 51 CE A3 9E 46              |.......Q...F    |
 

The output can optionally be prefixed with space indention.

There are 3 sections in the output:

1. Byte counter. This section allows the human eye to quickly establish where in the byte array a value is located. The value is the position in the input byte array of the byte printed immediately after the colon character on the same line.
2. Hex representation separated by spaces.
3. Printable characters enclosed in '|'. This is a textual representation of the bytes where characters which are not not part of the ASCII-127 character set or a non-printable are represented by the dot character.

Parameters explanation:

• bytesPerLine. The number of bytes represented on each line of output. Typical values are 10 (produces output 50 characters wide less indention) and 16 (produces output 74 characters wide less indention). The example above use 16.
• indent. Number of space characters to prefix each line with. Indention is typically preferable in logging scenario because it allows a log file consumer to realize that the lines belong together a single log event.

Method Summary

Modifier and Type	Method and Description
static String[]	prettyPrint(byte[] input) Dump hex output and return result as a String array where each string represents a line of output.
static String[]	prettyPrint(byte[] input, Hex.HexCase caseType, int bytesPerLine, int indent) Dump hex output and return result as a String array where each string represents a line of output.
static void	prettyPrint(byte[] input, Hex.HexCase caseType, int bytesPerLine, int indent, PrintStream ps) Dump hex output and output into a PrintStream.
static void	prettyPrint(byte[] input, PrintStream ps) Dump hex output and output into a PrintStream.
static String	prettyPrintStr(byte[] input) Dump hex output and return result as a String.
static String	prettyPrintStr(byte[] input, Hex.HexCase caseType, int bytesPerLine, int indent) Dump hex output and return result as a String.
static String	prettyPrintStr(byte[] input, Hex.HexCase caseType, int bytesPerLine, int indent, String lineSeparator) Dump hex output and return result as a String.

Methods inherited from class java.lang.Object

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

Method Detail

prettyPrint

public static void prettyPrint(byte[] input,
                               Hex.HexCase caseType,
                               int bytesPerLine,
                               int indent,
                               PrintStream ps)

Dump hex output and output into a PrintStream. This is for example useful for printing the hex dump to System.out.

Parameters:

input - input bytes to be pretty printed

caseType - if the hexadecimal representation should be in upper or lower case

bytesPerLine - number of bytes to dump on each line of output (typically 10 or 16)

indent - number of space characters to prefix each line of output with

ps - where the output goes to

prettyPrint

public static void prettyPrint(byte[] input,
                               PrintStream ps)

Dump hex output and output into a PrintStream. This is for example useful for printing the hex dump to System.out.

This method use recommended defaults:

• caseType = UPPER
• bytesPerLine = 16
• indent = 4

Parameters:

input - input bytes to be pretty printed

ps - where the output goes to

See Also:

prettyPrint(byte[], net.lbruun.hexutils.Hex.HexCase, int, int, java.io.PrintStream)

prettyPrint

public static String[] prettyPrint(byte[] input,
                                   Hex.HexCase caseType,
                                   int bytesPerLine,
                                   int indent)

Dump hex output and return result as a String array where each string represents a line of output.

Parameters:

input - input bytes to be pretty printed

caseType - if the hexadecimal representation should be in upper or lower case

bytesPerLine - number of bytes to dump on each line of output (typically 10 or 16)

indent - number of space characters to prefix each line of output with

Returns:

lines of output

prettyPrint

public static String[] prettyPrint(byte[] input)

Dump hex output and return result as a String array where each string represents a line of output.

This method use recommended defaults:

• caseType = UPPER
• bytesPerLine = 16
• indent = 4

Parameters:

input - input bytes to be pretty printed

Returns:

lines of output

prettyPrintStr

public static String prettyPrintStr(byte[] input,
                                    Hex.HexCase caseType,
                                    int bytesPerLine,
                                    int indent,
                                    String lineSeparator)

Dump hex output and return result as a String.

Parameters:

input - input bytes to be pretty printed

caseType - if the hexadecimal representation should be in upper or lower case

bytesPerLine - number of bytes to dump on each line of output (typically 10 or 16)

indent - number of space characters to prefix each line of output with

lineSeparator - the string to use to separate lines

Returns:

lines of output

See Also:

prettyPrintStr(byte[], net.lbruun.hexutils.Hex.HexCase, int, int)

prettyPrintStr

public static String prettyPrintStr(byte[] input,
                                    Hex.HexCase caseType,
                                    int bytesPerLine,
                                    int indent)

Dump hex output and return result as a String. System.lineSeparator() is used to as line separator.

Parameters:

input - input bytes to be pretty printed

caseType - if the hexadecimal representation should be in upper or lower case

bytesPerLine - number of bytes to dump on each line of output (typically 10 or 16)

indent - number of space characters to prefix each line of output with

Returns:

lines of output

See Also:

prettyPrintStr(byte[], net.lbruun.hexutils.Hex.HexCase, int, int)

prettyPrintStr

public static String prettyPrintStr(byte[] input)

Dump hex output and return result as a String. System.lineSeparator() is used as line separator.

This method use recommended defaults:

• caseType = UPPER
• bytesPerLine = 16
• indent = 4
• lineSeparator = System.lineSeparator()

Parameters:

input - input bytes to be pretty printed

Returns:

lines of output

See Also:

prettyPrintStr(byte[], net.lbruun.hexutils.Hex.HexCase, int, int)