libjava/java/util/Enumeration.java

   1 /* Enumeration.java -- Interface for enumerating lists of objects
   2    Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath 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, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.util;
  39
  40 /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3
  41  * "The Java Language Specification", ISBN 0-201-63451-1.
  42  * Status:  Believed complete and correct
  43  */
  44
  45 /**
  46  * Interface for lists of objects that can be returned in sequence. Successive
  47  * objects are obtained by the nextElement method.
  48  * <p>
  49  * As of Java 1.2, the Iterator interface provides the same functionality, but
  50  * with shorter method names and a new optional method to remove items from the
  51  * list. If writing for 1.2, consider using Iterator instead. Enumerations over
  52  * the new collections classes, for use with legacy APIs that require them, can
  53  * be obtained by the enumeration method in class Collections.
  54  *
  55  * @author Warren Levy <warrenl@cygnus.com>
  56  * @author Eric Blake <ebb9@email.byu.edu>
  57  * @see Iterator
  58  * @see Hashtable
  59  * @see Vector
  60  * @since 1.0
  61  * @status updated to 1.4
  62  */
  63 public interface Enumeration
  64 {
  65   /**
  66    * Tests whether there are elements remaining in the enumeration.
  67    *
  68    * @return true if there is at least one more element in the enumeration,
  69    *         that is, if the next call to nextElement will not throw a
  70    *         NoSuchElementException.
  71    */
  72   boolean hasMoreElements();
  73
  74   /**
  75    * Obtain the next element in the enumeration.
  76    *
  77    * @return the next element in the enumeration
  78    * @throws NoSuchElementException if there are no more elements
  79    */
  80   Object nextElement();
  81 }