net.markenwerk.commons.iterators

Class BooleanArrayIterator

java.lang.Object

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

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

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

net.markenwerk.commons.iterators.BooleanArrayIterator

All Implemented Interfaces:

Iterator<Boolean>, BidirectionalIterator<Boolean>, ProtectedBidirectionalIterator<Boolean>, ProtectedIterator<Boolean>

public final class BooleanArrayIterator
extends AbstractIndexedIterator<Boolean>

A BooleanArrayIterator is an AbstractIndexedIterator that iterates over a given boolean[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

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

BooleanArrayIterator

public BooleanArrayIterator(boolean... array)
                     throws IllegalArgumentException

Creates a new BooleanArrayIterator.

Parameters:

array - The boolean[] to iterate over.

Throws:

IllegalArgumentException - If the given boolean[] is null.

Method Detail

get

public Boolean get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Boolean>

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.