org.joda.primitives.listiterator.impl
Class ArrayBooleanListIterator

java.lang.Object
  org.joda.primitives.listiterator.impl.ArrayBooleanListIterator

All Implemented Interfaces:

Iterator<Boolean>, ListIterator<Boolean>, BooleanIterator, PrimitiveIterator<Boolean>, BooleanListIterator, PrimitiveListIterator<Boolean>

public class ArrayBooleanListIterator
extends Object
implements BooleanListIterator

An iterator over an array of boolean values.

This class implements ListIterator allowing seamless integration with other APIs.

The iterator can be reset to the start if required. add() and remove() are unsupported, but set() is supported.

Since:

1.0

Version:

CODE GENERATED

Author:

Stephen Colebourne, Jason Tiscione

Field Summary

protected boolean[]	array The array to iterate over
protected int	cursor Cursor position
protected int	last Last returned position

Constructor Summary

ArrayBooleanListIterator(boolean[] array)
Constructs an iterator over an array of boolean values.

Method Summary

void	add(boolean value) Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).
void	add(Boolean value)
static ArrayBooleanListIterator	copyOf(boolean[] array) Creates an iterator over a copy of an array of boolean values.
boolean	hasNext()
boolean	hasPrevious()
boolean	isModifiable() Checks whether the iterator can currently be modified.
boolean	isResettable() Checks whether the iterator can be reset.
Boolean	next()
boolean	nextBoolean() Gets the next value from the iterator
int	nextIndex()
Boolean	previous()
boolean	previousBoolean() Gets the previous value from the iterator.
int	previousIndex()
void	remove()
void	reset() Resets the iterator back to its initial state (optional operation).
void	set(boolean value) Sets the last retrieved value from the iterator (optional operation).
void	set(Boolean value)

Methods inherited from class java.lang.Object

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

Field Detail

array

protected final boolean[] array

The array to iterate over

cursor

protected int cursor

Cursor position

last

protected int last

Last returned position

Constructor Detail

ArrayBooleanListIterator

public ArrayBooleanListIterator(boolean[] array)

Constructs an iterator over an array of boolean values.

The array is assigned internally, thus the caller holds a reference to the internal state of the returned iterator. It is not recommended to modify the state of the array after construction.

Parameters:

array - the array to iterate over, must not be null

Throws:

IllegalArgumentException - if the array is null

Method Detail

copyOf

public static ArrayBooleanListIterator copyOf(boolean[] array)

Creates an iterator over a copy of an array of boolean values.

The specified array is copied, ensuring the original data is unaltered. Note that the class is not immutable due to the set methods.

Parameters:

array - the array to iterate over, must not be null

Throws:

IllegalArgumentException - if the array is null

isModifiable

public boolean isModifiable()

Description copied from interface: PrimitiveIterator

Checks whether the iterator can currently be modified.

Specified by:

isModifiable in interface PrimitiveIterator<Boolean>

Returns:

true if the modification methods of the iterator can be used

isResettable

public boolean isResettable()

Description copied from interface: PrimitiveIterator

Checks whether the iterator can be reset.

Specified by:

isResettable in interface PrimitiveIterator<Boolean>

Returns:

true if the object can be reset

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Boolean>

Specified by:

hasNext in interface ListIterator<Boolean>

nextIndex

public int nextIndex()

Specified by:

nextIndex in interface ListIterator<Boolean>

nextBoolean

public boolean nextBoolean()

Description copied from interface: BooleanIterator

Gets the next value from the iterator

Specified by:

nextBoolean in interface BooleanIterator

Returns:

the next available value

next

public Boolean next()

Specified by:

next in interface Iterator<Boolean>

Specified by:

next in interface ListIterator<Boolean>

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface ListIterator<Boolean>

previousIndex

public int previousIndex()

Specified by:

previousIndex in interface ListIterator<Boolean>

previousBoolean

public boolean previousBoolean()

Description copied from interface: BooleanListIterator

Gets the previous value from the iterator.

Specified by:

previousBoolean in interface BooleanListIterator

Returns:

the previous available value

previous

public Boolean previous()

Specified by:

previous in interface ListIterator<Boolean>

add

public void add(boolean value)

Description copied from interface: BooleanListIterator

Adds the specified value to the list underlying the iterator at the current iteration index (optional operation).

Specified by:

add in interface BooleanListIterator

Parameters:

value - the value to add

add

public void add(Boolean value)

Specified by:

add in interface ListIterator<Boolean>

remove

public void remove()

Specified by:

remove in interface Iterator<Boolean>

Specified by:

remove in interface ListIterator<Boolean>

set

public void set(boolean value)

Description copied from interface: BooleanListIterator

Sets the last retrieved value from the iterator (optional operation).

Specified by:

set in interface BooleanListIterator

Parameters:

value - the value to set

set

public void set(Boolean value)

Specified by:

set in interface ListIterator<Boolean>

reset

public void reset()

Description copied from interface: PrimitiveIterator

Resets the iterator back to its initial state (optional operation).

Specified by:

reset in interface PrimitiveIterator<Boolean>