com.neeve.lang

Interface XStringIterator

All Superinterfaces:

Iterator<String>, XIterator<String>

All Known Implementing Classes:

XStringArrayIterator, XStringSequence

public interface XStringIterator
extends XIterator<String>

A String based XIterator that provide support for copying the next value into an XString.

Method Summary

Modifier and Type	Method and Description
short	nextInto(long addr, int offset) Copies the next value into the provided memory address This call has the same semantics as Iterator.next() except that the iterator implementation may be able to avoid allocating a String object.
short	nextInto(XString to) Copies the next value into the provided XString.
int	nextLength() Returns the length of the next string Equivalent to invoking nextLength(true)
int	nextLength(boolean advance) Returns the length of the next string

Methods inherited from interface com.neeve.lang.XIterator

toFirst

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

nextLength

int nextLength(boolean advance)

Returns the length of the next string

Parameters:

Indicates - whether to advance to the next string or not

Returns:

Returns the length of the next field

Throws:

NoSuchElementException - iteration has no more elements.

nextLength

int nextLength()

Returns the length of the next string

Equivalent to invoking nextLength(true)

Returns:

Returns the length of the next field

Throws:

NoSuchElementException - iteration has no more elements.

nextInto

short nextInto(XString to)

Copies the next value into the provided XString.

This call has the same semantics as Iterator.next() except that the iterator implementation may be able to avoid allocating a String object.

Returns:

Returns the number of bytes copied

Throws:

NoSuchElementException - iteration has no more elements.

nextInto

short nextInto(long addr,
               int offset)

Copies the next value into the provided memory address

This call has the same semantics as Iterator.next() except that the iterator implementation may be able to avoid allocating a String object.

Returns:

Returns the number of bytes copied

Throws:

NoSuchElementException - iteration has no more elements.