org.apache.commons.collections.iterators
public class SingletonIterator extends Object implements Iterator, ResettableIterator
SingletonIterator
is an Iterator over a single
object instance.
Since: Commons Collections 2.0
Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
Constructor Summary | |
---|---|
SingletonIterator(Object object)
Constructs a new SingletonIterator where remove
is a permitted operation.
| |
SingletonIterator(Object object, boolean removeAllowed)
Constructs a new SingletonIterator optionally choosing if
remove is a permitted operation.
|
Method Summary | |
---|---|
boolean | hasNext()
Is another object available from the iterator?
|
Object | next()
Get the next object from the iterator.
|
void | remove()
Remove the object from this iterator.
|
void | reset()
Reset the iterator to the start. |
SingletonIterator
where remove
is a permitted operation.
Parameters: object the single object to return from the iterator
SingletonIterator
optionally choosing if
remove
is a permitted operation.
Parameters: object the single object to return from the iterator removeAllowed true if remove is allowed
Since: Commons Collections 3.1
This returns true if the single object hasn't been returned yet.
Returns: true if the single object hasn't been returned yet
This returns the single object if it hasn't been returned yet.
Returns: the single object
Throws: NoSuchElementException if the single object has already been returned
Throws: IllegalStateException if the next method has not yet been called, or the remove method has already been called after the last call to the next method. UnsupportedOperationException if remove is not supported