com.github.robtimus.io.stream

Class HexInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.HexInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class HexInputStream
extends InputStream

An input stream that converts hex into bytes.

When a hex input stream is closed, its source will be closed as well.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
HexInputStream(Reader source) Creates a new hex input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
static byte[]	decode(CharSequence hex) Converts a hex representation into a byte array.
static byte[]	decode(CharSequence hex, int start, int end) Converts a hex representation into a byte array.
int	read()
int	read(byte[] b, int off, int len)
static Optional<byte[]>	tryDecode(CharSequence hex) Attempts to converts a hex representation into a byte array.
static Optional<byte[]>	tryDecode(CharSequence hex, int start, int end) Attempts to converts a hex representation into a byte array.

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HexInputStream

public HexInputStream(Reader source)

Creates a new hex input stream.

Parameters:

source - The reader that forms the source of the hex characters.

Throws:

NullPointerException - If the given reader is null.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

decode

public static byte[] decode(CharSequence hex)

Converts a hex representation into a byte array.

Parameters:

hex - The character sequence with the hex representation to convert.

Returns:

The bytes from the given hex representation.

Throws:

NullPointerException - If the given character sequence is null.

IllegalArgumentException - If the given character sequence does not contain a valid hex representation.

decode

public static byte[] decode(CharSequence hex,
                            int start,
                            int end)

Converts a hex representation into a byte array.

Parameters:

hex - The character sequence with the hex representation to convert.

start - The start index of the character sequence of the hex representation to convert, inclusive.

end - The end index of the character sequence of the hex representation to convert, exclusive.

Returns:

The bytes from the given hex representation.

Throws:

NullPointerException - If the given character sequence is null.

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

IllegalArgumentException - If the given character sequence does not contain a valid hex representation.

tryDecode

public static Optional<byte[]> tryDecode(CharSequence hex)

Attempts to converts a hex representation into a byte array.

Parameters:

hex - The character sequence with the hex representation to convert.

Returns:

An Optional with the bytes from the given hex representation, or Optional.empty() if the character sequence is null or does not contain a valid hex representation.

Throws:

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

tryDecode

public static Optional<byte[]> tryDecode(CharSequence hex,
                                         int start,
                                         int end)

Attempts to converts a hex representation into a byte array.

Parameters:

hex - The character sequence with the hex representation to convert.

start - The start index of the character sequence of the hex representation to convert, inclusive.

end - The end index of the character sequence of the hex representation to convert, exclusive.

Returns:

An Optional with the bytes from the given hex representation, or Optional.empty() if the character sequence is null or does not contain a valid hex representation.

Throws:

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