Class SingletonListIterator<E>
java.lang.Object
org.apache.commons.collections4.iterators.SingletonListIterator<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>
SingletonIterator is an ListIterator over a single
 object instance.- Since:
- 2.1
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd always throwsUnsupportedOperationException.booleanhasNext()Is another object available from the iterator?booleanIs a previous object available from the iterator?next()Gets the next object from the iterator.intReturns the index of the element that would be returned by a subsequent call tonext.previous()Gets the previous object from the iterator.intReturns the index of the element that would be returned by a subsequent call toprevious.voidremove()Remove the object from this iterator.voidreset()Reset the iterator back to the start.voidSets sets the value of the singleton.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.IteratorforEachRemaining
- 
Constructor Details- 
SingletonListIteratorConstructs a newSingletonListIterator.- Parameters:
- object- the single object to return from the iterator
 
 
- 
- 
Method Details- 
addAdd always throwsUnsupportedOperationException.- Specified by:
- addin interface- ListIterator<E>
- Parameters:
- obj- the object to add
- Throws:
- UnsupportedOperationException- always
 
- 
hasNext
- 
hasPreviousIs a previous object available from the iterator?This returns true if the single object has been returned. - Specified by:
- hasPreviousin interface- ListIterator<E>
- Specified by:
- hasPreviousin interface- OrderedIterator<E>
- Returns:
- true if the single object has been returned
 
- 
nextGets the next object from the iterator.This returns the single object if it hasn't been returned yet. - Specified by:
- nextin interface- Iterator<E>
- Specified by:
- nextin interface- ListIterator<E>
- Returns:
- the single object
- Throws:
- NoSuchElementException- if the single object has already been returned
 
- 
nextIndexReturns the index of the element that would be returned by a subsequent call tonext.- Specified by:
- nextIndexin interface- ListIterator<E>
- Returns:
- 0 or 1 depending on current state.
 
- 
previousGets the previous object from the iterator.This returns the single object if it has been returned. - Specified by:
- previousin interface- ListIterator<E>
- Specified by:
- previousin interface- OrderedIterator<E>
- Returns:
- the single object
- Throws:
- NoSuchElementException- if the single object has not already been returned
 
- 
previousIndexReturns the index of the element that would be returned by a subsequent call toprevious. A return value of -1 indicates that the iterator is currently at the start.- Specified by:
- previousIndexin interface- ListIterator<E>
- Returns:
- 0 or -1 depending on current state.
 
- 
removeRemove the object from this iterator.- Specified by:
- removein interface- Iterator<E>
- Specified by:
- removein interface- ListIterator<E>
- Throws:
- IllegalStateException- if the- nextor- previousmethod has not yet been called, or the- removemethod has already been called after the last call to- nextor- previous.
 
- 
resetReset the iterator back to the start.- Specified by:
- resetin interface- ResettableIterator<E>
 
- 
setSets sets the value of the singleton.- Specified by:
- setin interface- ListIterator<E>
- Parameters:
- object- the object to set
- Throws:
- IllegalStateException- if- nexthas not been called or the object has been removed
 
 
-