From de7cb0105b574c98485f2f230a882000fc5f1480 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sat, 11 Jan 2020 20:15:31 -0500 Subject: [PATCH] Javadoc: Add missing tags. --- .../java/org/apache/commons/collections4/OrderedIterator.java | 2 +- .../org/apache/commons/collections4/ResettableIterator.java | 2 +- .../apache/commons/collections4/ResettableListIterator.java | 4 ++-- .../apache/commons/collections4/iterators/ArrayIterator.java | 2 +- .../commons/collections4/iterators/ArrayListIterator.java | 1 + .../commons/collections4/iterators/BoundedIterator.java | 1 + .../commons/collections4/iterators/CollatingIterator.java | 1 + .../apache/commons/collections4/iterators/EmptyIterator.java | 1 + .../commons/collections4/iterators/EmptyListIterator.java | 1 + .../commons/collections4/iterators/EmptyOrderedIterator.java | 2 +- .../commons/collections4/iterators/EnumerationIterator.java | 1 + .../apache/commons/collections4/iterators/FilterIterator.java | 1 + .../commons/collections4/iterators/FilterListIterator.java | 1 + .../commons/collections4/iterators/IteratorEnumeration.java | 1 + .../commons/collections4/iterators/IteratorIterable.java | 1 + .../commons/collections4/iterators/LoopingIterator.java | 1 + .../commons/collections4/iterators/LoopingListIterator.java | 1 + .../commons/collections4/iterators/ObjectArrayIterator.java | 2 +- .../collections4/iterators/ObjectArrayListIterator.java | 1 + .../commons/collections4/iterators/ObjectGraphIterator.java | 1 + .../commons/collections4/iterators/PeekingIterator.java | 1 + .../commons/collections4/iterators/PushbackIterator.java | 1 + .../commons/collections4/iterators/ReverseListIterator.java | 1 + .../commons/collections4/iterators/SingletonIterator.java | 1 + .../commons/collections4/iterators/SingletonListIterator.java | 1 + .../commons/collections4/iterators/SkippingIterator.java | 1 + .../commons/collections4/iterators/UniqueFilterIterator.java | 1 + .../commons/collections4/iterators/UnmodifiableIterator.java | 1 + .../collections4/iterators/UnmodifiableListIterator.java | 1 + .../commons/collections4/iterators/ZippingIterator.java | 1 + 30 files changed, 31 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/OrderedIterator.java b/src/main/java/org/apache/commons/collections4/OrderedIterator.java index 978251501..5a13bd449 100644 --- a/src/main/java/org/apache/commons/collections4/OrderedIterator.java +++ b/src/main/java/org/apache/commons/collections4/OrderedIterator.java @@ -24,7 +24,7 @@ import java.util.Iterator; * This iterator allows both forward and reverse iteration through the container. *

