org.apache.commons.collections.iterators

Class SingletonIterator

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) $

Author: James Strachan Stephen Colebourne Rodney Waldhoff

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
booleanhasNext()
Is another object available from the iterator?
Objectnext()
Get the next object from the iterator.
voidremove()
Remove the object from this iterator.
voidreset()
Reset the iterator to the start.

Constructor Detail

SingletonIterator

public SingletonIterator(Object object)
Constructs a new SingletonIterator where remove is a permitted operation.

Parameters: object the single object to return from the iterator

SingletonIterator

public SingletonIterator(Object object, boolean removeAllowed)
Constructs a new 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

Method Detail

hasNext

public boolean hasNext()
Is another object available from the iterator?

This returns true if the single object hasn't been returned yet.

Returns: true if the single object hasn't been returned yet

next

public Object next()
Get the next object from the iterator.

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

remove

public void remove()
Remove the object from this iterator.

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

reset

public void reset()
Reset the iterator to the start.
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.