org.apache.commons.collections.iterators
Class ObjectArrayIterator
java.lang.Object
org.apache.commons.collections.iterators.ObjectArrayIterator
- Iterator, ResettableIterator
public class ObjectArrayIterator
extends java.lang.Object
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.
$Revision: 1.12 $ $Date: 2004/02/18 00:59:50 $- James Strachan
- Mauricio S. Moura
- Michael A. Smith
- Neil O'Toole
- Stephen Colebourne
- Phil Steitz
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
|
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.
|
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.
|
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
ObjectArrayIterator
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.
ObjectArrayIterator
public ObjectArrayIterator(Object[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the
specified array.
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.
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.
start
- the index to start iterating atend
- the index (exclusive) to finish iterating at
getArray
public Object[] getArray()
Gets the array that this iterator is iterating over.
- 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.
getEndIndex
public int getEndIndex()
Gets the end index to loop to.
getStartIndex
public int getStartIndex()
Gets the start index to loop from.
hasNext
public boolean hasNext()
Returns true if there are more elements to return from the array.
- true if there is a next element to return
next
public Object next()
Returns the next element in the array.
- the next element in the array
remove
public void remove()
Throws UnsupportedOperationException
.
setArray
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.
array
- the array that the iterator should iterate over
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.