Class ArrayIterator<E>
java.lang.Object
org.apache.commons.collections4.iterators.ArrayIterator<E>
- Type Parameters:
E- the type of elements returned by this iterator.
- All Implemented Interfaces:
Iterator<E>,ResettableIterator<E>
- Direct Known Subclasses:
ArrayListIterator
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.
- Since:
- 1.0
-
Constructor Summary
ConstructorsConstructorDescriptionArrayIterator(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) Constructs an ArrayIterator that will iterate over a range of values in the specified array. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcheckBound(int bound, int len, String type) Checks whether the index is valid or not.getArray()Gets the array that this iterator is iterating over.intGets the end index to loop to.intGets the start index to loop from.booleanhasNext()Returns true if there are more elements to return from the array.next()Returns the next element in the array.voidremove()ThrowsUnsupportedOperationException.voidreset()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, waitMethods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
ArrayIterator
Constructs an ArrayIterator that will iterate over the values in the specified array.- Parameters:
array- the array to iterate over.- Throws:
IllegalArgumentException- ifarrayis not an array.NullPointerException- ifarrayisnull
-
ArrayIterator
Constructs an ArrayIterator that will iterate over the values in the specified array from a specific start index.- Parameters:
array- the array to iterate over.startIndex- the index to start iterating at.- Throws:
IllegalArgumentException- ifarrayis not an array.NullPointerException- ifarrayisnullIndexOutOfBoundsException- if the index is invalid
-
ArrayIterator
Constructs an ArrayIterator that will iterate over a range of values in the specified array.- Parameters:
array- the array to iterate over.startIndex- the index to start iterating at.endIndex- the index to finish iterating at.- Throws:
IllegalArgumentException- ifarrayis not an array.NullPointerException- ifarrayisnullIndexOutOfBoundsException- if either index is invalid
-
-
Method Details
-
checkBound
Checks whether the index is valid or not.- Parameters:
bound- the index to checklen- the length of the arraytype- the index type (for error messages)- Throws:
IndexOutOfBoundsException- if the index is invalid
-
getArray
-
getEndIndex
-
getStartIndex
-
hasNext
-
next
-
remove
ThrowsUnsupportedOperationException.- Specified by:
removein interfaceIterator<E>- Throws:
UnsupportedOperationException- always
-
reset
Resets the iterator back to the start index.- Specified by:
resetin interfaceResettableIterator<E>
-