JAPI 0.9.0
Yet another Java API
API Documentation

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

java.lang.Object
  extended by net.sf.japi.util.EnumerationIterator<T>
All Implemented Interfaces:
Iterable<T>, Iterator<T>

public class EnumerationIterator<T>
extends Object
implements Iterable<T>, Iterator<T>

Combined Iterator/Iterable proxy for enumerations. Instances are not reusable.

Author:
Christian Hujer

Constructor Summary
EnumerationIterator(Enumeration<T> enumeration)
          Create an Iterable based on an Enumeration, useful for foreach-loops.
 
Method Summary
 boolean hasNext()
          Returns true if the iteration has more elements.
 Iterator<T> iterator()
          Returns an iterator over a set of elements of type T.
 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

EnumerationIterator

public EnumerationIterator(Enumeration<T> enumeration)
Create an Iterable based on an Enumeration, useful for foreach-loops.

Parameters:
enumeration - Enumeration to iterate over
Method Detail

iterator

public Iterator<T> iterator()
Returns an iterator over a set of elements of type T.

Specified by:
iterator in interface Iterable<T>
Returns:
an Iterator.

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>

JAPI
Yet another Java API
API Documentation

© 2005-2006 Christian Hujer. All rights reserved. See copyright