org.apache.commons.collections.iterators

Class SingletonIterator

java.lang.Object
|
+--org.apache.commons.collections.iterators.SingletonIterator

All Implemented Interfaces:
Iterator, ResettableIterator

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

SingletonIterator is an Iterator over a single object instance.

Since:

Commons Collections 2.0

Authors:

James Strachan
Stephen Colebourne
Rodney Waldhoff

Constructor Summary

SingletonIterator(Object object)

Constructs a new SingletonIterator.

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.

Parameters:

object - the single object to return from the iterator

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

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:

- if the single object has already been returned

remove
public void remove()
 Remove the object from this iterator.
Throws:
 - 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.
reset
public void reset()
 Reset the iterator to the start.
Generated on
  February 15, 2004
  by GNU Classpath Tools (Gjdoc XmlDoclet 0.6.1).