Javadoc: Add missing tags.

This commit is contained in:
Gary Gregory 2020-01-11 20:15:31 -05:00
parent 64420e34cc
commit de7cb0105b
30 changed files with 31 additions and 7 deletions

View File

@ -24,7 +24,7 @@ import java.util.Iterator;
* This iterator allows both forward and reverse iteration through the container. * This iterator allows both forward and reverse iteration through the container.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator * @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public interface OrderedIterator<E> extends Iterator<E> { public interface OrderedIterator<E> extends Iterator<E> {

View File

@ -24,7 +24,7 @@ import java.util.Iterator;
* This interface allows an iterator to be repeatedly reused. * This interface allows an iterator to be repeatedly reused.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator * @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public interface ResettableIterator<E> extends Iterator<E> { public interface ResettableIterator<E> extends Iterator<E> {

View File

@ -24,9 +24,9 @@ import java.util.ListIterator;
* This interface allows an iterator to be repeatedly reused. * This interface allows an iterator to be repeatedly reused.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator * @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public interface ResettableListIterator<E> extends ListIterator<E>, ResettableIterator<E>, OrderedIterator<E> { public interface ResettableListIterator<E> extends ListIterator<E>, ResettableIterator<E>, OrderedIterator<E> {
// empty
} }

View File

@ -32,7 +32,7 @@ import org.apache.commons.collections4.ResettableIterator;
* The iterator implements a {@link #reset} method, allowing the reset of * The iterator implements a {@link #reset} method, allowing the reset of
* the iterator back to the start if required. * the iterator back to the start if required.
* *
* @param <E> the type of elements returned by this iterator * @param <E> the type of elements returned by this iterator.
* @since 1.0 * @since 1.0
*/ */
public class ArrayIterator<E> implements ResettableIterator<E> { public class ArrayIterator<E> implements ResettableIterator<E> {

View File

@ -32,6 +32,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* This iterator does not support {@link #add(Object)} or {@link #remove()}, as the array * 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. * cannot be changed in size. The {@link #set(Object)} method is supported however.
* *
* @param <E> the type of elements returned by this iterator.
* @see org.apache.commons.collections4.iterators.ArrayIterator * @see org.apache.commons.collections4.iterators.ArrayIterator
* @see java.util.Iterator * @see java.util.Iterator
* @see java.util.ListIterator * @see java.util.ListIterator

View File

@ -29,6 +29,7 @@ import java.util.Objects;
* iterator is immediately advanced to this position, skipping all elements * iterator is immediately advanced to this position, skipping all elements
* before that position. * before that position.
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.1 * @since 4.1
*/ */
public class BoundedIterator<E> implements Iterator<E> { public class BoundedIterator<E> implements Iterator<E> {

View File

@ -36,6 +36,7 @@ import org.apache.commons.collections4.list.UnmodifiableList;
* {@code B}, the {@link #next} method on this iterator will return the * {@code B}, the {@link #next} method on this iterator will return the
* lesser of {@code A.next()} and {@code B.next()}. * lesser of {@code A.next()} and {@code B.next()}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.1 * @since 2.1
*/ */
public class CollatingIterator<E> implements Iterator<E> { public class CollatingIterator<E> implements Iterator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.ResettableIterator;
* This class provides for binary compatibility between Commons Collections * This class provides for binary compatibility between Commons Collections
* 2.1.1 and 3.1 due to issues with {@code IteratorUtils}. * 2.1.1 and 3.1 due to issues with {@code IteratorUtils}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.1.1 and 3.1 * @since 2.1.1 and 3.1
*/ */
public class EmptyIterator<E> extends AbstractEmptyIterator<E> implements ResettableIterator<E> { public class EmptyIterator<E> extends AbstractEmptyIterator<E> implements ResettableIterator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* provides for binary compatibility between Commons Collections 2.1.1 and 3.1 * provides for binary compatibility between Commons Collections 2.1.1 and 3.1
* due to issues with {@code IteratorUtils}. * due to issues with {@code IteratorUtils}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.1.1 and 3.1 * @since 2.1.1 and 3.1
*/ */
public class EmptyListIterator<E> extends AbstractEmptyIterator<E> implements public class EmptyListIterator<E> extends AbstractEmptyIterator<E> implements

View File

@ -22,7 +22,7 @@ import org.apache.commons.collections4.ResettableIterator;
/** /**
* Provides an implementation of an empty ordered iterator. * Provides an implementation of an empty ordered iterator.
* *
* @param <E> the type to iterate. * @param <E> the type of elements returned by this iterator.
* @since 3.1 * @since 3.1
*/ */
public class EmptyOrderedIterator<E> extends AbstractEmptyIterator<E> public class EmptyOrderedIterator<E> extends AbstractEmptyIterator<E>

View File

@ -24,6 +24,7 @@ import java.util.Iterator;
* Adapter to make {@link Enumeration Enumeration} instances appear * Adapter to make {@link Enumeration Enumeration} instances appear
* to be {@link Iterator Iterator} instances. * to be {@link Iterator Iterator} instances.
* *
* @param <E> the type of elements returned by this iterator.
* @since 1.0 * @since 1.0
*/ */
public class EnumerationIterator<E> implements Iterator<E> { public class EnumerationIterator<E> implements Iterator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.Predicate;
* This iterator decorates the underlying iterator, only allowing through * This iterator decorates the underlying iterator, only allowing through
* those elements that match the specified {@link Predicate Predicate}. * those elements that match the specified {@link Predicate Predicate}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 1.0 * @since 1.0
*/ */
public class FilterIterator<E> implements Iterator<E> { public class FilterIterator<E> implements Iterator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.Predicate;
* This iterator decorates the underlying iterator, only allowing through * This iterator decorates the underlying iterator, only allowing through
* those elements that match the specified {@link Predicate Predicate}. * those elements that match the specified {@link Predicate Predicate}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.0 * @since 2.0
*/ */
public class FilterListIterator<E> implements ListIterator<E> { public class FilterListIterator<E> implements ListIterator<E> {

View File

@ -23,6 +23,7 @@ import java.util.Iterator;
* Adapter to make an {@link Iterator Iterator} instance appear to be an * Adapter to make an {@link Iterator Iterator} instance appear to be an
* {@link Enumeration Enumeration} instance. * {@link Enumeration Enumeration} instance.
* *
* @param <E> the type of elements returned by this iterator.
* @since 1.0 * @since 1.0
*/ */
public class IteratorEnumeration<E> implements Enumeration<E> { public class IteratorEnumeration<E> implements Enumeration<E> {

View File

@ -60,6 +60,7 @@ import org.apache.commons.collections4.ResettableIterator;
* Iterable&lt;Integer&gt; iterable = new IteratorIterable&lt;Integer&gt;(iterator, true); * Iterable&lt;Integer&gt; iterable = new IteratorIterable&lt;Integer&gt;(iterator, true);
* </pre> * </pre>
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.0 * @since 4.0
*/ */
public class IteratorIterable<E> implements Iterable<E> { public class IteratorIterable<E> implements Iterable<E> {

View File

@ -33,6 +33,7 @@ import org.apache.commons.collections4.ResettableIterator;
* Concurrent modifications are not directly supported, and for most collection * Concurrent modifications are not directly supported, and for most collection
* implementations will throw a ConcurrentModificationException. * implementations will throw a ConcurrentModificationException.
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public class LoopingIterator<E> implements ResettableIterator<E> { public class LoopingIterator<E> implements ResettableIterator<E> {

View File

@ -35,6 +35,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* collection implementations will throw a * collection implementations will throw a
* ConcurrentModificationException. * ConcurrentModificationException.
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.2 * @since 3.2
*/ */
public class LoopingListIterator<E> implements ResettableListIterator<E> { public class LoopingListIterator<E> implements ResettableListIterator<E> {

View File

@ -29,7 +29,7 @@ import org.apache.commons.collections4.ResettableIterator;
* The iterator implements a {@link #reset} method, allowing the reset of the iterator * The iterator implements a {@link #reset} method, allowing the reset of the iterator
* back to the start if required. * back to the start if required.
* *
* @param <E> the type of elements returned by this iterator * @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public class ObjectArrayIterator<E> implements ResettableIterator<E> { public class ObjectArrayIterator<E> implements ResettableIterator<E> {

View File

@ -29,6 +29,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* The iterator implements a {@link #reset} method, allowing the reset of the iterator * The iterator implements a {@link #reset} method, allowing the reset of the iterator
* back to the start if required. * back to the start if required.
* *
* @param <E> the type of elements returned by this iterator.
* @see org.apache.commons.collections4.iterators.ObjectArrayIterator * @see org.apache.commons.collections4.iterators.ObjectArrayIterator
* @see java.util.Iterator * @see java.util.Iterator
* @see java.util.ListIterator * @see java.util.ListIterator

View File

@ -71,6 +71,7 @@ import org.apache.commons.collections4.Transformer;
* Under many circumstances, linking Iterators together in this manner is * Under many circumstances, linking Iterators together in this manner is
* more efficient (and convenient) than using nested for loops to extract a list. * more efficient (and convenient) than using nested for loops to extract a list.
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.1 * @since 3.1
*/ */
public class ObjectGraphIterator<E> implements Iterator<E> { public class ObjectGraphIterator<E> implements Iterator<E> {

View File

@ -28,6 +28,7 @@ import java.util.Objects;
* will be thrown if {@link #remove()} is called directly after a call to * will be thrown if {@link #remove()} is called directly after a call to
* {@link #peek()} or {@link #element()}. * {@link #peek()} or {@link #element()}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.0 * @since 4.0
*/ */
public class PeekingIterator<E> implements Iterator<E> { public class PeekingIterator<E> implements Iterator<E> {

View File

@ -31,6 +31,7 @@ import java.util.Objects;
* The decorator does not support the removal operation. Any call to {@link #remove()} will * The decorator does not support the removal operation. Any call to {@link #remove()} will
* result in an {@link UnsupportedOperationException}. * result in an {@link UnsupportedOperationException}.
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.0 * @since 4.0
*/ */
public class PushbackIterator<E> implements Iterator<E> { public class PushbackIterator<E> implements Iterator<E> {

View File

@ -34,6 +34,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* index in the list, thus it starts high and reduces as the iteration * index in the list, thus it starts high and reduces as the iteration
* continues. The previous methods work similarly. * continues. The previous methods work similarly.
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.2 * @since 3.2
*/ */
public class ReverseListIterator<E> implements ResettableListIterator<E> { public class ReverseListIterator<E> implements ResettableListIterator<E> {

View File

@ -24,6 +24,7 @@ import org.apache.commons.collections4.ResettableIterator;
* {@code SingletonIterator} is an {@link java.util.Iterator} over a single * {@code SingletonIterator} is an {@link java.util.Iterator} over a single
* object instance. * object instance.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.0 * @since 2.0
*/ */
public class SingletonIterator<E> public class SingletonIterator<E>

View File

@ -24,6 +24,7 @@ import org.apache.commons.collections4.ResettableListIterator;
* {@code SingletonIterator} is an {@link java.util.ListIterator} over a single * {@code SingletonIterator} is an {@link java.util.ListIterator} over a single
* object instance. * object instance.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.1 * @since 2.1
*/ */
public class SingletonListIterator<E> implements ResettableListIterator<E> { public class SingletonListIterator<E> implements ResettableListIterator<E> {

View File

@ -23,6 +23,7 @@ import java.util.Iterator;
* before that position. * before that position.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.1 * @since 4.1
*/ */
public class SkippingIterator<E> extends AbstractIteratorDecorator<E> { public class SkippingIterator<E> extends AbstractIteratorDecorator<E> {

View File

@ -25,6 +25,7 @@ import org.apache.commons.collections4.functors.UniquePredicate;
* the Iterator maintains a Set of objects it has already encountered, * the Iterator maintains a Set of objects it has already encountered,
* and duplicate Objects are skipped. * and duplicate Objects are skipped.
* *
* @param <E> the type of elements returned by this iterator.
* @since 2.1 * @since 2.1
*/ */
public class UniqueFilterIterator<E> extends FilterIterator<E> { public class UniqueFilterIterator<E> extends FilterIterator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableIterator<E> implements Iterator<E>, Unmodifiable { public final class UnmodifiableIterator<E> implements Iterator<E>, Unmodifiable {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator.
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmodifiable { public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmodifiable {

View File

@ -33,6 +33,7 @@ import org.apache.commons.collections4.FluentIterable;
* and {@code B.next()} until both iterators are exhausted. * and {@code B.next()} until both iterators are exhausted.
* </p> * </p>
* *
* @param <E> the type of elements returned by this iterator.
* @since 4.1 * @since 4.1
*/ */
public class ZippingIterator<E> implements Iterator<E> { public class ZippingIterator<E> implements Iterator<E> {