com.github.robtimus.io.stream

Class HexOutputStream

java.lang.Object

java.io.OutputStream

com.github.robtimus.io.stream.HexOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class HexOutputStream
extends OutputStream

An output stream that converts bytes into hex.

When a hex output stream is closed, its wrapped Appendable will be closed as well if it implements Closeable or AutoCloseable.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
HexOutputStream(Appendable destination) Creates a new hex output stream.
HexOutputStream(Appendable destination, boolean upperCase) Creates a new hex output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
static String	encode(byte[] b) Converts a byte array to its lower case hex representation.
static String	encode(byte[] b, boolean upperCase) Converts a byte array to its hex representation.
static String	encode(byte[] b, int start, int end) Converts a portion of byte array to its lower case hex representation.
static String	encode(byte[] b, int start, int end, boolean upperCase) Converts a portion of a byte array to its hex representation.
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

HexOutputStream

public HexOutputStream(Appendable destination)

Creates a new hex output stream. It will write hex in lower case.

Parameters:

destination - The appendable to write to.

Throws:

NullPointerException - If the given appendable is null.

HexOutputStream

public HexOutputStream(Appendable destination,
                       boolean upperCase)

Creates a new hex output stream.

Parameters:

destination - The appendable to write to.

upperCase - true to write hex in upper case, or false to write hex in lower case.

Throws:

NullPointerException - If the given appendable is null.

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

encode

public static String encode(byte[] b)

Converts a byte array to its lower case hex representation.

Parameters:

b - The byte array to convert.

Returns:

The hex representation of the given byte array.

Throws:

NullPointerException - If the given byte array is null.

encode

public static String encode(byte[] b,
                            int start,
                            int end)

Converts a portion of byte array to its lower case hex representation.

Parameters:

b - The byte array to convert a portion of.

start - The start index of the portion to convert, inclusive.

end - The end index of the portion to convert, exclusive.

Returns:

The hex representation of the given portion of the given byte array.

Throws:

NullPointerException - If the given byte array is null.

IndexOutOfBoundsException - If the given start index is negative, the given end index is larger than the given array's length, or the given start index is larger than the given end index.

encode

public static String encode(byte[] b,
                            boolean upperCase)

Converts a byte array to its hex representation.

Parameters:

b - The byte array to convert.

upperCase - true to return hex in upper case, or false to return hex in lower case.

Returns:

The hex representation of the given byte array.

Throws:

NullPointerException - If the given byte array is null.

encode

public static String encode(byte[] b,
                            int start,
                            int end,
                            boolean upperCase)

Converts a portion of a byte array to its hex representation.

Parameters:

b - The byte array to convert a portion of.

start - The start index of the portion to convert, inclusive.

end - The end index of the portion to convert, exclusive.

upperCase - true to return hex in upper case, or false to return hex in lower case.

Returns:

The hex representation of the given portion of the given byte array.

Throws:

NullPointerException - If the given byte array is null.

IndexOutOfBoundsException - If the given start index is negative, the given end index is larger than the given array's length, or the given start index is larger than the given end index.