net.markenwerk.commons.iterables

Class BooleanArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.BooleanArrayIterable

All Implemented Interfaces:

Iterable<Boolean>, BidirectionalIterable<Boolean>, ProtectedBidirectionalIterable<Boolean>

public final class BooleanArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Boolean>

A BooleanArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given boolean[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
BooleanArrayIterable(boolean... array) Creates a new BooleanArrayIterable.

Method Summary

Modifier and Type	Method and Description
BooleanArrayIterator	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

BooleanArrayIterable

public BooleanArrayIterable(boolean... array)
                     throws IllegalArgumentException

Creates a new BooleanArrayIterable.

Parameters:

array - The boolean[] to iterate over.

Throws:

IllegalArgumentException - If the given boolean[] is null.

Method Detail

iterator

public BooleanArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Boolean>

Specified by:

iterator in interface BidirectionalIterable<Boolean>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Boolean>

Returns:

A ProtectedIterator.