This is an automated email from the ASF dual-hosted git repository. garydgregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-collections.git
commit 6c16ca019f13cff5d8e07ff3f5b4bca8fad34dbf Author: Gary Gregory <[email protected]> AuthorDate: Thu Jul 9 19:16:40 2026 -0400 Add missing Javadoc and tags. --- .../commons/collections4/bag/UnmodifiableBag.java | 10 ++++++++++ .../commons/collections4/bag/UnmodifiableSortedBag.java | 10 ++++++++++ .../commons/collections4/bidimap/TreeBidiMap.java | 2 ++ .../collections4/bidimap/UnmodifiableBidiMap.java | 5 +++++ .../bidimap/UnmodifiableOrderedBidiMap.java | 5 +++++ .../collections4/bidimap/UnmodifiableSortedBidiMap.java | 5 +++++ .../collection/UnmodifiableBoundedCollection.java | 6 ++++++ .../collections4/collection/UnmodifiableCollection.java | 5 +++++ .../iterators/UnmodifiableListIterator.java | 17 +++++++++++++++++ 9 files changed, 65 insertions(+) diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java index 2615ba75a..db4831d55 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java @@ -81,6 +81,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -91,6 +92,8 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. + * @param count Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -101,6 +104,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -140,6 +144,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -150,6 +155,8 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. + * @param count Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -160,6 +167,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -170,6 +178,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param filter Ignored. * @throws UnsupportedOperationException Always thrown. * @since 4.4 */ @@ -181,6 +190,7 @@ public final class UnmodifiableBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java index 4aee7f433..225d64aad 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java @@ -78,6 +78,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -88,6 +89,8 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. + * @param count Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -98,6 +101,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -137,6 +141,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -147,6 +152,8 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. + * @param count Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -157,6 +164,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -167,6 +175,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param filter Ignored. * @throws UnsupportedOperationException Always thrown. * @since 4.4 */ @@ -178,6 +187,7 @@ public final class UnmodifiableSortedBag<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java index 6cbdbf9de..53483a60f 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java @@ -529,6 +529,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** * Always throws {@link UnsupportedOperationException}. * + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -879,6 +880,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** * Always throws {@link UnsupportedOperationException}. * + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java index e85ddc4df..b4c5ca35d 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java @@ -114,6 +114,8 @@ public final class UnmodifiableBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -124,6 +126,7 @@ public final class UnmodifiableBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param mapToCopy Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -134,6 +137,7 @@ public final class UnmodifiableBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -144,6 +148,7 @@ public final class UnmodifiableBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java index 5abb80afc..634922e7a 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java @@ -124,6 +124,8 @@ public final class UnmodifiableOrderedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -134,6 +136,7 @@ public final class UnmodifiableOrderedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param mapToCopy Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -144,6 +147,7 @@ public final class UnmodifiableOrderedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -154,6 +158,7 @@ public final class UnmodifiableOrderedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java index 151804184..9f05ef794 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java @@ -122,6 +122,8 @@ public final class UnmodifiableSortedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -132,6 +134,7 @@ public final class UnmodifiableSortedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param mapToCopy Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -142,6 +145,7 @@ public final class UnmodifiableSortedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param key Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -152,6 +156,7 @@ public final class UnmodifiableSortedBidiMap<K, V> /** * Always throws {@link UnsupportedOperationException}. * + * @param value Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java index 716568895..ed1eb4ee4 100644 --- a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java +++ b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java @@ -119,6 +119,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -129,6 +130,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -169,6 +171,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -179,6 +182,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -189,6 +193,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param filter Ignored. * @throws UnsupportedOperationException Always thrown. * @since 4.4 */ @@ -200,6 +205,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe /** * Always throws {@link UnsupportedOperationException}. * + * @param Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableCollection.java b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableCollection.java index 9ceb17f54..da9162324 100644 --- a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableCollection.java +++ b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableCollection.java @@ -77,6 +77,7 @@ public final class UnmodifiableCollection<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -112,6 +113,7 @@ public final class UnmodifiableCollection<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param object Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -122,6 +124,7 @@ public final class UnmodifiableCollection<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override @@ -132,6 +135,7 @@ public final class UnmodifiableCollection<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param filter Ignored. * @throws UnsupportedOperationException Always thrown. * @since 4.4 */ @@ -143,6 +147,7 @@ public final class UnmodifiableCollection<E> /** * Always throws {@link UnsupportedOperationException}. * + * @param coll Ignored. * @throws UnsupportedOperationException Always thrown. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java index 4ca8503d5..585d66133 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java @@ -76,6 +76,12 @@ public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmod this.iterator = iterator; } + /** + * Always throws {@link UnsupportedOperationException}. + * + * @param obj Ignored. + * @throws UnsupportedOperationException Always thrown. + */ @Override public void add(final E obj) { throw new UnsupportedOperationException("add() is not supported"); @@ -111,11 +117,22 @@ public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmod return iterator.previousIndex(); } + /** + * Always throws {@link UnsupportedOperationException}. + * + * @throws UnsupportedOperationException Always thrown. + */ @Override public void remove() { throw new UnsupportedOperationException("remove() is not supported"); } + /** + * Always throws {@link UnsupportedOperationException}. + * + * @param ignored Ignored. + * @throws UnsupportedOperationException Always thrown. + */ @Override public void set(final E ignored) { throw new UnsupportedOperationException("set() is not supported");
