org.apache.commons.collections.iterators

Class SingletonIterator

Implemented Interfaces:
Iterator, ResettableIterator

public class SingletonIterator
extends java.lang.Object
implements Iterator, ResettableIterator

SingletonIterator is an Iterator over a single object instance.
Version:
$Revision: 1.14 $ $Date: 2004/04/09 22:52:48 $
Authors:
James Strachan
Stephen Colebourne
Rodney Waldhoff
Since:
Commons Collections 2.0

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?

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

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.

Constructor Details

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 Details

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

remove

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

reset

public void reset()
Reset the iterator to the start.
Specified by:
reset in interface ResettableIterator

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.