public class

EnumerationIterator

extends Object
implements Iterator<E>
java.lang.Object
   ↳ org.apache.commons.collections.iterators.EnumerationIterator

Class Overview

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

Summary

Public Constructors
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.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator

Public Constructors

public EnumerationIterator ()

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

public EnumerationIterator (Enumeration enumeration)

Constructs a new EnumerationIterator that provides an iterator view of the given enumeration.

Parameters
enumeration the enumeration to use

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

Public Methods

public Enumeration getEnumeration ()

Returns the underlying enumeration.

Returns
  • the underlying enumeration

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

public Object next ()

Returns the next object from the enumeration.

Returns
  • the next object from the enumeration
Throws
NullPointerException if the enumeration is null

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

public void setEnumeration (Enumeration enumeration)

Sets the underlying enumeration.

Parameters
enumeration the new underlying enumeration