net.sf.japi.util
Class EmptyIterator<T>

java.lang.Object
  net.sf.japi.util.EmptyIterator<T>

All Implemented Interfaces:

Iterator<T>

public class EmptyIterator<T>
extends Object
implements Iterator<T>

An iterator that never returns elements and thus is always empty.

Author:

Christian Hujer

Constructor Summary

EmptyIterator()
Create an Empty Iterator.

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
T	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyIterator

public EmptyIterator()

Create an Empty Iterator. Please note that this class does not hold any state. The Constructor only exists for convenient Generics programming. It makes sense to store an empty iterator somewhere and reuse it, eventually even in a static final variable.

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<T>

Returns:

true if the iterator has more elements.

next

public T next()
       throws NoSuchElementException

Returns the next element in the iteration. Calling this method repeatedly until the Iterator.hasNext() method returns false will return each element in the underlying collection exactly once.

Specified by:

next in interface Iterator<T>

Returns:

the next element in the iteration.

Throws:

NoSuchElementException - iteration has no more elements.

remove

public void remove()

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface Iterator<T>