davmail.ldap

Class HexDumpEncoder

java.lang.Object

davmail.ldap.HexDumpEncoder

public class HexDumpEncoder
extends Object

This class encodes a buffer into the classic: "Hexadecimal Dump" format of the past. It is useful for analyzing the contents of binary buffers. The format produced is as follows:

 xxxx: 00 11 22 33 44 55 66 77   88 99 aa bb cc dd ee ff ................
 

Where xxxx is the offset into the buffer in 16 byte chunks, followed by ascii coded hexadecimal bytes followed by the ASCII representation of the bytes or '.' if they are not valid bytes.

Author:

Chuck McManis

Field Summary

Fields

Modifier and Type	Field and Description
protected PrintStream	pStream Stream that understands "printing"

Constructor Summary

Constructors

Constructor and Description
HexDumpEncoder()

Method Summary

Modifier and Type	Method and Description
protected int	bytesPerAtom()
protected int	bytesPerLine()
String	encode(byte[] aBuffer) A 'streamless' version of encode that simply takes a buffer of bytes and returns a string containing the encoded buffer.
String	encode(ByteBuffer aBuffer) A 'streamless' version of encode that simply takes a ByteBuffer and returns a string containing the encoded buffer.
void	encode(InputStream inStream, OutputStream outStream) Encode bytes from the input stream, and write them as text characters to the output stream.
protected void	encodeAtom(byte[] buf, int off)
String	encodeBuffer(byte[] aBuffer) A 'streamless' version of encode that simply takes a buffer of bytes and returns a string containing the encoded buffer.
void	encodeBuffer(byte[] aBuffer, OutputStream aStream) Encode the buffer in aBuffer and write the encoded result to the OutputStream aStream.
void	encodeBuffer(ByteBuffer aBuffer, OutputStream aStream) Encode the aBuffer ByteBuffer and write the encoded result to the OutputStream aStream.
void	encodeBuffer(InputStream inStream, OutputStream outStream) Encode bytes from the input stream, and write them as text characters to the output stream.
protected void	encodeBufferPrefix(OutputStream o)
protected void	encodeLinePrefix(int len)
protected void	encodeLineSuffix()
protected int	readFully(InputStream in, byte[] buffer) This method works around the bizarre semantics of BufferedInputStream's read method.

Methods inherited from class java.lang.Object

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

Field Detail

pStream

protected PrintStream pStream

Stream that understands "printing"

Constructor Detail

HexDumpEncoder

public HexDumpEncoder()

Method Detail

bytesPerAtom

protected int bytesPerAtom()

bytesPerLine

protected int bytesPerLine()

encodeBufferPrefix

protected void encodeBufferPrefix(OutputStream o)

encodeLinePrefix

protected void encodeLinePrefix(int len)

encodeAtom

protected void encodeAtom(byte[] buf,
                          int off)

encodeLineSuffix

protected void encodeLineSuffix()

readFully

protected int readFully(InputStream in,
                        byte[] buffer)
                 throws IOException

This method works around the bizarre semantics of BufferedInputStream's read method.

Throws:

IOException

encode

public void encode(InputStream inStream,
                   OutputStream outStream)
            throws IOException

Encode bytes from the input stream, and write them as text characters to the output stream. This method will run until it exhausts the input stream, but does not print the line suffix for a final line that is shorter than bytesPerLine().

Throws:

IOException

encode

public String encode(byte[] aBuffer)

A 'streamless' version of encode that simply takes a buffer of bytes and returns a string containing the encoded buffer.

encode

public String encode(ByteBuffer aBuffer)

A 'streamless' version of encode that simply takes a ByteBuffer and returns a string containing the encoded buffer.

The ByteBuffer's position will be advanced to ByteBuffer's limit.

encodeBuffer

public void encodeBuffer(InputStream inStream,
                         OutputStream outStream)
                  throws IOException

Encode bytes from the input stream, and write them as text characters to the output stream. This method will run until it exhausts the input stream. It differs from encode in that it will add the line at the end of a final line that is shorter than bytesPerLine().

Throws:

IOException

encodeBuffer

public void encodeBuffer(byte[] aBuffer,
                         OutputStream aStream)
                  throws IOException

Encode the buffer in aBuffer and write the encoded result to the OutputStream aStream.

Throws:

IOException

encodeBuffer

public String encodeBuffer(byte[] aBuffer)

A 'streamless' version of encode that simply takes a buffer of bytes and returns a string containing the encoded buffer.

encodeBuffer

public void encodeBuffer(ByteBuffer aBuffer,
                         OutputStream aStream)
                  throws IOException

Encode the aBuffer ByteBuffer and write the encoded result to the OutputStream aStream.

The ByteBuffer's position will be advanced to ByteBuffer's limit.

Throws:

IOException