net.markenwerk.commons.iterables

Class CharacterArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.CharacterArrayIterable

All Implemented Interfaces:

Iterable<Character>, BidirectionalIterable<Character>, ProtectedBidirectionalIterable<Character>

public final class CharacterArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Character>

A CharacterArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given char[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CharacterArrayIterable(char... array) Creates a new CharacterArrayIterable.

Method Summary

Modifier and Type	Method and Description
CharacterArrayIterator	iterator() Returns a ProtectedIterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CharacterArrayIterable

public CharacterArrayIterable(char... array)
                       throws IllegalArgumentException

Creates a new CharacterArrayIterable.

Parameters:

array - The char[] to iterate over.

Throws:

IllegalArgumentException - If the given char[] is null.

Method Detail

iterator

public CharacterArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in interface BidirectionalIterable<Character>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Character>

Returns:

A ProtectedIterator.