(commons-collections) 10/12: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git

commit f82b597b7505a5ee652bdeec241ee10e41107f76
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 23 08:11:24 2024 -0400

    Javadoc
---
 .../iterators/AbstractEmptyMapIterator.java         | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
 
b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
index 446e4bb93..d6499a16e 100644
--- 
a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
+++ 
b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
@@ -31,15 +31,34 @@ public abstract class AbstractEmptyMapIterator<K, V> 
extends AbstractEmptyIterat
     public AbstractEmptyMapIterator() {
     }
 
+    /**
+     * Always throws IllegalStateException.
+     *
+     * @return Always throws IllegalStateException.
+     * @throws IllegalStateException Always thrown.
+     */
     public K getKey() {
         throw new IllegalStateException("Iterator contains no elements");
     }
 
+    /**
+     * Always throws IllegalStateException.
+     *
+     * @return Always throws IllegalStateException.
+     * @throws IllegalStateException Always thrown.
+     */
     public V getValue() {
         throw new IllegalStateException("Iterator contains no elements");
     }
 
-    public V setValue(final V value) {
+    /**
+     * Always throws IllegalStateException.
+     *
+     * @param ignored ignored. 
+     * @return Always throws IllegalStateException.
+     * @throws IllegalStateException Always thrown.
+     */
+    public V setValue(final V ignored) {
         throw new IllegalStateException("Iterator contains no elements");
     }