com.neeve.lang

Class XByteArrayIterator

java.lang.Object

com.neeve.lang.XByteArrayIterator

All Implemented Interfaces:

XByteIterator

public class XByteArrayIterator
extends Object
implements XByteIterator

An XByteIterator that wraps a byte array.

Constructor Summary

Constructors

Constructor and Description
XByteArrayIterator(byte[] array) Constructs a new array iterator.
XByteArrayIterator(byte[] array, int offset, int length) Constructs a new array iterator.

Method Summary

Modifier and Type	Method and Description
byte[]	array() The array backing this iterator.
boolean	hasNext() Returns true if the iteration has more elements.
int	length() Gets the length of the iterator (the number of elements it returns starting with the offset).
byte	next() Returns the next element in the iteration.
int	offset() Gets the offset into the backing array at which this iterator starts.
void	remove() Remove is not supported for array iterators.
XByteIterator	toFirst() Resets the iterator to the beginning.

Methods inherited from class java.lang.Object

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

Constructor Detail

XByteArrayIterator

public XByteArrayIterator(byte[] array)

Constructs a new array iterator.

Parameters:

array - The array to iterate.

XByteArrayIterator

public XByteArrayIterator(byte[] array,
                          int offset,
                          int length)

Constructs a new array iterator.

Parameters:

array - The backing array.

offset - The offset into the array.

length - The length the number of elements including the offset to iterate.

Method Detail

array

public final byte[] array()

The array backing this iterator.

Returns:

The array backing the iterator.

offset

public final int offset()

Gets the offset into the backing array at which this iterator starts.

Returns:

The backing array offset.

length

public final int length()

Gets the length of the iterator (the number of elements it returns starting with the offset).

Returns:

The length of elements returned from the iterator's offset.

hasNext

public final boolean hasNext()

Description copied from interface: XByteIterator

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface XByteIterator

Returns:

true if the iterator has more elements.

next

public final byte next()

Description copied from interface: XByteIterator

Returns the next element in the iteration.

Specified by:

next in interface XByteIterator

Returns:

the next element in the iteration.

remove

public final void remove()

Remove is not supported for array iterators.

Specified by:

remove in interface XByteIterator

Throws:

UnsupportedOperationException - If called.

toFirst

public final XByteIterator toFirst()

Description copied from interface: XByteIterator

Resets the iterator to the beginning.

Specified by:

toFirst in interface XByteIterator