net.pwall.util

Class CharIterator

java.lang.Object

net.pwall.util.CharIterator

All Implemented Interfaces:

Iterator<Character>

public class CharIterator
extends Object
implements Iterator<Character>

An iterator over the characters of a CharSequence (a String, StringBuilder etc.). If the CharSequence provided is mutable, and the contents are changed during the life of the CharIterator, the results are undefined.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
CharIterator(CharSequence seq) Construct a CharIterator over an entire CharSequence.
CharIterator(CharSequence seq, int start, int end) Construct a CharIterator with a given CharSequence, specifying the start and end points.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Character	next()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

CharIterator

public CharIterator(CharSequence seq,
                    int start,
                    int end)

Construct a CharIterator with a given CharSequence, specifying the start and end points.

Parameters:

seq - the CharSequence

start - the start index

end - the end index

Throws:

IndexOutOfBoundsException - if the start or end index is invalid

CharIterator

public CharIterator(CharSequence seq)

Construct a CharIterator over an entire CharSequence.

Parameters:

seq - the CharSequence

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Character>

next

public Character next()

Specified by:

next in interface Iterator<Character>