com.aliasi.util
Class Iterators.Singleton<E>

java.lang.Object
  com.aliasi.util.Iterators.Singleton<E>

All Implemented Interfaces:

Iterator<E>

Enclosing class:

Iterators

public static class Iterators.Singleton<E>
extends Object
implements Iterator<E>

An Iterator.Singleton is an iterator over a singleton object.

Since:

LingPipe2.0

Version:

3.0

Author:

Bob Carpenter

Constructor Summary

Iterators.Singleton(E member)
Construct a singleton iterator that returns the specified object.

Method Summary

boolean	hasNext() Returns true if the single member has not already been returned.
E	next() Returns the singleton member if it has not yet been returned, otherwise throw an exception.
void	remove() Throws an unsupported operation exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

Iterators.Singleton

public Iterators.Singleton(E member)

Construct a singleton iterator that returns the specified object.

Parameters:

member - Single member over which to iterate.

Method Detail

hasNext

public boolean hasNext()

Returns true if the single member has not already been returned.

Specified by:

hasNext in interface Iterator<E>

Returns:

true if the single member has not already been returned.

next

public E next()

Returns the singleton member if it has not yet been returned, otherwise throw an exception.

Specified by:

next in interface Iterator<E>

Returns:

Singleton member if it has not yet been returned.

Throws:

NoSuchElementException - If the singleton member has already been returned and no elements remain.

remove

public void remove()

Throws an unsupported operation exception.

Specified by:

remove in interface Iterator<E>

Throws:

UnsupportedOperationException - Whenver called.