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 Summary
Constructors -
Method Summary
Modifier 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
SingletonListIterator
Constructs a newSingletonListIterator.- Parameters:
object- the single object to return from the iterator
-
-
Method Details
-
add
Add always throwsUnsupportedOperationException.- Specified by:
addin interfaceListIterator<E>- Parameters:
obj- the object to add- Throws:
UnsupportedOperationException- always
-
hasNext
-
hasPrevious
Is a previous object available from the iterator?This returns true if the single object has been returned.
- Specified by:
hasPreviousin interfaceListIterator<E>- Specified by:
hasPreviousin interfaceOrderedIterator<E>- Returns:
- true if the single object has been returned
-
next
Gets the next object from the iterator.This returns the single object if it hasn't been returned yet.
- Specified by:
nextin interfaceIterator<E>- Specified by:
nextin interfaceListIterator<E>- Returns:
- the single object
- Throws:
NoSuchElementException- if the single object has already been returned
-
nextIndex
Returns the index of the element that would be returned by a subsequent call tonext.- Specified by:
nextIndexin interfaceListIterator<E>- Returns:
- 0 or 1 depending on current state.
-
previous
Gets the previous object from the iterator.This returns the single object if it has been returned.
- Specified by:
previousin interfaceListIterator<E>- Specified by:
previousin interfaceOrderedIterator<E>- Returns:
- the single object
- Throws:
NoSuchElementException- if the single object has not already been returned
-
previousIndex
Returns 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 interfaceListIterator<E>- Returns:
- 0 or -1 depending on current state.
-
remove
Remove the object from this iterator.- Specified by:
removein interfaceIterator<E>- Specified by:
removein interfaceListIterator<E>- Throws:
IllegalStateException- if thenextorpreviousmethod has not yet been called, or theremovemethod has already been called after the last call tonextorprevious.
-
reset
Reset the iterator back to the start.- Specified by:
resetin interfaceResettableIterator<E>
-
set
Sets sets the value of the singleton.- Specified by:
setin interfaceListIterator<E>- Parameters:
object- the object to set- Throws:
IllegalStateException- ifnexthas not been called or the object has been removed
-