net.markenwerk.commons.iterators

Class BooleanArrayIterator

java.lang.Object

net.markenwerk.commons.iterators.BooleanArrayIterator

All Implemented Interfaces:

Iterator<Boolean>

public final class BooleanArrayIterator
extends Object
implements Iterator<Boolean>

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

Calling remove() sets the array to false at the index that corresponds to the last value returned by next().

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
BooleanArrayIterator(boolean[] values) Creates a new BooleanArrayIterator that iterates over the given boolean[].
BooleanArrayIterator(boolean[] values, boolean replacement) Creates a new BooleanArrayIterator that iterates over the given boolean[].

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Boolean	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

BooleanArrayIterator

public BooleanArrayIterator(boolean[] values)

Creates a new BooleanArrayIterator that iterates over the given boolean[].

If the given boolean[] is null, the new BooleanArrayIterator will behave, as if an empty boolean[] has been given.

Parameters:

values - The boolean[] to iterate over.

BooleanArrayIterator

public BooleanArrayIterator(boolean[] values,
                            boolean replacement)

Creates a new BooleanArrayIterator that iterates over the given boolean[].

If the given boolean[] is null, the new BooleanArrayIterator will behave, as if an empty boolean[] has been given.

Parameters:

values - The boolean[] to iterate over.

replacement - The value to replace removed values with.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Boolean>

next

public Boolean next()

Specified by:

next in interface Iterator<Boolean>

remove

public void remove()

Specified by:

remove in interface Iterator<Boolean>