Home | History | Annotate | Download | only in util
      1 /*
      2  *  Licensed to the Apache Software Foundation (ASF) under one or more
      3  *  contributor license agreements.  See the NOTICE file distributed with
      4  *  this work for additional information regarding copyright ownership.
      5  *  The ASF licenses this file to You under the Apache License, Version 2.0
      6  *  (the "License"); you may not use this file except in compliance with
      7  *  the License.  You may obtain a copy of the License at
      8  *
      9  *     http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  *  Unless required by applicable law or agreed to in writing, software
     12  *  distributed under the License is distributed on an "AS IS" BASIS,
     13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  *  See the License for the specific language governing permissions and
     15  *  limitations under the License.
     16  */
     17 
     18 package java.util;
     19 
     20 /**
     21  * A legacy iteration interface.
     22  *
     23  * <p>New code should use {@link Iterator} instead. {@code Iterator} replaces the
     24  * enumeration interface and adds a way to remove elements from a collection.
     25  *
     26  * <p>If you <i>have</i> an {@code Enumeration} and want a {@code Collection}, you
     27  * can use {@link Collections#list} to get a {@code List}.
     28  *
     29  * <p>If you <i>need</i> an {@code Enumeration} for a legacy API and have a
     30  * {@code Collection}, you can use {@link Collections#enumeration}.
     31  *
     32  * @version 1.0
     33  * @see Iterator
     34  */
     35 public interface Enumeration<E> {
     36 
     37     /**
     38      * Returns whether this {@code Enumeration} has more elements.
     39      *
     40      * @return {@code true} if there are more elements, {@code false} otherwise.
     41      * @see #nextElement
     42      */
     43     public boolean hasMoreElements();
     44 
     45     /**
     46      * Returns the next element in this {@code Enumeration}.
     47      *
     48      * @return the next element..
     49      * @throws NoSuchElementException
     50      *             if there are no more elements.
     51      * @see #hasMoreElements
     52      */
     53     public E nextElement();
     54 }
     55