net.markenwerk.commons.iterators

Class CharacterArrayIterator

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.AbstractProtectedBidirectionalIterator<Payload>

net.markenwerk.commons.iterators.AbstractIndexedIterator<Character>

net.markenwerk.commons.iterators.CharacterArrayIterator

All Implemented Interfaces:

Iterator<Character>, BidirectionalIterator<Character>, ProtectedBidirectionalIterator<Character>, ProtectedIterator<Character>

public final class CharacterArrayIterator
extends AbstractIndexedIterator<Character>

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

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.

Method Summary

Modifier and Type	Method and Description
Character	get(int index) Returns the payload value at the given index.

Methods inherited from class net.markenwerk.commons.iterators.AbstractIndexedIterator

hasNext, hasPrevious, next, previous

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

CharacterArrayIterator

public CharacterArrayIterator(char... array)
                       throws IllegalArgumentException

Creates a new CharacterArrayIterator.

Parameters:

array - The char[] to iterate over.

Throws:

IllegalArgumentException - If the given char[] is null.

Method Detail

get

public Character get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Character>

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.