JBoss Parent POM 1.7.0.Final · org.wildfly.common.iteration.ByteIterator

Modifier and Type	Field and Description
public static final ByteIterator	EMPTY The empty byte iterator.
private static final byte[]	NO_BYTES
private static final ThreadLocal<byte[]>	OP_BUFFER
private static final int	OP_BUFFER_SIZE

Access	Constructor and Description
pack-priv	ByteIterator()

Method Summary

Modifier and Type	Method and Description
public ByteStringBuilder	appendTo(final ByteStringBuilder builder)
public final InputStream	Returns: the input stream (not `null`) asInputStream() Get this iterator as an input stream.
public CodePointIterator	Returns: the code point iterator asLatin1String() Get this byte iterator as a Latin-1 string.
public CodePointIterator	Returns: the code point iterator asUtf8String() Get this byte iterator as a UTF-8 string.
public CodePointIterator	Returns: an iterator over the encoded characters base32Encode(final Base32Alphabet the alphabet to use alphabet, final boolean `true` to add trailing padding, `false` to leave it off addPadding) Base32-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters base32Encode(final Base32Alphabet the alphabet to use alphabet) Base32-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters base32Encode() Base32-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters base64Encode(final Base64Alphabet the alphabet to use alphabet, final boolean `true` to add trailing padding, `false` to leave it off addPadding) Base64-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters base64Encode(final Base64Alphabet the alphabet to use alphabet) Base64-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters base64Encode() Base64-encode the current stream.
public final boolean	Returns: `true` if the contents are equal, `false` otherwise contentEquals(ByteIterator the other byte iterator other) Determine if the remaining contents of this iterator are identical to the remaining contents of the other iterator.
public final ByteIterator	Returns: the sub-iterator delimitedBy(final int... the byte delimiters delims) Get a sub-iterator that is delimited by the given bytes.
public ByteIterator	doFinal(MessageDigest digest)
public ByteIterator	doFinal(Mac mac)
public byte[]	Returns: the remaining bytes as a single array drain() Drain all the remaining bytes in this iterator.
public byte[]	Returns: the array of consumed bytes (may be smaller than `count`) drain(int the number of bytes to read count) Drain up to `count` bytes from this iterator, returning the result.
public int	Returns: the total number of bytes drained into `dst`, always greater or equal to `0` drain(byte[] the buffer into which the data is drained dst) Drains up to `dst.length` bytes from this iterator into the given `dst` array.
public int	Returns: the total number of bytes drained into `dst`, always greater or equal to `0` drain(byte[] the buffer into which the data is drained dst, int the start offset in array `dst` at which the data is written. offs, int the maximum number of bytes to drain len) Drains up to `len` bytes from this iterator into the given `dst` array.
public byte[]	Returns: the array of consumed bytes drainAll(int the number of bytes to read count) Drain exactly `count` bytes from this iterator, returning the result.
public ByteArrayOutputStream	Returns: the same stream drainTo(ByteArrayOutputStream the stream stream) Drain all the remaining bytes in this iterator to the given stream.
public String	Returns: the Latin-1 string drainToLatin1(int the maximum number of bytes to consume count) Convenience method to directly drain a certain number of bytes to a Latin-1 string.
public String	Returns: the UTF-8 string drainToUtf8(int the maximum number of bytes to consume count) Convenience method to directly drain a certain number of bytes to a UTF-8 string.
public int	getBE16()
public int	getBE32()
public long	getBE64()
public abstract long	Returns: the byte offset getIndex() Redeclares org.wildfly.common.iteration.IndexIterator.getIndex. Get the current offset, in bytes.
public int	getLE16()
public int	getLE32()
public long	getLE64()
public int	getPackedBE32()
public long	getPackedBE64()
public abstract boolean	Returns: `true` if there are more bytes, `false` otherwise hasNext() Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasNext. Determine if there are more bytes after the current byte.
public abstract boolean	Returns: `true` if there are more bytes, `false` otherwise hasPrevious() Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasPrevious. Determine if there are more bytes before the current byte.
public CodePointIterator	Returns: an iterator over the encoded characters hexEncode(boolean `true` to use upper case characters when encoding, `false` to use lower case characters toUpperCase) Hex-encode the current stream.
public CodePointIterator	Returns: an iterator over the encoded characters hexEncode() Hex-encode the current stream.
public ByteIterator	Returns: the interleaving byte iterator interleavedWith(final byte[] the interleaving table table) Get a byte iterator which translates this byte iterator through an interleaving table.
public ByteIterator	Returns: the interleaving byte iterator interleavedWith(final int[] the interleaving table table) Get a byte iterator which translates this byte iterator through an interleaving table.
public final ByteIterator	Returns: the limited byte iterator limitedTo(final int the number of bytes size) Return a copy of this iterator which is limited to the given number of bytes after the current one.
public abstract int	Returns: the next byte next() Redeclares org.wildfly.common.iteration.BiDirIntIterator.next. Get the next byte.
public static ByteIterator	Returns: the byte iterator (not `null`) ofByteBuffer(ByteBuffer the byte buffer (must not be `null`) buffer) Get a byte iterator for a byte buffer.
public static ByteIterator	Returns: the byte iterator ofBytes(final byte... the array bytes) Get a byte iterator for a byte array.
public static ByteIterator	Returns: the byte iterator ofBytes(final byte[] the array bytes, final int the array offset offs, final int the number of bytes to include len) Get a byte iterator for a byte array.
public static ByteIterator	Returns: the byte iterator ofBytes(final byte[] the array bytes, final int the array offset offs, final int the number of bytes to include len, final int[] the interleave table to use interleave) Get a byte iterator for a byte array with interleave.
public static ByteIterator	Returns: the byte iterator ofBytes(final byte[] the array bytes, final int[] the interleave table to use interleave) Get a byte iterator for a byte array with interleave.
public static ByteIterator	Returns: a concatenated iterator ofIterators(ByteIterator... the iterators array (must not be `null` or contain `null` elements) iterators) Get a concatenated byte iterator.
public abstract int	Returns: the next byte peekNext() Redeclares org.wildfly.common.iteration.BiDirIntIterator.peekNext. Peek at the next byte without advancing.
public abstract int	Returns: the previous byte peekPrevious() Redeclares org.wildfly.common.iteration.BiDirIntIterator.peekPrevious. Peek at the previous byte without moving backwards.
public abstract int	Returns: the previous byte previous() Redeclares org.wildfly.common.iteration.BiDirIntIterator.previous. Get the previous byte.
public ByteIterator	sign(Signature signature)
public void	update(MessageDigest digest)
public void	update(Mac mac)
public void	update(Signature signature)
public boolean	verify(Signature signature)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EMPTY	back to summary
public static final ByteIterator EMPTY The empty byte iterator.

