org.apache.commons.collections.iterators

Class EnumerationIterator

public class EnumerationIterator extends Object implements Iterator

Adapter to make Enumeration Enumeration instances appear to be Iterator Iterator instances.

Since: Commons Collections 1.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: James Strachan Daniel Rall

Constructor Summary
EnumerationIterator()
Constructs a new EnumerationIterator that will not function until setEnumeration is called.
EnumerationIterator(Enumeration enumeration)
Constructs a new EnumerationIterator that provides an iterator view of the given enumeration.
EnumerationIterator(Enumeration enumeration, Collection collection)
Constructs a new EnumerationIterator that will remove elements from the specified collection.
Method Summary
EnumerationgetEnumeration()
Returns the underlying enumeration.
booleanhasNext()
Returns true if the underlying enumeration has more elements.
Objectnext()
Returns the next object from the enumeration.
voidremove()
Removes the last retrieved element if a collection is attached.
voidsetEnumeration(Enumeration enumeration)
Sets the underlying enumeration.

Constructor Detail

EnumerationIterator

public EnumerationIterator()
Constructs a new EnumerationIterator that will not function until setEnumeration is called.

EnumerationIterator

public EnumerationIterator(Enumeration enumeration)
Constructs a new EnumerationIterator that provides an iterator view of the given enumeration.

Parameters: enumeration the enumeration to use

EnumerationIterator

public EnumerationIterator(Enumeration enumeration, Collection collection)
Constructs a new EnumerationIterator that will remove elements from the specified collection.

Parameters: enumeration the enumeration to use collection the collection to remove elements form

Method Detail

getEnumeration

public Enumeration getEnumeration()
Returns the underlying enumeration.

Returns: the underlying enumeration

hasNext

public boolean hasNext()
Returns true if the underlying enumeration has more elements.

Returns: true if the underlying enumeration has more elements

Throws: NullPointerException if the underlying enumeration is null

next

public Object next()
Returns the next object from the enumeration.

Returns: the next object from the enumeration

Throws: NullPointerException if the enumeration is null

remove

public void remove()
Removes the last retrieved element if a collection is attached.

Functions if an associated Collection is known. If so, the first occurrence of the last returned object from this iterator will be removed from the collection.

Throws: IllegalStateException next() not called. UnsupportedOperationException if no associated collection

setEnumeration

public void setEnumeration(Enumeration enumeration)
Sets the underlying enumeration.

Parameters: enumeration the new underlying enumeration

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.