src/share/classes/java/util/Enumeration.java

Print this page
rev 10048 : 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
Reviewed-by:


  39  * Methods are provided to enumerate through the elements of a
  40  * vector, the keys of a hashtable, and the values in a hashtable.
  41  * Enumerations are also used to specify the input streams to a
  42  * <code>SequenceInputStream</code>.
  43  * <p>
  44  * NOTE: The functionality of this interface is duplicated by the Iterator
  45  * interface.  In addition, Iterator adds an optional remove operation, and
  46  * has shorter method names.  New implementations should consider using
  47  * Iterator in preference to Enumeration.
  48  *
  49  * @see     java.util.Iterator
  50  * @see     java.io.SequenceInputStream
  51  * @see     java.util.Enumeration#nextElement()
  52  * @see     java.util.Hashtable
  53  * @see     java.util.Hashtable#elements()
  54  * @see     java.util.Hashtable#keys()
  55  * @see     java.util.Vector
  56  * @see     java.util.Vector#elements()
  57  *
  58  * @author  Lee Boynton
  59  * @since   JDK1.0
  60  */
  61 public interface Enumeration<E> {
  62     /**
  63      * Tests if this enumeration contains more elements.
  64      *
  65      * @return  <code>true</code> if and only if this enumeration object
  66      *           contains at least one more element to provide;
  67      *          <code>false</code> otherwise.
  68      */
  69     boolean hasMoreElements();
  70 
  71     /**
  72      * Returns the next element of this enumeration if this enumeration
  73      * object has at least one more element to provide.
  74      *
  75      * @return     the next element of this enumeration.
  76      * @exception  NoSuchElementException  if no more elements exist.
  77      */
  78     E nextElement();
  79 }


  39  * Methods are provided to enumerate through the elements of a
  40  * vector, the keys of a hashtable, and the values in a hashtable.
  41  * Enumerations are also used to specify the input streams to a
  42  * <code>SequenceInputStream</code>.
  43  * <p>
  44  * NOTE: The functionality of this interface is duplicated by the Iterator
  45  * interface.  In addition, Iterator adds an optional remove operation, and
  46  * has shorter method names.  New implementations should consider using
  47  * Iterator in preference to Enumeration.
  48  *
  49  * @see     java.util.Iterator
  50  * @see     java.io.SequenceInputStream
  51  * @see     java.util.Enumeration#nextElement()
  52  * @see     java.util.Hashtable
  53  * @see     java.util.Hashtable#elements()
  54  * @see     java.util.Hashtable#keys()
  55  * @see     java.util.Vector
  56  * @see     java.util.Vector#elements()
  57  *
  58  * @author  Lee Boynton
  59  * @since   1.0
  60  */
  61 public interface Enumeration<E> {
  62     /**
  63      * Tests if this enumeration contains more elements.
  64      *
  65      * @return  <code>true</code> if and only if this enumeration object
  66      *           contains at least one more element to provide;
  67      *          <code>false</code> otherwise.
  68      */
  69     boolean hasMoreElements();
  70 
  71     /**
  72      * Returns the next element of this enumeration if this enumeration
  73      * object has at least one more element to provide.
  74      *
  75      * @return     the next element of this enumeration.
  76      * @exception  NoSuchElementException  if no more elements exist.
  77      */
  78     E nextElement();
  79 }