org.openorb.util
Class HexPrintStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FilterOutputStream
              |
              +--org.openorb.util.HexPrintStream

public class HexPrintStream

extends FilterOutputStream

This filter stream is used to write binary data out as formatted hex digits in one of four formats.

Version:

$Revision: 1.8 $ $Date: 2004/02/11 08:46:37 $

Author:

Chris Wood

Field Summary

static int	FORMAT_HEXONLY This format writes data out line by line, with breaks on word boundaries boundaries.
static int	FORMAT_MIXED This format prints out the ASCII data in the left column and the corresponding hex data in the right column, with breaks on word boundaries.
static int	FORMAT_MIXED_TWOLINE This format prints out ASCII chars above the hex codes.
static int	FORMAT_SIMPLE Simple format.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

HexPrintStream(OutputStream out)
Create new HexPrintStream.

HexPrintStream(OutputStream out, int format)
Create new HexPrintStream and select the format.

Method Summary

void	close() Close the stream.
void	flush() Flush the stream.
int	getFormat()
static boolean	isPrintable(byte value) This function was defined in the Tracing class, i've moved it to here.
static void	main(String[] args)
void	setFormat(int format) Change the output format.
static String	toHex(byte val) Convert a byte value into hexadecimal string representation.
static String	toHex(byte[] arr) Convert a byte array into a printable representation.
static String	toHex(int val) Convert an integer value into hexadecimal string representation.
static String	toHex(short val) Convert a short value into hexadecimal string representation.
void	write(byte[] buf) Write an array of bytes to the stream.
void	write(byte[] buf, int off, int len) Write an array of bytes to the stream.
void	write(int val) Write a single byte to the stream.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_SIMPLE

public static final int FORMAT_SIMPLE

Simple format. Each input byte is transformed directly into it's hex equivalent and written to the output stream.

FORMAT_HEXONLY

public static final int FORMAT_HEXONLY

This format writes data out line by line, with breaks on word boundaries boundaries. To complete writing the stream must be flushed.

FORMAT_MIXED

public static final int FORMAT_MIXED

This format prints out the ASCII data in the left column and the corresponding hex data in the right column, with breaks on word boundaries. To complete writing a partial line the stream must be flushed.

FORMAT_MIXED_TWOLINE

public static final int FORMAT_MIXED_TWOLINE

This format prints out ASCII chars above the hex codes. To complete writing a partial line the stream must be flushed.

Constructor Detail

HexPrintStream

public HexPrintStream(OutputStream out)

Create new HexPrintStream. This uses FORMAT_SIMPLE

HexPrintStream

public HexPrintStream(OutputStream out,
                      int format)

Create new HexPrintStream and select the format.

Method Detail

write

public void write(int val)
           throws IOException

Write a single byte to the stream.

Overrides:

write in class FilterOutputStream

write

public void write(byte[] buf)
           throws IOException

Write an array of bytes to the stream.

Overrides:

write in class FilterOutputStream

write

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

Write an array of bytes to the stream.

Overrides:

write in class FilterOutputStream

flush

public void flush()
           throws IOException

Flush the stream. For some formats this causes a line break to occour.

Overrides:

flush in class FilterOutputStream

close

public void close()
           throws IOException

Close the stream. Flush, then call close on the underlying stream.

Overrides:

close in class FilterOutputStream

getFormat

public int getFormat()

setFormat

public void setFormat(int format)

Change the output format. This causes a flush before the format is changed.

toHex

public static String toHex(int val)

Convert an integer value into hexadecimal string representation.

Parameters:

val - Integer value to convert.

Returns:

String with the hexadecimal representation of the integer val.

toHex

public static String toHex(short val)

Convert a short value into hexadecimal string representation.

Parameters:

val - Short value to convert.

Returns:

String with the hexadecimal representation of the short val.

toHex

public static String toHex(byte val)

Convert a byte value into hexadecimal string representation.

Parameters:

val - Byte value to convert.

Returns:

String with the hexadecimal representation of the byte val.

toHex

public static String toHex(byte[] arr)

Convert a byte array into a printable representation.

Parameters:

arr - The array to convert.

Returns:

The stringified representation of the array.

isPrintable

public static boolean isPrintable(byte value)

This function was defined in the Tracing class, i've moved it to here. The isISOControl function seems to work fairly well as a printable test anyhow. It seems that the isISOControl sometimes misses some characters that the shell interprets as control characters. The isPrintable method does a positive check and it is thus more likely to filter out non-printable characters.

Parameters:

value - The byte value to check.

Returns:

True when value is printable, false otherwise.

main

public static void main(String[] args)