diff options
| author | Bryce McKinlay <bryce@albatross.co.nz> | 2001-02-15 06:43:00 +0000 |
|---|---|---|
| committer | Bryce McKinlay <bryce@gcc.gnu.org> | 2001-02-15 06:43:00 +0000 |
| commit | 06e3b913b388b770222e5467069c5d98872760a0 (patch) | |
| tree | 946703e523387eb8a2f5650a54a1e9a6302d6de0 /libjava/java/util/Iterator.java | |
| parent | a6845c56c4b7b6e6ca66c87530c2dcb4eebbc2c4 (diff) | |
| download | gcc-06e3b913b388b770222e5467069c5d98872760a0.zip gcc-06e3b913b388b770222e5467069c5d98872760a0.tar.gz gcc-06e3b913b388b770222e5467069c5d98872760a0.tar.bz2 | |
AbstractSequentialList.java: Synchronize with Classpath.
* java/util/AbstractSequentialList.java: Synchronize with Classpath.
* java/util/Collection.java: Likewise.
* java/util/Comparator.java: Likewise.
* java/util/Dictionary.java: Likewise.
* java/util/Iterator.java: Likewise.
* java/util/ListIterator.java: Likewise.
* java/util/Map.java: Likewise.
* java/util/Set.java: Likewise.
From-SVN: r39708
Diffstat (limited to 'libjava/java/util/Iterator.java')
| -rw-r--r-- | libjava/java/util/Iterator.java | 73 |
1 files changed, 58 insertions, 15 deletions
diff --git a/libjava/java/util/Iterator.java b/libjava/java/util/Iterator.java index f6942fe..92620f8 100644 --- a/libjava/java/util/Iterator.java +++ b/libjava/java/util/Iterator.java @@ -1,25 +1,68 @@ -/* Copyright (C) 2000 Free Software Foundation +/* Iterator.java -- Interface for iterating over collections + Copyright (C) 1998 Free Software Foundation, Inc. - This file is part of libgcj. +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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ package java.util; /** - * @author Warren Levy <warrenl@cygnus.com> - * @date March 16, 2000. + * An object which iterates over a collection. An Iterator is used to return the + * items once only, in sequence, by successive calls to the next method. It is + * also possible to remove elements from the underlying collection by using the + * optional remove method. Iterator is intended as a replacement for the + * Enumeration interface of previous versions of Java, which did not have the + * remove method and had less conveniently named methods. */ -/* Written using on-line Java Platform 1.2 API Specification. - * Status: Believed complete and correct. - */ - -// JDK1.2 public interface Iterator { - public boolean hasNext(); - public Object next(); - public void remove(); + /** + * Tests whether there are elements remaining in the collection. + * + * @return true if there is at least one more element in the collection, + * that is, if the next call to next will not throw NoSuchElementException. + */ + boolean hasNext(); + + /** + * Obtain the next element in the collection. + * + * @return the next element in the collection + * @exception NoSuchElementException if there are no more elements + */ + Object next(); + + /** + * Remove from the underlying collection the last element returned by next. + * This method can be called only once after each call to next. It does not + * affect what will be returned by subsequent calls to next. This operation is + * optional, it may throw an UnsupportedOperationException. + * + * @exception IllegalStateException if next has not yet been called or remove + * has already been called since the last call to next. + * @exception UnsupportedOperationException if this Iterator does not support + * the remove operation. + */ + void remove(); } |