NO_BYTES	back to summary
private static final byte[] NO_BYTES

OP_BUFFER	back to summary
private static final ThreadLocal<byte[]> OP_BUFFER

OP_BUFFER_SIZE	back to summary
private static final int OP_BUFFER_SIZE

ByteIterator	back to summary
pack-priv ByteIterator()

Method Detail

appendTo	back to summary
public ByteStringBuilder appendTo(final ByteStringBuilder builder)

asInputStream back to summary

asInputStream	back to summary
public final InputStream asInputStream() Get this iterator as an input stream. Returns:InputStream the input stream (not `null`)

public final InputStream asInputStream()

Get this iterator as an input stream.

Returns:InputStream: the input stream (not null)

asLatin1String	back to summary
public CodePointIterator asLatin1String() Get this byte iterator as a Latin-1 string. Returns:CodePointIterator the code point iterator

asLatin1String

back to summary

public CodePointIterator asLatin1String()

Get this byte iterator as a Latin-1 string.

Returns:CodePointIterator: the code point iterator

asUtf8String	back to summary
public CodePointIterator asUtf8String() Get this byte iterator as a UTF-8 string. Returns:CodePointIterator the code point iterator

asUtf8String

back to summary

public CodePointIterator asUtf8String()

Get this byte iterator as a UTF-8 string.

Returns:CodePointIterator: the code point iterator

base32Encode back to summary

base32Encode	back to summary
public CodePointIterator base32Encode(final Base32Alphabet alphabet, final boolean addPadding) Base32-encode the current stream. Parameters alphabet:Base32Alphabet the alphabet to use addPadding:boolean `true` to add trailing padding, `false` to leave it off Returns:CodePointIterator an iterator over the encoded characters

