(commons-collections) 09/12: Deprecate AbstractEmptyIterator.add(E) without replacement

[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 969bfd2fe7f55bb8fc6effba3bf888af2967fb6a
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 23 08:11:17 2024 -0400

    Deprecate AbstractEmptyIterator.add(E) without replacement
---
 src/changes/changes.xml                                          | 1 +
 .../commons/collections4/iterators/AbstractEmptyIterator.java    | 9 ++++++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index a1da89db0..5a9c8bb1c 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -26,6 +26,7 @@
     <!-- FIX -->
     <action issue="COLLECTIONS-857" type="fix" dev="ggregory" due-to="Claude 
Warren">Complete bloom filter documentation #507.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Package private 
AbstractEmptyIterator implements ResettableIterator so subclasses 
don't.</action>
+    <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate 
AbstractEmptyIterator.add(E) without replacement.</action>
     <!-- ADD -->
     <!-- UPDATE -->
   </release>
diff --git 
a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
 
b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
index 383dcb775..db1d4c676 100644
--- 
a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
+++ 
b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
@@ -33,7 +33,14 @@ abstract class AbstractEmptyIterator<E> implements 
ResettableIterator<E> {
     protected AbstractEmptyIterator() {
     }
 
-    public void add(final E obj) {
+    /**
+     * Always throws UnsupportedOperationException.
+     * @param ignore ignore. 
+     * @throws UnsupportedOperationException
+     * @deprecated Will be removed in 5.0 without replacement.
+     */
+    @Deprecated
+    public void add(final E ignore) {
         throw new UnsupportedOperationException("add() not supported for empty 
Iterator");
     }