From 41878ce27efa7dac17cc1f3b283303cd6bbedd1e Mon Sep 17 00:00:00 2001
From: Bryce McKinlay <bryce@gcc.gnu.org>
Date: Tue, 16 Oct 2001 06:47:01 +0100
Subject: [multiple changes]
2001-10-15 Bryce McKinlay <bryce@waitaki.otago.ac.nz>
* java/util/HashMap.java (HashEntry.clone): Removed.
(HashMap(Map)): Use putAllInternal.
(clone): Likewise.
(putAllInternal): New method. Efficient counterpart to putAll which
does not call put().
* java/util/LinkedHashMap.java (rethread): Removed.
(putAllInternal): New method. Clear "head" and "tail".
(addEntry): New argument "callRemove". Don't call removeEldestEntry()
if callRemove == false.
* Makefile.am: Add new classes RandomAccess and LinkedHashMap.
* Makefile.in: Rebuilt.
2001-10-15 Eric Blake <ebb9@email.byu.edu>
* java/util/Collection.java: Updated javadoc.
* java/util/Comparator.java: Updated javadoc.
* java/util/Enumeration.java: Updated javadoc.
* java/util/Iterator.java: Updated javadoc.
* java/util/List.java: Updated javadoc.
* java/util/ListIterator.java: Updated javadoc.
* java/util/Map.java: Updated javadoc.
* java/util/RandomAccess.java: New file.
* java/util/Set.java: Updated javadoc.
* java/util/SortedMap.java: Updated javadoc.
* java/util/SortedSet.java: Updated javadoc.
From-SVN: r46277
---
libjava/java/util/Iterator.java | 46 ++++++++++++++++++++++++-----------------
1 file changed, 27 insertions(+), 19 deletions(-)
(limited to 'libjava/java/util/Iterator.java')
diff --git a/libjava/java/util/Iterator.java b/libjava/java/util/Iterator.java
index 92620f8..cc68c87 100644
--- a/libjava/java/util/Iterator.java
+++ b/libjava/java/util/Iterator.java
@@ -1,5 +1,5 @@
/* Iterator.java -- Interface for iterating over collections
- Copyright (C) 1998 Free Software Foundation, Inc.
+ Copyright (C) 1998, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -28,20 +28,28 @@ executable file might be covered by the GNU General Public License. */
package java.util;
/**
- * 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.
+ * 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.
+ *
+ * @author Original author unknown
+ * @author Eric Blake <ebb9@email.byu.edu>
+ * @see Collection
+ * @see ListIterator
+ * @see Enumeration
+ * @since 1.2
+ * @status updated to 1.4
*/
public interface Iterator
{
/**
- * Tests whether there are elements remaining in the collection.
+ * Tests whether there are elements remaining in the collection. In other
+ * words, calling <code>next()</code> will not throw an exception.
*
- * @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.
+ * @return true if there is at least one more element in the collection
*/
boolean hasNext();
@@ -49,20 +57,20 @@ public interface Iterator
* Obtain the next element in the collection.
*
* @return the next element in the collection
- * @exception NoSuchElementException if there are no more elements
+ * @throws 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.
+ * Remove from the underlying collection the last element returned by next
+ * (optional operation). This method can be called only once after each
+ * call to <code>next()</code>. It does not affect what will be returned
+ * by subsequent calls to next.
*
- * @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.
+ * @throws IllegalStateException if next has not yet been called or remove
+ * has already been called since the last call to next.
+ * @throws UnsupportedOperationException if this Iterator does not support
+ * the remove operation.
*/
void remove();
}
--
cgit v1.1