org.apache.commons.collections.iterators

Class EnumerationIterator

Implemented Interfaces:
Iterator

public class EnumerationIterator
extends java.lang.Object
implements Iterator

Adapter to make Enumeration instances appear to be Iterator instances.
Version:
$Revision: 1.8 $ $Date: 2004/04/21 20:34:12 $
Authors:
James Strachan
Daniel Rall
Since:
Commons Collections 1.0

Constructor Summary

EnumerationIterator()
Constructs a new EnumerationIterator that will not function until setEnumeration(Enumeration) 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

Enumeration
getEnumeration()
Returns the underlying enumeration.
boolean
hasNext()
Returns true if the underlying enumeration has more elements.
Object
next()
Returns the next object from the enumeration.
void
remove()
Removes the last retrieved element if a collection is attached.
void
setEnumeration(Enumeration enumeration)
Sets the underlying enumeration.

Constructor Details

EnumerationIterator

public EnumerationIterator()

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 Details

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

next

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

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.


setEnumeration

public void setEnumeration(Enumeration enumeration)
Sets the underlying enumeration.
Parameters:
enumeration - the new underlying enumeration

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