org.apache.commons.collections.iterators

Class ObjectArrayIterator

Implemented Interfaces:
Iterator, ResettableIterator
Known Direct Subclasses:
ObjectArrayListIterator

public class ObjectArrayIterator
extends java.lang.Object
implements Iterator, ResettableIterator

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.

Version:
$Revision: 1.12 $ $Date: 2004/02/18 00:59:50 $
Authors:
James Strachan
Mauricio S. Moura
Michael A. Smith
Neil O'Toole
Stephen Colebourne
Phil Steitz
Since:
Commons Collections 3.0

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(array[] , int start)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.
ObjectArrayIterator(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 Details

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 Details

ObjectArrayIterator

public ObjectArrayIterator()

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

ObjectArrayIterator

public ObjectArrayIterator(array[] ,
                           int start)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.
Parameters:
start - the index to start iterating at

ObjectArrayIterator

public ObjectArrayIterator(array[] ,
                           int start,
                           int end)
Construct an ObjectArrayIterator that will iterate over a range of values in the specified array.
Parameters:
start - the index to start iterating at
end - the index (exclusive) to finish iterating at

Method Details

getArray

public Object[] getArray()
Gets the array that this iterator is iterating over.

getEndIndex

public int getEndIndex()
Gets the end index to loop to.
Returns:
the end index

getStartIndex

public int getStartIndex()
Gets the start index to loop from.
Returns:
the start index

hasNext

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

next

public Object next()
Returns the next element in the array.
Returns:
the next element in the array

remove

public void remove()
Throws UnsupportedOperationException.

reset

public void reset()
Resets the iterator back to the start index.
Specified by:
reset in interface ResettableIterator

setArray

public void setArray(Object[] array)
Parameters:
array - the array that the iterator should iterate over

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.