org.apache.catalina.util

Class Enumerator<T>

java.lang.Object

org.apache.catalina.util.Enumerator<T>

All Implemented Interfaces:

Enumeration<T>

public final class Enumerator<T>
extends Object
implements Enumeration<T>

Adapter class that wraps an Enumeration around a Java2 collection classes object Iterator so that existing APIs returning Enumerations can easily run on top of the new collections. Constructors are provided to easliy create such wrappers.

Version:

$Revision: 1.2 $ $Date: 2005/12/08 01:28:15 $

Author:

Craig R. McClanahan

Constructor Summary

Constructors

Constructor and Description
Enumerator(Collection<T> collection) Return an Enumeration over the values of the specified Collection.
Enumerator(Collection<T> collection, boolean clone) Return an Enumeration over the values of the specified Collection.
Enumerator(Iterator<T> iterator) Return an Enumeration over the values returned by the specified Iterator.
Enumerator(Iterator<T> iterator, boolean clone) Return an Enumeration over the values returned by the specified Iterator.
Enumerator(Map<?,T> map) Return an Enumeration over the values of the specified Map.
Enumerator(Map<?,T> map, boolean clone) Return an Enumeration over the values of the specified Map.

Method Summary

Modifier and Type	Method and Description
boolean	hasMoreElements() Tests if this enumeration contains more elements.
T	nextElement() Returns the next element of this enumeration if this enumeration has at least one more element to provide.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Enumerator

public Enumerator(Collection<T> collection)

Return an Enumeration over the values of the specified Collection.

Parameters:

collection - Collection whose values should be enumerated

Enumerator

public Enumerator(Collection<T> collection,
                  boolean clone)

Return an Enumeration over the values of the specified Collection.

Parameters:

collection - Collection whose values should be enumerated

clone - true to clone iterator

Enumerator

public Enumerator(Iterator<T> iterator)

Return an Enumeration over the values returned by the specified Iterator.

Parameters:

iterator - Iterator to be wrapped

Enumerator

public Enumerator(Iterator<T> iterator,
                  boolean clone)

Return an Enumeration over the values returned by the specified Iterator.

Parameters:

iterator - Iterator to be wrapped

clone - true to clone iterator

Enumerator

public Enumerator(Map<?,T> map)

Return an Enumeration over the values of the specified Map.

Parameters:

map - Map whose values should be enumerated

Enumerator

public Enumerator(Map<?,T> map,
                  boolean clone)

Return an Enumeration over the values of the specified Map.

Parameters:

map - Map whose values should be enumerated

clone - true to clone iterator

Method Detail

hasMoreElements

public boolean hasMoreElements()

Tests if this enumeration contains more elements.

Specified by:

hasMoreElements in interface Enumeration<T>

Returns:

true if and only if this enumeration object contains at least one more element to provide, false otherwise

nextElement

public T nextElement()
              throws NoSuchElementException

Returns the next element of this enumeration if this enumeration has at least one more element to provide.

Specified by:

nextElement in interface Enumeration<T>

Returns:

the next element of this enumeration

Throws:

NoSuchElementException - if no more elements exist