org.apache.catalina.util: public final class: Enumerator

org.apache.catalina.util
public final class: Enumerator [javadoc | source]

java.lang.Object
   org.apache.catalina.util.Enumerator

All Implemented Interfaces:
Enumeration

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.

author: Craig - R. McClanahan

version: $ - Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $

Constructor:

Constructor:
public Enumerator(Collection collection) { this(collection.iterator()); } Return an Enumeration over the values of the specified Collection. Parameters: `collection` - Collection whose values should be enumerated
public Enumerator(Iterator iterator) { super(); this.iterator = iterator; } Return an Enumeration over the values returned by the specified Iterator. Parameters: `iterator` - Iterator to be wrapped
public Enumerator(Map map) { this(map.values().iterator()); } Return an Enumeration over the values of the specified Map. Parameters: `map` - Map whose values should be enumerated
public Enumerator(Collection collection, boolean clone) { this(collection.iterator(), clone); } Return an Enumeration over the values of the specified Collection. Parameters: `collection` - Collection whose values should be enumerated `clone` - true to clone iterator
public Enumerator(Iterator iterator, boolean clone) { super(); if (!clone) { this.iterator = iterator; } else { List list = new ArrayList(); while (iterator.hasNext()) { list.add(iterator.next()); } this.iterator = list.iterator(); } } Return an Enumeration over the values returned by the specified Iterator. Parameters: `iterator` - Iterator to be wrapped `clone` - true to clone iterator
public Enumerator(Map map, boolean clone) { this(map.values().iterator(), clone); } Return an Enumeration over the values of the specified Map. Parameters: `map` - Map whose values should be enumerated `clone` - true to clone iterator

 public Enumerator(Collection collection) {
        this(collection.iterator());
}

Return an Enumeration over the values of the specified Collection.

Parameters:

collection - Collection whose values should be enumerated

 public Enumerator(Iterator iterator) {
        super();
        this.iterator = iterator;
}

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

Parameters:

iterator - Iterator to be wrapped

 public Enumerator(Map map) {
        this(map.values().iterator());
}

Return an Enumeration over the values of the specified Map.

Parameters:

map - Map whose values should be enumerated

 public Enumerator(Collection collection,
    boolean clone) {
        this(collection.iterator(), clone);
}

Return an Enumeration over the values of the specified Collection.

Parameters:

collection - Collection whose values should be enumerated

clone - true to clone iterator

 public Enumerator(Iterator iterator,
    boolean clone) {
        super();
        if (!clone) {
            this.iterator = iterator;
        } else {
            List list = new ArrayList();
            while (iterator.hasNext()) {
                list.add(iterator.next());
            }
            this.iterator = list.iterator();   
        }
}

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

Parameters:

iterator - Iterator to be wrapped

clone - true to clone iterator

 public Enumerator(Map map,
    boolean clone) {
        this(map.values().iterator(), 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 from org.apache.catalina.util.Enumerator Summary:
hasMoreElements, nextElement

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.catalina.util.Enumerator Detail:
public boolean hasMoreElements() { // --------------------------------------------------------- Public Methods return (iterator.hasNext()); } Tests if this enumeration contains more elements.
public Object nextElement() throws NoSuchElementException { return (iterator.next()); } Returns the next element of this enumeration if this enumeration has at least one more element to provide.

Method from org.apache.catalina.util.Enumerator Detail:

 public boolean hasMoreElements() {
    // --------------------------------------------------------- Public Methods
        return (iterator.hasNext());
}

Tests if this enumeration contains more elements.

 public Object nextElement() throws NoSuchElementException {
        return (iterator.next());
}

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