org.joda.primitives.iterator.impl

Class ArrayCharIterator

java.lang.Object

org.joda.primitives.iterator.impl.ArrayCharIterator

All Implemented Interfaces:

Iterator<Character>, CharIterator, PrimitiveIterator<Character>

public class ArrayCharIterator
extends Object
implements CharIterator

An iterator over an array of char values.

This class implements Iterator allowing seamless integration with other APIs.

The iterator can be reset to the start if required. It is unmodifiable and remove() is unsupported.

Since:

1.0

Version:

CODE GENERATED

Author:

Stephen Colebourne, Jason Tiscione

Field Summary

Fields

Modifier and Type	Field and Description
protected char[]	array The array to iterate over
protected int	cursor Cursor position

Constructor Summary

Constructors

Constructor and Description
ArrayCharIterator(char[] array) Constructs an iterator over an array of char values.

Method Summary

Methods

Modifier and Type	Method and Description
static ArrayCharIterator	copyOf(char[] array) Creates an iterator over a copy of an array of char values.
boolean	hasNext()
boolean	isModifiable() Checks whether the iterator can currently be modified.
boolean	isResettable() Checks whether the iterator can be reset.
Character	next()
char	nextChar() Gets the next value from the iterator
void	remove()
void	reset() Resets the iterator back to its initial state (optional operation).

Methods inherited from class java.lang.Object

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

Field Detail

array

protected final char[] array

The array to iterate over

cursor

protected int cursor

Cursor position

Constructor Detail

ArrayCharIterator

public ArrayCharIterator(char[] array)

Constructs an iterator over an array of char values.

The array is assigned internally, thus the caller holds a reference to the internal state of the returned iterator. It is not recommended to modify the state of the array after construction.

Parameters:

array - the array to iterate over, must not be null

Throws:

IllegalArgumentException - if the array is null

Method Detail

copyOf

public static ArrayCharIterator copyOf(char[] array)

Creates an iterator over a copy of an array of char values.

The specified array is copied, making this class effectively immutable. Note that the class is not final thus it is not truly immutable.

Parameters:

array - the array to iterate over, must not be null

Throws:

IllegalArgumentException - if the array is null

isModifiable

public boolean isModifiable()

Description copied from interface: PrimitiveIterator

Checks whether the iterator can currently be modified.

Specified by:

isModifiable in interface PrimitiveIterator<Character>

Returns:

true if the modification methods of the iterator can be used

isResettable

public boolean isResettable()

Description copied from interface: PrimitiveIterator

Checks whether the iterator can be reset.

Specified by:

isResettable in interface PrimitiveIterator<Character>

Returns:

true if the object can be reset

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Character>

nextChar

public char nextChar()

Description copied from interface: CharIterator

Gets the next value from the iterator

Specified by:

nextChar in interface CharIterator

Returns:

the next available value

next

public Character next()

Specified by:

next in interface Iterator<Character>

remove

public void remove()

Specified by:

remove in interface Iterator<Character>

reset

public void reset()

Description copied from interface: PrimitiveIterator

Resets the iterator back to its initial state (optional operation).

Specified by:

reset in interface PrimitiveIterator<Character>