View Javadoc

1   package org.apache.velocity.util;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.    
20   */
21  
22  import java.util.Iterator;
23  import java.util.Enumeration;
24  
25  /**
26   * An Iterator wrapper for an Enumeration.
27   *
28   * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
29   * @version $Id: EnumerationIterator.java 463298 2006-10-12 16:10:32Z henning $
30   */
31  public class EnumerationIterator implements Iterator
32  {
33      /**
34       * The enumeration to iterate.
35       */
36      private Enumeration enumeration = null;
37  
38      /**
39       * Creates a new iteratorwrapper instance for the specified
40       * Enumeration.
41       *
42       * @param enumeration  The Enumeration to wrap.
43       */
44      public EnumerationIterator(Enumeration enumeration)
45      {
46          this.enumeration = enumeration;
47      }
48  
49      /**
50       * Move to next element in the array.
51       *
52       * @return The next object in the array.
53       */
54      public Object next()
55      {
56          return enumeration.nextElement();
57      }
58  
59      /**
60       * Check to see if there is another element in the array.
61       *
62       * @return Whether there is another element.
63       */
64      public boolean hasNext()
65      {
66          return enumeration.hasMoreElements();
67      }
68  
69      /**
70       *  Unimplemented.  No analogy in Enumeration
71       */
72      public void remove()
73      {
74          // not implemented
75      }
76  
77  }