public CodePointIterator base32Encode(final Base32Alphabet alphabet, final boolean addPadding)

Base32-encode the current stream.

Parameters

alphabet:Base32Alphabet: the alphabet to use
addPadding:boolean: true to add trailing padding, false to leave it off

Returns:CodePointIterator

an iterator over the encoded characters

base32Encode	back to summary
public CodePointIterator base32Encode(final Base32Alphabet alphabet) Base32-encode the current stream. Parameters alphabet:Base32Alphabet the alphabet to use Returns:CodePointIterator an iterator over the encoded characters

base32Encode

back to summary

public CodePointIterator base32Encode(final Base32Alphabet alphabet)

Base32-encode the current stream.

Parameters

alphabet:Base32Alphabet: the alphabet to use

Returns:CodePointIterator

an iterator over the encoded characters

base32Encode	back to summary
public CodePointIterator base32Encode() Base32-encode the current stream. Returns:CodePointIterator an iterator over the encoded characters

base32Encode

back to summary

public CodePointIterator base32Encode()

Base32-encode the current stream.

Returns:CodePointIterator: an iterator over the encoded characters

base64Encode back to summary

base64Encode	back to summary
public CodePointIterator base64Encode(final Base64Alphabet alphabet, final boolean addPadding) Base64-encode the current stream. Parameters alphabet:Base64Alphabet the alphabet to use addPadding:boolean `true` to add trailing padding, `false` to leave it off Returns:CodePointIterator an iterator over the encoded characters

public CodePointIterator base64Encode(final Base64Alphabet alphabet, final boolean addPadding)

Base64-encode the current stream.

Parameters

alphabet:Base64Alphabet: the alphabet to use
addPadding:boolean: true to add trailing padding, false to leave it off

Returns:CodePointIterator

an iterator over the encoded characters

base64Encode	back to summary
public CodePointIterator base64Encode(final Base64Alphabet alphabet) Base64-encode the current stream. Parameters alphabet:Base64Alphabet the alphabet to use Returns:CodePointIterator an iterator over the encoded characters

base64Encode

back to summary

public CodePointIterator base64Encode(final Base64Alphabet alphabet)

Base64-encode the current stream.

Parameters

alphabet:Base64Alphabet: the alphabet to use

Returns:CodePointIterator

an iterator over the encoded characters

base64Encode	back to summary
public CodePointIterator base64Encode() Base64-encode the current stream. Returns:CodePointIterator an iterator over the encoded characters

base64Encode

back to summary

public CodePointIterator base64Encode()

Base64-encode the current stream.

Returns:CodePointIterator: an iterator over the encoded characters

contentEquals back to summary

contentEquals	back to summary
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:ByteIterator the other byte iterator Returns:boolean `true` if the contents are equal, `false` otherwise

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:ByteIterator: the other byte iterator

Returns:boolean

true if the contents are equal, false otherwise

delimitedBy back to summary

