net.markenwerk.commons.iterators

Class CharacterArrayIterator

java.lang.Object

net.markenwerk.commons.iterators.CharacterArrayIterator

All Implemented Interfaces:

Iterator<Character>

public final class CharacterArrayIterator
extends Object
implements Iterator<Character>

A CharacterArrayIterator is an Iterator that iterates over a given char[].

Calling remove() sets the array to 0 at the index that corresponds to the last value returned by next().

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CharacterArrayIterator(char[] array) Creates a new CharacterArrayIterator that iterates over the given char[].
CharacterArrayIterator(char[] array, char replacement) Creates a new CharacterArrayIterator that iterates over the given char[].

Method Summary

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

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

Constructor Detail

CharacterArrayIterator

public CharacterArrayIterator(char[] array)
                       throws IllegalArgumentException

Creates a new CharacterArrayIterator that iterates over the given char[].

If the given char[] is null, the new CharacterArrayIterator will behave, as if an empty char[] has been given.

Parameters:

array - The char[] to iterate over.

Throws:

IllegalArgumentException - If the given char[] is null.

CharacterArrayIterator

public CharacterArrayIterator(char[] array,
                              char replacement)
                       throws IllegalArgumentException

Creates a new CharacterArrayIterator that iterates over the given char[].

If the given char[] is null, the new CharacterArrayIterator will behave, as if an empty char[] has been given.

Parameters:

array - The char[] to iterate over.

replacement - The value to replace removed values with.

Throws:

IllegalArgumentException - If the given char[] is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Character>

next

public Character next()

Specified by:

next in interface Iterator<Character>

remove

public void remove()

Specified by:

remove in interface Iterator<Character>