|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.iterators.ArrayIterator<E>
public class ArrayIterator<E>
Implements an Iterator
over any array.
The array can be either an array of object or of primitives. If you know
that you have an object array, the
ObjectArrayIterator
class is a better choice, as it will perform better.
The iterator implements a reset()
method, allowing the reset of
the iterator back to the start if required.
Constructor Summary | |
---|---|
ArrayIterator(Object array)
Constructs an ArrayIterator that will iterate over the values in the specified array. |
|
ArrayIterator(Object array,
int startIndex)
Constructs an ArrayIterator that will iterate over the values in the specified array from a specific start index. |
|
ArrayIterator(Object array,
int startIndex,
int endIndex)
Construct an ArrayIterator that will iterate over a range of values in the specified array. |
Method Summary | |
---|---|
protected void |
checkBound(int bound,
int len,
String type)
Checks whether the index is valid or not. |
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. |
E |
next()
Returns the next element in the array. |
void |
remove()
Throws UnsupportedOperationException . |
void |
reset()
Resets the iterator back to the start index. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ArrayIterator(Object array)
array
- the array to iterate over.
IllegalArgumentException
- if array
is not an array.
NullPointerException
- if array
is null
public ArrayIterator(Object array, int startIndex)
array
- the array to iterate over.startIndex
- the index to start iterating at.
IllegalArgumentException
- if array
is not an array.
NullPointerException
- if array
is null
IndexOutOfBoundsException
- if the index is invalidpublic ArrayIterator(Object array, int startIndex, int endIndex)
array
- the array to iterate over.startIndex
- the index to start iterating at.endIndex
- the index to finish iterating at.
IllegalArgumentException
- if array
is not an array.
NullPointerException
- if array
is null
IndexOutOfBoundsException
- if either index is invalidMethod Detail |
---|
protected void checkBound(int bound, int len, String type)
bound
- the index to checklen
- the length of the arraytype
- the index type (for error messages)
IndexOutOfBoundsException
- if the index is invalidpublic boolean hasNext()
hasNext
in interface Iterator<E>
public E next()
next
in interface Iterator<E>
NoSuchElementException
- if all the elements in the array
have already been returnedpublic void remove()
UnsupportedOperationException
.
remove
in interface Iterator<E>
UnsupportedOperationException
- alwayspublic Object getArray()
public int getStartIndex()
public int getEndIndex()
public void reset()
reset
in interface ResettableIterator<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |