org.wildfly.security.util

Class ByteIterator

java.lang.Object

org.wildfly.security.util.ByteIterator

public abstract class ByteIterator
extends Object

A byte iterator.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field and Description
static ByteIterator	EMPTY The empty byte iterator.

Constructor Summary

Constructors

Constructor and Description
ByteIterator()

Method Summary

Modifier and Type	Method and Description
ByteStringBuilder	appendTo(ByteStringBuilder builder)
InputStream	asInputStream()
CodePointIterator	asLatin1String() Get this byte iterator as a Latin-1 string.
CodePointIterator	asUtf8String() Get this byte iterator as a UTF-8 string.
ByteIterator	base32Decode() Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
ByteIterator	base32Decode(Alphabet.Base32Alphabet alphabet) Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
ByteIterator	base32Decode(Alphabet.Base32Alphabet alphabet, boolean requirePadding) Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
CodePointIterator	base32Encode() Base32-encode the current stream.
CodePointIterator	base32Encode(Alphabet.Base32Alphabet alphabet) Base32-encode the current stream.
CodePointIterator	base32Encode(Alphabet.Base32Alphabet alphabet, boolean addPadding) Base32-encode the current stream.
ByteIterator	base64Decode() Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
ByteIterator	base64Decode(Alphabet.Base64Alphabet alphabet) Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
ByteIterator	base64Decode(Alphabet.Base64Alphabet alphabet, boolean requirePadding) Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
CodePointIterator	base64Encode() Base64-encode the current stream.
CodePointIterator	base64Encode(Alphabet.Base64Alphabet alphabet) Base64-encode the current stream.
CodePointIterator	base64Encode(Alphabet.Base64Alphabet alphabet, boolean addPadding) Base64-encode the current stream.
boolean	contentEquals(ByteIterator other) Determine if the remaining contents of this iterator are identical to the remaining contents of the other iterator.
ByteIterator	delimitedBy(int... delims) Get a sub-iterator that is delimited by the given bytes.
ByteIterator	doFinal(Mac mac)
ByteIterator	doFinal(MessageDigest digest)
byte[]	drain() Drain all the remaining bytes in this iterator.
int	drain(byte[] dst)
int	drain(byte[] dst, int offs, int len)
byte[]	drain(int count) Drain up to count bytes from this iterator, returning the result.
byte[]	drainAll(int count) Drain exactly count bytes from this iterator, returning the result.
ByteArrayOutputStream	drainTo(ByteArrayOutputStream stream) Drain all the remaining bytes in this iterator to the given stream.
String	drainToLatin1(int count) Convenience method to directly drain a certain number of bytes to a Latin-1 string.
String	drainToUtf8(int count) Convenience method to directly drain a certain number of bytes to a UTF-8 string.
int	getBE16()
int	getBE32()
long	getBE64()
int	getPackedBE32()
long	getPackedBE64()
abstract boolean	hasNext() Determine if there are more bytes after the current byte.
abstract boolean	hasPrev() Determine if there are more bytes before the current byte.
ByteIterator	hexDecode() Hex-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.
CodePointIterator	hexEncode() Hex-encode the current stream.
CodePointIterator	hexEncode(boolean toUpperCase) Hex-encode the current stream.
ByteIterator	interleavedWith(byte[] table) Get a byte iterator which translates this byte iterator through an interleaving table.
ByteIterator	interleavedWith(int[] table) Get a byte iterator which translates this byte iterator through an interleaving table.
ByteIterator	limitedTo(int size) Return a copy of this iterator which is limited to the given number of bytes after the current one.
abstract int	next() Get the next byte.
static ByteIterator	ofBytes(byte... bytes) Get a byte iterator for a byte array.
static ByteIterator	ofBytes(byte[] bytes, int[] interleave) Get a byte iterator for a byte array with interleave.
static ByteIterator	ofBytes(byte[] bytes, int offs, int len) Get a byte iterator for a byte array.
static ByteIterator	ofBytes(byte[] bytes, int offs, int len, int[] interleave) Get a byte iterator for a byte array with interleave.
abstract int	offset() Get the current offset, in bytes.
abstract int	peekNext() Peek at the next byte without advancing.
abstract int	peekPrev() Peek at the previous byte without moving backwards.
abstract int	prev() Get the previous byte.
ByteIterator	sign(Signature signature)
void	update(Mac mac)
void	update(MessageDigest digest)
void	update(Signature signature)
boolean	verify(Signature signature)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ByteIterator EMPTY

The empty byte iterator.

Constructor Detail

ByteIterator

public ByteIterator()

Method Detail

hasNext

public abstract boolean hasNext()

Determine if there are more bytes after the current byte.

Returns:

true if there are more bytes, false otherwise

hasPrev

public abstract boolean hasPrev()

Determine if there are more bytes before the current byte.

Returns:

