info.aduna.iteration
Class SingletonIteration<E,X extends Exception>

java.lang.Object
  extended by info.aduna.iteration.CloseableIterationBase<E,X>
      extended by info.aduna.iteration.SingletonIteration<E,X>
All Implemented Interfaces:
CloseableIteration<E,X>, Iteration<E,X>
Direct Known Subclasses:
SingletonIterator

public class SingletonIteration<E,X extends Exception>
extends CloseableIterationBase<E,X>

An Iteration that contains exactly one element.


Field Summary
 
Fields inherited from class info.aduna.iteration.CloseableIterationBase
logger
 
Constructor Summary
SingletonIteration(E value)
          Creates a new EmptyIteration.
 
Method Summary
protected  void handleClose()
          Called by CloseableIterationBase.close() when it is called for the first time.
 boolean hasNext()
          Returns true if the iteration has more elements.
 E next()
          Returns the next element in the iteration.
 void remove()
          Removes from the underlying collection the last element returned by the iteration (optional operation).
 
Methods inherited from class info.aduna.iteration.CloseableIterationBase
close, isClosed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SingletonIteration

public SingletonIteration(E value)
Creates a new EmptyIteration.

Method Detail

hasNext

public boolean hasNext()
Description copied from interface: Iteration
Returns true if the iteration has more elements. (In other words, returns true if Iteration.next() would return an element rather than throwing a NoSuchElementException.)

Returns:
true if the iteration has more elements.

next

public E next()
Description copied from interface: Iteration
Returns the next element in the iteration.

Returns:
the next element in the iteration.

remove

public void remove()
Description copied from interface: Iteration
Removes from the underlying collection the last element returned by the iteration (optional operation). This method can be called only once per call to next.


handleClose

protected void handleClose()
                    throws X extends Exception
Description copied from class: CloseableIterationBase
Called by CloseableIterationBase.close() when it is called for the first time. This method is only called once on each iteration. By default, this method does nothing.

Overrides:
handleClose in class CloseableIterationBase<E,X extends Exception>
Throws:
X
X extends Exception


Copyright © 1997-2008 Aduna. All Rights Reserved.