Class ArrayListIterator<E>
java.lang.Object
org.apache.commons.collections4.iterators.ArrayIterator<E>
org.apache.commons.collections4.iterators.ArrayListIterator<E>
- Type Parameters:
- E- the type of elements returned by this iterator.
- All Implemented Interfaces:
- Iterator<E>,- ListIterator<E>,- OrderedIterator<E>,- ResettableIterator<E>,- ResettableListIterator<E>
Implements a 
ListIterator over an array.
 
 The array can be either an array of object or of primitives. If you know
 that you have an object array, the ObjectArrayListIterator
 class is a better choice, as it will perform better.
 
 This iterator does not support add(Object) or ArrayIterator.remove(), as the array
 cannot be changed in size. The set(Object) method is supported however.
 
- Since:
- 3.0
- See Also:
- 
Constructor SummaryConstructorsConstructorDescriptionArrayListIterator(Object array) Constructs an ArrayListIterator that will iterate over the values in the specified array.ArrayListIterator(Object array, int startIndex) Constructs an ArrayListIterator that will iterate over the values in the specified array from a specific start index.ArrayListIterator(Object array, int startIndex, int endIndex) Constructs an ArrayListIterator that will iterate over a range of values in the specified array.
- 
Method SummaryModifier and TypeMethodDescriptionvoidThis iterator does not support modification of its backing collection, and so will always throw anUnsupportedOperationExceptionwhen this method is invoked.booleanReturns true if there are previous elements to return from the array.next()Gets the next element from the array.intGets the next index to be retrieved.previous()Gets the previous element from the array.intGets the index of the item to be retrieved ifprevious()is called.voidreset()Resets the iterator back to the start index.voidSets the element under the cursor.Methods inherited from class org.apache.commons.collections4.iterators.ArrayIteratorcheckBound, getArray, getEndIndex, getStartIndex, hasNext, removeMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.IteratorforEachRemainingMethods inherited from interface java.util.ListIteratorhasNext, remove
- 
Constructor Details- 
ArrayListIteratorConstructs an ArrayListIterator that will iterate over the values in the specified array.- Parameters:
- array- the array to iterate over
- Throws:
- IllegalArgumentException- if- arrayis not an array.
- NullPointerException- if- arrayis- null
 
- 
ArrayListIteratorConstructs an ArrayListIterator 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- if- arrayis not an array.
- NullPointerException- if- arrayis- null
- IndexOutOfBoundsException- if the start index is out of bounds
 
- 
ArrayListIteratorConstructs an ArrayListIterator 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 (exclusive) to finish iterating at
- Throws:
- IllegalArgumentException- if- arrayis not an array.
- IndexOutOfBoundsException- if the start or end index is out of bounds
- IllegalArgumentException- if end index is before the start
- NullPointerException- if- arrayis- null
 
 
- 
- 
Method Details- 
addThis iterator does not support modification of its backing collection, and so will always throw anUnsupportedOperationExceptionwhen this method is invoked.- Specified by:
- addin interface- ListIterator<E>
- Parameters:
- o- the element to add
- Throws:
- UnsupportedOperationException- always thrown.
- See Also:
 
- 
hasPreviousReturns true if there are previous elements to return from the array.- Specified by:
- hasPreviousin interface- ListIterator<E>
- Specified by:
- hasPreviousin interface- OrderedIterator<E>
- Returns:
- true if there is a previous element to return
 
- 
nextGets the next element from the array.- Specified by:
- nextin interface- Iterator<E>
- Specified by:
- nextin interface- ListIterator<E>
- Overrides:
- nextin class- ArrayIterator<E>
- Returns:
- the next element
- Throws:
- NoSuchElementException- if there is no next element
 
- 
nextIndexGets the next index to be retrieved.- Specified by:
- nextIndexin interface- ListIterator<E>
- Returns:
- the index of the item to be retrieved next
 
- 
previousGets the previous element from the array.- Specified by:
- previousin interface- ListIterator<E>
- Specified by:
- previousin interface- OrderedIterator<E>
- Returns:
- the previous element
- Throws:
- NoSuchElementException- if there is no previous element
 
- 
previousIndexGets the index of the item to be retrieved ifprevious()is called.- Specified by:
- previousIndexin interface- ListIterator<E>
- Returns:
- the index of the item to be retrieved next
 
- 
resetResets the iterator back to the start index.- Specified by:
- resetin interface- ResettableIterator<E>
- Overrides:
- resetin class- ArrayIterator<E>
 
- 
setSets the element under the cursor.This method sets the element that was returned by the last call to next()ofprevious().Note: ListIteratorimplementations that supportadd()andremove()only allowset()to be called once per call tonext()orprevious(see theListIteratorJavadoc for more details). Since this implementation does not supportadd()orremove(),set()may be called as often as desired.- Specified by:
- setin interface- ListIterator<E>
- Parameters:
- o- the element to set
- Throws:
- IllegalStateException- if- next()or- previous()has not been called before- set(Object)
- See Also:
 
 
-