* - * @param the type of elements returned by this iterator + * @param the type of elements returned by this iterator. * @since 3.0 */ public interface OrderedIterator extends Iterator { diff --git a/src/main/java/org/apache/commons/collections4/ResettableIterator.java b/src/main/java/org/apache/commons/collections4/ResettableIterator.java index 91d17621b..91c2b2e78 100644 --- a/src/main/java/org/apache/commons/collections4/ResettableIterator.java +++ b/src/main/java/org/apache/commons/collections4/ResettableIterator.java @@ -24,7 +24,7 @@ import java.util.Iterator; * This interface allows an iterator to be repeatedly reused. *

* - * @param the type of elements returned by this iterator + * @param the type of elements returned by this iterator. * @since 3.0 */ public interface ResettableIterator extends Iterator { diff --git a/src/main/java/org/apache/commons/collections4/ResettableListIterator.java b/src/main/java/org/apache/commons/collections4/ResettableListIterator.java index cec204852..b3f64075d 100644 --- a/src/main/java/org/apache/commons/collections4/ResettableListIterator.java +++ b/src/main/java/org/apache/commons/collections4/ResettableListIterator.java @@ -24,9 +24,9 @@ import java.util.ListIterator; * This interface allows an iterator to be repeatedly reused. *

* - * @param the type of elements returned by this iterator + * @param the type of elements returned by this iterator. * @since 3.0 */ public interface ResettableListIterator extends ListIterator, ResettableIterator, OrderedIterator { - + // empty } diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java index f3d3599a4..84ee3039c 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java @@ -32,7 +32,7 @@ import org.apache.commons.collections4.ResettableIterator; * The iterator implements a {@link #reset} method, allowing the reset of * the iterator back to the start if required. * - * @param the type of elements returned by this iterator + * @param the type of elements returned by this iterator. * @since 1.0 */ public class ArrayIterator implements ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java index d01597c9f..08452b71b 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java @@ -32,6 +32,7 @@ import org.apache.commons.collections4.ResettableListIterator; * This iterator does not support {@link #add(Object)} or {@link #remove()}, as the array * cannot be changed in size. The {@link #set(Object)} method is supported however. * + * @param the type of elements returned by this iterator. * @see org.apache.commons.collections4.iterators.ArrayIterator * @see java.util.Iterator * @see java.util.ListIterator diff --git a/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java b/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java index b8aa08c93..266b28c8d 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java @@ -29,6 +29,7 @@ import java.util.Objects; * iterator is immediately advanced to this position, skipping all elements * before that position. * + * @param the type of elements returned by this iterator. * @since 4.1 */ public class BoundedIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java index a1ae4c14f..e02ffe767 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java @@ -36,6 +36,7 @@ import org.apache.commons.collections4.list.UnmodifiableList; * {@code B}, the {@link #next} method on this iterator will return the * lesser of {@code A.next()} and {@code B.next()}. * + * @param the type of elements returned by this iterator. * @since 2.1 */ public class CollatingIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java index 2bcf193d8..76b2b04b5 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.ResettableIterator; * This class provides for binary compatibility between Commons Collections * 2.1.1 and 3.1 due to issues with {@code IteratorUtils}. * + * @param the type of elements returned by this iterator. * @since 2.1.1 and 3.1 */ public class EmptyIterator extends AbstractEmptyIterator implements ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java index 0b9f6724e..0bd1c27e5 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.ResettableListIterator; * provides for binary compatibility between Commons Collections 2.1.1 and 3.1 * due to issues with {@code IteratorUtils}. * + * @param the type of elements returned by this iterator. * @since 2.1.1 and 3.1 */ public class EmptyListIterator extends AbstractEmptyIterator implements diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java index 113d223af..1923ee499 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java @@ -22,7 +22,7 @@ import org.apache.commons.collections4.ResettableIterator; /** * Provides an implementation of an empty ordered iterator. * - * @param the type to iterate. + * @param the type of elements returned by this iterator. * @since 3.1 */ public class EmptyOrderedIterator extends AbstractEmptyIterator diff --git a/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java index 518ffdda6..8e08a2f50 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java @@ -24,6 +24,7 @@ import java.util.Iterator; * Adapter to make {@link Enumeration Enumeration} instances appear * to be {@link Iterator Iterator} instances. * + * @param the type of elements returned by this iterator. * @since 1.0 */ public class EnumerationIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java b/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java index 3da4b71f5..20d98610d 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/FilterIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.Predicate; * This iterator decorates the underlying iterator, only allowing through * those elements that match the specified {@link Predicate Predicate}. * + * @param the type of elements returned by this iterator. * @since 1.0 */ public class FilterIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java index 8e4f83b24..958a5d789 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.Predicate; * This iterator decorates the underlying iterator, only allowing through * those elements that match the specified {@link Predicate Predicate}. * + * @param the type of elements returned by this iterator. * @since 2.0 */ public class FilterListIterator implements ListIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java index 289ebf55b..23c9c799f 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java +++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java @@ -23,6 +23,7 @@ import java.util.Iterator; * Adapter to make an {@link Iterator Iterator} instance appear to be an * {@link Enumeration Enumeration} instance. * + * @param the type of elements returned by this iterator. * @since 1.0 */ public class IteratorEnumeration implements Enumeration { diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java index 86b7bd187..f193d83f1 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java +++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorIterable.java @@ -60,6 +60,7 @@ import org.apache.commons.collections4.ResettableIterator; * Iterable<Integer> iterable = new IteratorIterable<Integer>(iterator, true); * * + * @param the type of elements returned by this iterator. * @since 4.0 */ public class IteratorIterable implements Iterable { diff --git a/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java index a3cbb4f88..4c2614b58 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java @@ -33,6 +33,7 @@ import org.apache.commons.collections4.ResettableIterator; * Concurrent modifications are not directly supported, and for most collection * implementations will throw a ConcurrentModificationException. * + * @param the type of elements returned by this iterator. * @since 3.0 */ public class LoopingIterator implements ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java index 50b5c6a97..0f1fc3dd1 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java @@ -35,6 +35,7 @@ import org.apache.commons.collections4.ResettableListIterator; * collection implementations will throw a * ConcurrentModificationException. * + * @param the type of elements returned by this iterator. * @since 3.2 */ public class LoopingListIterator implements ResettableListIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java index 7d6883e9a..da6c86437 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java @@ -29,7 +29,7 @@ import org.apache.commons.collections4.ResettableIterator; * The iterator implements a {@link #reset} method, allowing the reset of the iterator * back to the start if required. * - * @param the type of elements returned by this iterator + * @param the type of elements returned by this iterator. * @since 3.0 */ public class ObjectArrayIterator implements ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java index 758f1e222..ae9e1d081 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java @@ -29,6 +29,7 @@ import org.apache.commons.collections4.ResettableListIterator; * The iterator implements a {@link #reset} method, allowing the reset of the iterator * back to the start if required. * + * @param the type of elements returned by this iterator. * @see org.apache.commons.collections4.iterators.ObjectArrayIterator * @see java.util.Iterator * @see java.util.ListIterator diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java index 0eb97a095..4ae0c878c 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java @@ -71,6 +71,7 @@ import org.apache.commons.collections4.Transformer; * Under many circumstances, linking Iterators together in this manner is * more efficient (and convenient) than using nested for loops to extract a list. * + * @param the type of elements returned by this iterator. * @since 3.1 */ public class ObjectGraphIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java index f795fbe31..d28060bf6 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java @@ -28,6 +28,7 @@ import java.util.Objects; * will be thrown if {@link #remove()} is called directly after a call to * {@link #peek()} or {@link #element()}. * + * @param the type of elements returned by this iterator. * @since 4.0 */ public class PeekingIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java b/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java index 3f79721aa..a52935447 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java @@ -31,6 +31,7 @@ import java.util.Objects; * The decorator does not support the removal operation. Any call to {@link #remove()} will * result in an {@link UnsupportedOperationException}. * + * @param the type of elements returned by this iterator. * @since 4.0 */ public class PushbackIterator implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java index ff4c2d873..3e45aa8c5 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java @@ -34,6 +34,7 @@ import org.apache.commons.collections4.ResettableListIterator; * index in the list, thus it starts high and reduces as the iteration * continues. The previous methods work similarly. * + * @param the type of elements returned by this iterator. * @since 3.2 */ public class ReverseListIterator implements ResettableListIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java index 6ccec888f..95b018f9a 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java @@ -24,6 +24,7 @@ import org.apache.commons.collections4.ResettableIterator; * {@code SingletonIterator} is an {@link java.util.Iterator} over a single * object instance. * + * @param the type of elements returned by this iterator. * @since 2.0 */ public class SingletonIterator diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java index 312f393f8..5f4ea6027 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java @@ -24,6 +24,7 @@ import org.apache.commons.collections4.ResettableListIterator; * {@code SingletonIterator} is an {@link java.util.ListIterator} over a single * object instance. * + * @param the type of elements returned by this iterator. * @since 2.1 */ public class SingletonListIterator implements ResettableListIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/SkippingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SkippingIterator.java index 5be06cfad..f86559b2f 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SkippingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SkippingIterator.java @@ -23,6 +23,7 @@ import java.util.Iterator; * before that position. *

* + * @param the type of elements returned by this iterator. * @since 4.1 */ public class SkippingIterator extends AbstractIteratorDecorator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/UniqueFilterIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UniqueFilterIterator.java index 80b01de72..059bbec85 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UniqueFilterIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UniqueFilterIterator.java @@ -25,6 +25,7 @@ import org.apache.commons.collections4.functors.UniquePredicate; * the Iterator maintains a Set of objects it has already encountered, * and duplicate Objects are skipped. * + * @param the type of elements returned by this iterator. * @since 2.1 */ public class UniqueFilterIterator extends FilterIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java index 0992cb850..13b80525d 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.Unmodifiable; * Attempts to modify it will result in an UnsupportedOperationException. *

* + * @param the type of elements returned by this iterator. * @since 3.0 */ public final class UnmodifiableIterator implements Iterator, Unmodifiable { 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 3178d5ed0..a325b3440 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.Unmodifiable; * Attempts to modify it will result in an UnsupportedOperationException. *

* + * @param the type of elements returned by this iterator. * @since 3.0 */ public final class UnmodifiableListIterator implements ListIterator, Unmodifiable { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ZippingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ZippingIterator.java index 5e6ba8de6..0844385ab 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ZippingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ZippingIterator.java @@ -33,6 +33,7 @@ import org.apache.commons.collections4.FluentIterable; * and {@code B.next()} until both iterators are exhausted. *

* + * @param the type of elements returned by this iterator. * @since 4.1 */ public class ZippingIterator implements Iterator {