org.apache.commons.collections.iterators
Class SingletonIterator

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

All Implemented Interfaces:

java.util.Iterator

Direct Known Subclasses:

SingletonIterator

public class SingletonIterator

extends java.lang.Object

implements java.util.Iterator

SingletonIterator is an Iterator over a single object instance.

Since:

2.0

Version:

$Revision: 1.2.2.1 $

Author:

James Strachan, Stephen Colebourne

Constructor Summary

SingletonIterator(java.lang.Object object)
Constructs a new SingletonIterator.

Method Summary

boolean	hasNext() Is another object available from the iterator.
java.lang.Object	next() Get the next object from the iterator.
void	remove() Remove always throws UnsupportedOperationException.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingletonIterator

public SingletonIterator(java.lang.Object object)

Constructs a new SingletonIterator.

Parameters:

object - the single object to return from the iterator

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.

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if the single object hasn't been returned yet

next

public java.lang.Object next()

Get the next object from the iterator.

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

Specified by:

next in interface java.util.Iterator

Returns:

the single object

Throws:

java.util.NoSuchElementException - if the single object has already been returned

remove

public void remove()

Remove always throws UnsupportedOperationException.

Specified by:

remove in interface java.util.Iterator

Throws:

java.lang.UnsupportedOperationException - always