org.apache.commons.collections.iterators

Class ObjectArrayIterator

public class ObjectArrayIterator extends Object implements Iterator, ResettableIterator

An Iterator over an array of objects.

This iterator does not support ObjectArrayIterator, as the object array cannot be structurally modified.

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

Since: Commons Collections 3.0

Version: $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author: James Strachan Mauricio S. Moura Michael A. Smith Neil O'Toole Stephen Colebourne Phil Steitz

Field Summary
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

Constructor Summary
	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.

Method Summary
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.

Field Detail

array

protected Object[] array

The array

endIndex

protected int endIndex

The end index to loop to

index

protected int index

The current iterator index

startIndex

protected int startIndex

The start index to loop from

Constructor Detail

ObjectArrayIterator

public ObjectArrayIterator()

Constructor for use with setArray.

Using this constructor, the iterator is equivalent to an empty iterator until ObjectArrayIterator is called to establish the array to iterate over.

ObjectArrayIterator

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

ObjectArrayIterator

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

ObjectArrayIterator

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

Method Detail

getArray

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 ObjectArrayIterator has never been called with a valid array.