Source for java.util.Enumeration

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