true if there are more bytes, false otherwise

next

public abstract int next()
                  throws NoSuchElementException

Get the next byte.

Returns:

the next byte

Throws:

NoSuchElementException - if hasNext() returns false

peekNext

public abstract int peekNext()
                      throws NoSuchElementException

Peek at the next byte without advancing.

Returns:

the next byte

Throws:

NoSuchElementException - if hasNext() returns false

prev

public abstract int prev()
                  throws NoSuchElementException

Get the previous byte.

Returns:

the previous byte

Throws:

NoSuchElementException - if hasPrev() returns false

peekPrev

public abstract int peekPrev()
                      throws NoSuchElementException

Peek at the previous byte without moving backwards.

Returns:

the previous byte

Throws:

NoSuchElementException - if hasPrev() returns false

offset

public abstract int offset()

Get the current offset, in bytes.

Returns:

the byte offset

getBE16

public int getBE16()
            throws NoSuchElementException

Throws:

NoSuchElementException

getBE32

public int getBE32()
            throws NoSuchElementException

Throws:

NoSuchElementException

getBE64

public long getBE64()
             throws NoSuchElementException

Throws:

NoSuchElementException

getPackedBE32

public int getPackedBE32()
                  throws NoSuchElementException

Throws:

NoSuchElementException

getPackedBE64

public long getPackedBE64()
                   throws NoSuchElementException

Throws:

NoSuchElementException

appendTo

public ByteStringBuilder appendTo(ByteStringBuilder builder)

update

public void update(MessageDigest digest)
            throws IllegalStateException

Throws:

IllegalStateException

doFinal

public ByteIterator doFinal(MessageDigest digest)
                     throws IllegalStateException

Throws:

IllegalStateException

update

public void update(Mac mac)
            throws IllegalStateException

Throws:

IllegalStateException

doFinal

public ByteIterator doFinal(Mac mac)
                     throws IllegalStateException

Throws:

IllegalStateException

update

public void update(Signature signature)
            throws IllegalStateException

Throws:

IllegalStateException

sign

public ByteIterator sign(Signature signature)
                  throws IllegalStateException

Throws:

IllegalStateException

verify

public boolean verify(Signature signature)
               throws IllegalStateException

Throws:

IllegalStateException

base64Decode

public ByteIterator base64Decode(Alphabet.Base64Alphabet alphabet,
                                 boolean requirePadding)

Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Parameters:

alphabet - the alphabet to use

requirePadding - true to require padding, false if padding is optional

Returns:

an iterator over the decoded bytes

base64Decode

public ByteIterator base64Decode(Alphabet.Base64Alphabet alphabet)

Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Parameters:

alphabet - the alphabet to use

Returns:

an iterator over the decoded bytes

base64Decode

public ByteIterator base64Decode()

Base64-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Returns:

an iterator over the decoded bytes

base64Encode

public CodePointIterator base64Encode(Alphabet.Base64Alphabet alphabet,
                                      boolean addPadding)

Base64-encode the current stream.

Parameters:

alphabet - the alphabet to use

addPadding - true to add trailing padding, false to leave it off

Returns:

an iterator over the encoded characters

base64Encode

public CodePointIterator base64Encode(Alphabet.Base64Alphabet alphabet)

Base64-encode the current stream.

Parameters:

alphabet - the alphabet to use

Returns:

an iterator over the encoded characters

base64Encode

public CodePointIterator base64Encode()

Base64-encode the current stream.

Returns:

an iterator over the encoded characters

base32Decode

public ByteIterator base32Decode(Alphabet.Base32Alphabet alphabet,
                                 boolean requirePadding)

Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Parameters:

alphabet - the alphabet to use

requirePadding - true to require padding, false if padding is optional

Returns:

an iterator over the decoded bytes

base32Decode

public ByteIterator base32Decode(Alphabet.Base32Alphabet alphabet)

Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Parameters:

alphabet - the alphabet to use

Returns:

an iterator over the decoded bytes

base32Decode

public ByteIterator base32Decode()

Base32-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Returns:

an iterator over the decoded bytes

base32Encode

public CodePointIterator base32Encode(Alphabet.Base32Alphabet alphabet,
                                      boolean addPadding)

Base32-encode the current stream.

Parameters:

alphabet - the alphabet to use

addPadding - true to add trailing padding, false to leave it off

Returns:

an iterator over the encoded characters

base32Encode

public CodePointIterator base32Encode(Alphabet.Base32Alphabet alphabet)

Base32-encode the current stream.

Parameters:

alphabet - the alphabet to use

Returns:

an iterator over the encoded characters

base32Encode

public CodePointIterator base32Encode()

Base32-encode the current stream.

Returns:

an iterator over the encoded characters

hexDecode

public ByteIterator hexDecode()

