Class SingletonListIterator
- java.lang.Object
-
- org.apache.commons.collections.iterators.SingletonListIterator
-
- All Implemented Interfaces:
java.util.Iterator
,java.util.ListIterator
,ResettableIterator
,ResettableListIterator
@Deprecated(since="2021-04-30") public class SingletonListIterator extends java.lang.Object implements java.util.ListIterator, ResettableListIterator
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.SingletonIterator
is anListIterator
over a single object instance.- Since:
- Commons Collections 2.1
-
-
Constructor Summary
Constructors Constructor Description SingletonListIterator(java.lang.Object object)
Deprecated.Constructs a newSingletonListIterator
.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
add(java.lang.Object obj)
Deprecated.Add always throwsUnsupportedOperationException
.boolean
hasNext()
Deprecated.Is another object available from the iterator?boolean
hasPrevious()
Deprecated.Is a previous object available from the iterator?java.lang.Object
next()
Deprecated.Get the next object from the iterator.int
nextIndex()
Deprecated.Returns the index of the element that would be returned by a subsequent call to next.java.lang.Object
previous()
Deprecated.Get the previous object from the iterator.int
previousIndex()
Deprecated.Returns the index of the element that would be returned by a subsequent call to previous.void
remove()
Deprecated.Remove the object from this iterator.void
reset()
Deprecated.Reset the iterator back to the start.void
set(java.lang.Object obj)
Deprecated.Set sets the value of the singleton.
-
-
-
Method Detail
-
hasNext
public boolean hasNext()
Deprecated.Is another object available from the iterator?This returns true if the single object hasn't been returned yet.
- Specified by:
hasNext
in interfacejava.util.Iterator
- Specified by:
hasNext
in interfacejava.util.ListIterator
- Returns:
- true if the single object hasn't been returned yet
-
hasPrevious
public boolean hasPrevious()
Deprecated.Is a previous object available from the iterator?This returns true if the single object has been returned.
- Specified by:
hasPrevious
in interfacejava.util.ListIterator
- Returns:
- true if the single object has been returned
-
nextIndex
public int nextIndex()
Deprecated.Returns the index of the element that would be returned by a subsequent call to next.- Specified by:
nextIndex
in interfacejava.util.ListIterator
- Returns:
- 0 or 1 depending on current state.
-
previousIndex
public int previousIndex()
Deprecated.Returns the index of the element that would be returned by a subsequent call to previous. A return value of -1 indicates that the iterator is currently at the start.- Specified by:
previousIndex
in interfacejava.util.ListIterator
- Returns:
- 0 or -1 depending on current state.
-
next
public java.lang.Object next()
Deprecated.Get the next object from the iterator.This returns the single object if it hasn't been returned yet.
- Specified by:
next
in interfacejava.util.Iterator
- Specified by:
next
in interfacejava.util.ListIterator
- Returns:
- the single object
- Throws:
java.util.NoSuchElementException
- if the single object has already been returned
-
previous
public java.lang.Object previous()
Deprecated.Get the previous object from the iterator.This returns the single object if it has been returned.
- Specified by:
previous
in interfacejava.util.ListIterator
- Returns:
- the single object
- Throws:
java.util.NoSuchElementException
- if the single object has not already been returned
-
remove
public void remove()
Deprecated.Remove the object from this iterator.- Specified by:
remove
in interfacejava.util.Iterator
- Specified by:
remove
in interfacejava.util.ListIterator
- Throws:
java.lang.IllegalStateException
- if the next or previous method has not yet been called, or the remove method has already been called after the last call to next or previous.
-
add
public void add(java.lang.Object obj)
Deprecated.Add always throwsUnsupportedOperationException
.- Specified by:
add
in interfacejava.util.ListIterator
- Throws:
java.lang.UnsupportedOperationException
- always
-
set
public void set(java.lang.Object obj)
Deprecated.Set sets the value of the singleton.- Specified by:
set
in interfacejava.util.ListIterator
- Parameters:
obj
- the object to set- Throws:
java.lang.IllegalStateException
- if next has not been called or the object has been removed
-
reset
public void reset()
Deprecated.Reset the iterator back to the start.- Specified by:
reset
in interfaceResettableIterator
- Specified by:
reset
in interfaceResettableListIterator
-
-