net.sf.kdgcommons.io

Class HexDumpOutputStream

java.lang.Object

java.io.OutputStream

net.sf.kdgcommons.io.HexDumpOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class HexDumpOutputStream
extends OutputStream

An OutputStream that logs all writes to a specified Writer, in a hexdump format. Each write operation creates one or more lines of output, formatted as below:

• 8 hex digits showing offset, followed by 2 spaces
• up to 16 two-character hex values, separated by spaces
• padding that brings the hex characters to 48 columns, followed by 4 spaces, followed by up to 16 characters, with non-printing characters replaced by a specified character

Constructor Summary

Constructors

Constructor and Description
HexDumpOutputStream(PrintWriter out) Convenience constructor, which shows offset and character output, with non-printing and non-ASCII characters replaced by spaces.
HexDumpOutputStream(PrintWriter out, char replacement) The base constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying Writer.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Constructor Detail

HexDumpOutputStream

public HexDumpOutputStream(PrintWriter out,
                           char replacement)

The base constructor.

Parameters:

out - All output goes here. Typically, you will want to set auto-flush on.

replacement - The character used to replace non-printing and non- ASCII characters.

HexDumpOutputStream

public HexDumpOutputStream(PrintWriter out)

Convenience constructor, which shows offset and character output, with non-printing and non-ASCII characters replaced by spaces.

Method Detail

close

public void close()
           throws IOException

Closes the underlying Writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException