net.sandius.rembulan.util

Interface ByteIterator

All Superinterfaces:

Iterator<Byte>

All Known Implementing Classes:

ArrayByteIterator, CharsetEncoderByteIterator

public interface ByteIterator
extends Iterator<Byte>

An iterator over a sequence of bytes.

This class implements the Iterator interface. However, for performance reasons, it is preferable to use its nextByte() method directly in order to avoid result boxing.

Method Summary

Modifier and Type	Method and Description
byte	nextByte() Returns the next byte from the sequence and increments the byte position.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

nextByte

byte nextByte()

Returns the next byte from the sequence and increments the byte position.

When there is no next byte to be read from the stream, this method throws a NoSuchElementException. Use Iterator.hasNext() to detect this condition.

Returns:

the next byte from the byte stream

Throws:

NoSuchElementException - if there are no more bytes in the stream