Hex-decode the current stream, assuming that the byte data is encoded in an ASCII-derived encoding.

Returns:

an iterator over the decoded bytes

hexEncode

public CodePointIterator hexEncode(boolean toUpperCase)

Hex-encode the current stream.

Parameters:

toUpperCase - true to use upper case characters when encoding, false to use lower case characters

Returns:

an iterator over the encoded characters

hexEncode

public CodePointIterator hexEncode()

Hex-encode the current stream.

Returns:

an iterator over the encoded characters

asUtf8String

public CodePointIterator asUtf8String()

Get this byte iterator as a UTF-8 string.

Returns:

the code point iterator

asLatin1String

public CodePointIterator asLatin1String()

Get this byte iterator as a Latin-1 string.

Returns:

the code point iterator

contentEquals

public final boolean contentEquals(ByteIterator other)

Determine if the remaining contents of this iterator are identical to the remaining contents of the other iterator. If the contents are not equal, the iterators will be positioned at the location of the first difference. If the contents are equal, the iterators will both be positioned at the end of their contents.

Parameters:

other - the other byte iterator

Returns:

true if the contents are equal, false otherwise

limitedTo

public final ByteIterator limitedTo(int size)

Return a copy of this iterator which is limited to the given number of bytes after the current one. Advancing the returned iterator will also advance this one.

Parameters:

size - the number of bytes

Returns:

the limited byte iterator

delimitedBy

public final ByteIterator delimitedBy(int... delims)

Get a sub-iterator that is delimited by the given bytes. The returned iterator offset starts at 0 and cannot be backed up before that point. The returned iterator will return false for hasNext() if the next character in the encapsulated iterator is a delimiter or if the underlying iterator returns false for hasNext().

Parameters:

delims - the byte delimiters

Returns:

the sub-iterator

interleavedWith

public ByteIterator interleavedWith(byte[] table)

Get a byte iterator which translates this byte iterator through an interleaving table. The table should be 256 entries in size or exceptions may result.

Parameters:

table - the interleaving table

Returns:

the interleaving byte iterator

interleavedWith

public ByteIterator interleavedWith(int[] table)

Get a byte iterator which translates this byte iterator through an interleaving table. The table should be 256 entries in size or exceptions may result.

Parameters:

table - the interleaving table

Returns:

the interleaving byte iterator

drainTo

public ByteArrayOutputStream drainTo(ByteArrayOutputStream stream)

Drain all the remaining bytes in this iterator to the given stream.

Parameters:

stream - the stream

Returns:

the same stream

drain

public byte[] drain()

Drain all the remaining bytes in this iterator.

Returns:

the remaining bytes as a single array

drain

public byte[] drain(int count)

Drain up to count bytes from this iterator, returning the result.

Parameters:

count - the number of bytes to read

Returns:

the array of consumed bytes (may be smaller than count)

drainAll

public byte[] drainAll(int count)
                throws NoSuchElementException

Drain exactly count bytes from this iterator, returning the result.

Parameters:

count - the number of bytes to read

Returns:

the array of consumed bytes

Throws:

NoSuchElementException - if there are not enough bytes to fill the array

drain

public int drain(byte[] dst)

drain

public int drain(byte[] dst,
                 int offs,
                 int len)

drainToUtf8

public String drainToUtf8(int count)

Convenience method to directly drain a certain number of bytes to a UTF-8 string. If fewer than count bytes are available, only the available bytes will be used to construct the string.

Parameters:

count - the maximum number of bytes to consume

Returns:

the UTF-8 string

drainToLatin1

public String drainToLatin1(int count)

Convenience method to directly drain a certain number of bytes to a Latin-1 string. If fewer than count bytes are available, only the available bytes will be used to construct the string.

Parameters:

count - the maximum number of bytes to consume

Returns:

the Latin-1 string

ofBytes

public static ByteIterator ofBytes(byte... bytes)

Get a byte iterator for a byte array.

Parameters:

bytes - the array

Returns:

the byte iterator

ofBytes

public static ByteIterator ofBytes(byte[] bytes,
                                   int offs,
                                   int len)

Get a byte iterator for a byte array.

Parameters:

bytes - the array

offs - the array offset

len - the number of bytes to include

Returns:

the byte iterator

ofBytes

public static ByteIterator ofBytes(byte[] bytes,
                                   int offs,
                                   int len,
                                   int[] interleave)

Get a byte iterator for a byte array with interleave.

Parameters:

bytes - the array

offs - the array offset

len - the number of bytes to include

interleave - the interleave table to use

Returns:

the byte iterator

ofBytes

public static ByteIterator ofBytes(byte[] bytes,
                                   int[] interleave)

Get a byte iterator for a byte array with interleave.

Parameters:

bytes - the array

interleave - the interleave table to use

Returns:

the byte iterator

asInputStream

public final InputStream asInputStream()