Class ObjectArrayIterator<E>
java.lang.Object
org.apache.commons.collections4.iterators.ObjectArrayIterator<E>
- Type Parameters:
E- the type of elements returned by this iterator.
- All Implemented Interfaces:
Iterator<E>,ResettableIterator<E>
- Direct Known Subclasses:
ObjectArrayListIterator
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.
- Since:
- 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionObjectArrayIterator(E... array) Constructs an ObjectArrayIterator that will iterate over the values in the specified array.ObjectArrayIterator(E[] array, int start) Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.ObjectArrayIterator(E[] array, int start, int end) Constructs an ObjectArrayIterator that will iterate over a range of values in the specified array. -
Method Summary
Modifier and TypeMethodDescriptionE[]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
-
ObjectArrayIterator
Constructs an ObjectArrayIterator that will iterate over the values in the specified array.- Parameters:
array- the array to iterate over- Throws:
NullPointerException- ifarrayisnull
-
ObjectArrayIterator
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.- Parameters:
array- the array to iterate overstart- the index to start iterating at- Throws:
NullPointerException- ifarrayisnullIndexOutOfBoundsException- if the start index is out of bounds
-
ObjectArrayIterator
Constructs an ObjectArrayIterator that will iterate over a range of values in the specified array.- Parameters:
array- the array to iterate overstart- the index to start iterating atend- the index (exclusive) to finish iterating at- Throws:
IndexOutOfBoundsException- if the start or end index is out of boundsIllegalArgumentException- if end index is before the startNullPointerException- ifarrayisnull
-
-
Method Details
-
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>
-