KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Ostermiller > util > EnumerationIterator


1 /*
2  * Converts an enumeration to an iterator.
3  * Copyright (C) 2004 Stephen Ostermiller
4  * http://ostermiller.org/contact.pl?regarding=Java+Utilities
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * See COPYING.TXT for details.
17  */

18
19 package com.Ostermiller.util;
20
21 import java.util.*;
22
23 /**
24  * Converts an Enumeration to an iterator.
25  * <p>
26  * More information about this class is available from <a target="_top" HREF=
27  * "http://ostermiller.org/utils/Iterator_Enumeration.html">ostermiller.org</a>.
28  *
29  * @author Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
30  * @since ostermillerutils 1.03.00
31  */

32 public class EnumerationIterator <ElementType> implements Iterator {
33
34     /**
35      * Enumeration being converted to iterator.
36      */

37     private Enumeration<ElementType> enumeration;
38
39     /**
40      * Create an Iterator from an Enumeration.
41      *
42      * @param enumeration Enumeration to convert to an Iterator.
43      *
44      * @since ostermillerutils 1.03.00
45      */

46     public EnumerationIterator(Enumeration<ElementType> enumeration){
47         this.enumeration = enumeration;
48     }
49
50     /**
51      * Tests if this Iterator contains more elements.
52      *
53      * @return true if and only if this Iterator object contains at least
54      * one more element to provide; false otherwise.
55      *
56      * @since ostermillerutils 1.03.00
57      */

58     public boolean hasNext(){
59         return enumeration.hasMoreElements();
60     }
61
62     /**
63      * Returns the next element of this Iterator if this Iterator
64      * object has at least one more element to provide.
65      *
66      * @return the next element of this Iterator.
67      * @throws NoSuchElementException if no more elements exist.
68      *
69      * @since ostermillerutils 1.03.00
70      */

71     public ElementType next() throws NoSuchElementException {
72         return enumeration.nextElement();
73     }
74
75     /**
76      * Operation not supported.
77      *
78      * @throws UnsupportedOperationException every time.
79      *
80      * @since ostermillerutils 1.03.00
81      */

82     public void remove(){
83         throw new UnsupportedOperationException JavaDoc("EnumerationIterator does not support remove()");
84     }
85 }
Popular Tags