Subversion Repositories scarts

/* Enumeration.java -- Interface for enumerating lists of objects

   Copyright (C) 1998, 1999, 2001, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2, or (at your option)

any later version.

GNU Classpath is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

General Public License for more details.

You should have received a copy of the GNU General Public License

along with GNU Classpath; see the file COPYING.  If not, write to the

Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301 USA.

Linking this library statically or dynamically with other modules is

making a combined work based on this library.  Thus, the terms and

conditions of the GNU General Public License cover the whole

combination.

As a special exception, the copyright holders of this library give you

permission to link this library with independent modules to produce an

executable, regardless of the license terms of these independent

modules, and to copy and distribute the resulting executable under

terms of your choice, provided that you also meet, for each linked

independent module, the terms and conditions of the license of that

module.  An independent module is a module which is not derived from

or based on this library.  If you modify this library, you may extend

this exception to your version of the library, but you are not

obligated to do so.  If you do not wish to do so, delete this

exception statement from your version. */

package java.util;

/* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3

 * "The Java Language Specification", ISBN 0-201-63451-1.

 * Status:  Believed complete and correct

 */

/**

 * Interface for lists of objects that can be returned in sequence. Successive

 * objects are obtained by the nextElement method.

 * <p>

 * As of Java 1.2, the Iterator interface provides the same functionality, but

 * with shorter method names and a new optional method to remove items from the

 * list. If writing for 1.2, consider using Iterator instead. Enumerations over

 * the new collections classes, for use with legacy APIs that require them, can

 * be obtained by the enumeration method in class Collections.

 *

 * @author Warren Levy (warrenl@cygnus.com)

 * @author Eric Blake (ebb9@email.byu.edu)

 * @see Iterator

 * @see Hashtable

 * @see Vector

 * @since 1.0

 * @status updated to 1.4

 */

public interface Enumeration

{

  /**

   * Tests whether there are elements remaining in the enumeration.

   *

   * @return true if there is at least one more element in the enumeration,

   *         that is, if the next call to nextElement will not throw a

   *         NoSuchElementException.

   */

  boolean hasMoreElements();

  /**

   * Obtain the next element in the enumeration.

   *

   * @return the next element in the enumeration

   * @throws NoSuchElementException if there are no more elements

   */

  Object nextElement();

}