com.neeve.lang

Class XCharArrayIterator

java.lang.Object

com.neeve.lang.XCharArrayIterator

All Implemented Interfaces:

XCharIterator

public class XCharArrayIterator
extends Object
implements XCharIterator

An XCharIterator that wraps a char array.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
char[]	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).
char	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.
XCharIterator	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

XCharArrayIterator

public XCharArrayIterator(char[] array)

Constructs a new array iterator.

Parameters:

array - The array to iterate.

XCharArrayIterator

public XCharArrayIterator(char[] 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 char[] 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: XCharIterator

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 XCharIterator

Returns:

true if the iterator has more elements.

next

public final char next()

Description copied from interface: XCharIterator

Returns the next element in the iteration.

Specified by:

next in interface XCharIterator

Returns:

the next element in the iteration.

remove

public final void remove()

Remove is not supported for array iterators.

Specified by:

remove in interface XCharIterator

Throws:

UnsupportedOperationException - If called.

toFirst

public final XCharIterator toFirst()

Description copied from interface: XCharIterator

Resets the iterator to the beginning.

Specified by:

toFirst in interface XCharIterator