public class

ObjectArrayIterator

extends Object
implements Iterator<E> ResettableIterator
java.lang.Object
   ↳ org.apache.commons.collections.iterators.ObjectArrayIterator
Known Direct Subclasses

Class Overview

An Iterator over an array of objects.

This iterator does not support remove(), as the object array cannot be structurally modified.

The iterator implements a reset() method, allowing the reset of the iterator back to the start if required.

Summary

Fields
protected Object[] array The array
protected int endIndex The end index to loop to
protected int index The current iterator index
protected int startIndex The start index to loop from
Public Constructors
ObjectArrayIterator()
Constructor for use with setArray.
ObjectArrayIterator(Object[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array.
ObjectArrayIterator(Object[] array, int start)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.
ObjectArrayIterator(Object[] array, int start, int end)
Construct an ObjectArrayIterator that will iterate over a range of values in the specified array.
Public Methods
Object[] getArray()
Gets the array that this iterator is iterating over.
int getEndIndex()
Gets the end index to loop to.
int getStartIndex()
Gets the start index to loop from.
boolean hasNext()
Returns true if there are more elements to return from the array.
Object next()
Returns the next element in the array.
void remove()
Throws UnsupportedOperationException.
void reset()
Resets the iterator back to the start index.
void setArray(Object[] array)
Sets the array that the ArrayIterator should iterate over.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.commons.collections.ResettableIterator

Fields

protected Object[] array

The array

protected int endIndex

The end index to loop to

protected int index

The current iterator index

protected int startIndex

The start index to loop from

Public Constructors

public ObjectArrayIterator ()

Constructor for use with setArray.

Using this constructor, the iterator is equivalent to an empty iterator until setArray(Object[]) is called to establish the array to iterate over.

public ObjectArrayIterator (Object[] array)

Constructs an ObjectArrayIterator that will iterate over the values in the specified array.

Parameters
array the array to iterate over
Throws
NullPointerException if array is null

public ObjectArrayIterator (Object[] array, int start)

Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.

Parameters
array the array to iterate over
start the index to start iterating at
Throws
NullPointerException if array is null
IndexOutOfBoundsException if the start index is out of bounds

public ObjectArrayIterator (Object[] array, int start, int end)

Construct an ObjectArrayIterator that will iterate over a range of values in the specified array.

Parameters
array the array to iterate over
start the index to start iterating at
end the index (exclusive) to finish iterating at
Throws
IndexOutOfBoundsException if the start or end index is out of bounds
IllegalArgumentException if end index is before the start
NullPointerException if array is null

Public Methods

public Object[] getArray ()

Gets the array that this iterator is iterating over.

Returns
  • the array this iterator iterates over, or null if the no-arg constructor was used and setArray(Object[]) has never been called with a valid array.

public int getEndIndex ()

Gets the end index to loop to.

Returns
  • the end index

public int getStartIndex ()

Gets the start index to loop from.

Returns
  • the start index

public boolean hasNext ()

Returns true if there are more elements to return from the array.

Returns
  • true if there is a next element to return

public Object next ()

Returns the next element in the array.

Returns
  • the next element in the array
Throws
NoSuchElementException if all the elements in the array have already been returned

public void remove ()

Throws UnsupportedOperationException.

Throws
UnsupportedOperationException always

public void reset ()

Resets the iterator back to the start index.

public void setArray (Object[] array)

Sets the array that the ArrayIterator should iterate over.

This method may only be called once, otherwise an IllegalStateException will occur.

The reset() method can be used to reset the iterator if required.

Parameters
array the array that the iterator should iterate over
Throws
IllegalStateException if the array was set in the constructor
NullPointerException if array is null