delimitedBy	back to summary
public final ByteIterator delimitedBy(final 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:int[] the byte delimiters Returns:ByteIterator the sub-iterator

public final ByteIterator delimitedBy(final 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:int[]: the byte delimiters

Returns:ByteIterator

the sub-iterator

doFinal	back to summary
public ByteIterator doFinal(MessageDigest digest)

doFinal	back to summary
public ByteIterator doFinal(Mac mac)

drain	back to summary
public byte[] drain() Drain all the remaining bytes in this iterator. Returns:byte[] the remaining bytes as a single array

drain

back to summary

public byte[] drain()

Drain all the remaining bytes in this iterator.

Returns:byte[]: the remaining bytes as a single array

drain back to summary

drain	back to summary
public byte[] drain(int count) Drain up to `count` bytes from this iterator, returning the result. Parameters count:int the number of bytes to read Returns:byte[] the array of consumed bytes (may be smaller than `count`)

public byte[] drain(int count)

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

Parameters

count:int: the number of bytes to read

Returns:byte[]

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

drain back to summary

drain	back to summary
public int drain(byte[] dst) Drains up to `dst.length` bytes from this iterator into the given `dst` array. An attempt is made to drain as many as `dst.length` bytes, but a smaller number may be drained. The number of bytes actually drained is returned as an integer. Unlike `InputStream#read(byte[], int, int)`, this method never returns a negative result. Parameters dst:byte[] the buffer into which the data is drained Returns:int the total number of bytes drained into `dst`, always greater or equal to `0`

public int drain(byte[] dst)

Drains up to dst.length bytes from this iterator into the given dst array. An attempt is made to drain as many as dst.length bytes, but a smaller number may be drained.

The number of bytes actually drained is returned as an integer. Unlike InputStream#read(byte[], int, int), this method never returns a negative result.

Parameters

dst:byte[]: the buffer into which the data is drained

Returns:int

the total number of bytes drained into dst, always greater or equal to 0

drain back to summary

drain	back to summary
public int drain(byte[] dst, int offs, int len) Drains up to `len` bytes from this iterator into the given `dst` array. An attempt is made to drain as many as `len` bytes, but a smaller number may be drained. The number of bytes actually drained is returned as an integer. Unlike `InputStream#read(byte[], int, int)`, this method never returns a negative result. Parameters dst:byte[] the buffer into which the data is drained offs:int the start offset in array `dst` at which the data is written. len:int the maximum number of bytes to drain Returns:int the total number of bytes drained into `dst`, always greater or equal to `0`

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

Drains up to len bytes from this iterator into the given dst array. An attempt is made to drain as many as len bytes, but a smaller number may be drained.

The number of bytes actually drained is returned as an integer. Unlike InputStream#read(byte[], int, int), this method never returns a negative result.

Parameters

dst:byte[]: the buffer into which the data is drained
offs:int: the start offset in array dst at which the data is written.
len:int: the maximum number of bytes to drain

Returns:int

the total number of bytes drained into dst, always greater or equal to 0

drainAll back to summary

drainAll	back to summary
public byte[] drainAll(int count) throws NoSuchElementException Drain exactly `count` bytes from this iterator, returning the result. Parameters count:int the number of bytes to read Returns:byte[] the array of consumed bytes Exceptions NoSuchElementException: if there are not enough bytes to fill the array

public byte[] drainAll(int count) throws NoSuchElementException

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

Parameters

count:int: the number of bytes to read

Returns:byte[]

the array of consumed bytes

Exceptions

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

drainTo	back to summary
public ByteArrayOutputStream drainTo(ByteArrayOutputStream stream) Drain all the remaining bytes in this iterator to the given stream. Parameters stream:ByteArrayOutputStream the stream Returns:ByteArrayOutputStream the same stream

drainTo

back to summary

public ByteArrayOutputStream drainTo(ByteArrayOutputStream stream)

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

Parameters

stream:ByteArrayOutputStream: the stream

Returns:ByteArrayOutputStream

the same stream

drainToLatin1 back to summary

drainToLatin1	back to summary
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:int the maximum number of bytes to consume Returns:String the Latin-1 string

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:int: the maximum number of bytes to consume

Returns:String

the Latin-1 string

drainToUtf8 back to summary

drainToUtf8	back to summary
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:int the maximum number of bytes to consume Returns:String the UTF-8 string

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:int: the maximum number of bytes to consume

Returns:String

the UTF-8 string

getBE16	back to summary
public int getBE16() throws NoSuchElementException

getBE32	back to summary
public int getBE32() throws NoSuchElementException

getBE64	back to summary
public long getBE64() throws NoSuchElementException

getIndex	back to summary
public abstract long getIndex() Redeclares org.wildfly.common.iteration.IndexIterator.getIndex. Get the current offset, in bytes. Returns:long the byte offset

getIndex

back to summary

public abstract long getIndex()

Redeclares org.wildfly.common.iteration.IndexIterator.getIndex.

Get the current offset, in bytes.

Returns:long: the byte offset

getLE16	back to summary
public int getLE16() throws NoSuchElementException

getLE32	back to summary
public int getLE32() throws NoSuchElementException

getLE64	back to summary
public long getLE64() throws NoSuchElementException

getPackedBE32	back to summary
public int getPackedBE32() throws NoSuchElementException

getPackedBE64	back to summary
public long getPackedBE64() throws NoSuchElementException

hasNext back to summary

hasNext	back to summary
public abstract boolean hasNext() Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasNext. Determine if there are more bytes after the current byte. Returns:boolean `true` if there are more bytes, `false` otherwise

public abstract boolean hasNext()

Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasNext.

Determine if there are more bytes after the current byte.

Returns:boolean: true if there are more bytes, false otherwise

hasPrevious back to summary

hasPrevious	back to summary
public abstract boolean hasPrevious() Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasPrevious. Determine if there are more bytes before the current byte. Returns:boolean `true` if there are more bytes, `false` otherwise

public abstract boolean hasPrevious()

Redeclares org.wildfly.common.iteration.BiDirIntIterator.hasPrevious.

Determine if there are more bytes before the current byte.

Returns:boolean: true if there are more bytes, false otherwise

hexEncode back to summary

hexEncode	back to summary
public CodePointIterator hexEncode(boolean toUpperCase) Hex-encode the current stream. Parameters toUpperCase:boolean `true` to use upper case characters when encoding, `false` to use lower case characters Returns:CodePointIterator an iterator over the encoded characters

public CodePointIterator hexEncode(boolean toUpperCase)

Hex-encode the current stream.

Parameters

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

Returns:CodePointIterator

an iterator over the encoded characters

hexEncode	back to summary
public CodePointIterator hexEncode() Hex-encode the current stream. Returns:CodePointIterator an iterator over the encoded characters

hexEncode

back to summary

public CodePointIterator hexEncode()

Hex-encode the current stream.

Returns:CodePointIterator: an iterator over the encoded characters

interleavedWith	back to summary
public ByteIterator interleavedWith(final 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:byte[] the interleaving table Returns:ByteIterator the interleaving byte iterator

interleavedWith

back to summary

public ByteIterator interleavedWith(final 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:byte[]: the interleaving table

Returns:ByteIterator

the interleaving byte iterator

interleavedWith	back to summary
public ByteIterator interleavedWith(final 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:int[] the interleaving table Returns:ByteIterator the interleaving byte iterator

interleavedWith

back to summary

public ByteIterator interleavedWith(final 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:int[]: the interleaving table

Returns:ByteIterator

the interleaving byte iterator

limitedTo	back to summary
public final ByteIterator limitedTo(final 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:int the number of bytes Returns:ByteIterator the limited byte iterator

limitedTo

back to summary

public final ByteIterator limitedTo(final 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:int: the number of bytes

Returns:ByteIterator

the limited byte iterator

next back to summary

next	back to summary
public abstract int next() throws NoSuchElementException Redeclares org.wildfly.common.iteration.BiDirIntIterator.next. Get the next byte. Returns:int the next byte Exceptions NoSuchElementException: if `hasNext()` returns `false`

public abstract int next() throws NoSuchElementException

Redeclares org.wildfly.common.iteration.BiDirIntIterator.next.

Get the next byte.

Returns:int

the next byte

Exceptions

NoSuchElementException:: if hasNext() returns false

ofByteBuffer back to summary

ofByteBuffer	back to summary
public static ByteIterator ofByteBuffer(ByteBuffer buffer) Get a byte iterator for a byte buffer. The buffer's position is kept up to date with the number of bytes consumed by the iterator. The iterator cannot be moved before the position that the buffer had when the iterator was constructed (this position is considered the zero offset). Parameters buffer:ByteBuffer the byte buffer (must not be `null`) Returns:ByteIterator the byte iterator (not `null`)

public static ByteIterator ofByteBuffer(ByteBuffer buffer)

Get a byte iterator for a byte buffer. The buffer's position is kept up to date with the number of bytes consumed by the iterator. The iterator cannot be moved before the position that the buffer had when the iterator was constructed (this position is considered the zero offset).

Parameters

buffer:ByteBuffer: the byte buffer (must not be null)

Returns:ByteIterator

the byte iterator (not null)

ofBytes	back to summary
public static ByteIterator ofBytes(final byte... bytes) Get a byte iterator for a byte array. Parameters bytes:byte[] the array Returns:ByteIterator the byte iterator

ofBytes

back to summary

public static ByteIterator ofBytes(final byte... bytes)

Get a byte iterator for a byte array.

Parameters

bytes:byte[]: the array

Returns:ByteIterator

the byte iterator

ofBytes	back to summary
public static ByteIterator ofBytes(final byte[] bytes, final int offs, final int len) Get a byte iterator for a byte array. Parameters bytes:byte[] the array offs:int the array offset len:int the number of bytes to include Returns:ByteIterator the byte iterator

ofBytes

back to summary

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

Get a byte iterator for a byte array.

Parameters