diff --git a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java index 0640925cc..285031268 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java @@ -332,6 +332,10 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class View. + * + * @param the type of the keys in the map. + * @param the type of the values in the map. + * @param the type of the elements in the collection. */ protected abstract static class View extends AbstractCollectionDecorator { @@ -432,6 +436,8 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class KeySet. + * + * @param the type of elements maintained by this set */ protected static class KeySet extends View implements Set { @@ -471,6 +477,8 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class KeySetIterator. + * + * @param the key type. */ protected static class KeySetIterator extends AbstractIteratorDecorator { @@ -515,6 +523,8 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class Values. + * + * @param the type of the values. */ protected static class Values extends View implements Set { @@ -554,6 +564,8 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class ValuesIterator. + * + * @param the value type. */ protected static class ValuesIterator extends AbstractIteratorDecorator { @@ -598,6 +610,9 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class EntrySet. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class EntrySet extends View> implements Set> { @@ -639,6 +654,9 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class EntrySetIterator. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class EntrySetIterator extends AbstractIteratorDecorator> { @@ -684,6 +702,9 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class MapEntry. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class MapEntry extends AbstractMapEntryDecorator { @@ -715,6 +736,9 @@ public abstract class AbstractDualBidiMap implements BidiMap { /** * Inner class MapIterator. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class BidiMapIterator implements MapIterator, ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java index 7c3639d06..0c38a97d4 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java @@ -231,6 +231,9 @@ public class DualTreeBidiMap extends AbstractDualBidiMap /** * Internal sorted map view. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class ViewMap extends AbstractSortedMapDecorator { /** @@ -293,6 +296,9 @@ public class DualTreeBidiMap extends AbstractDualBidiMap /** * Inner class MapIterator. + * + * @param the type of the keys. + * @param the type of the values. */ protected static class BidiOrderedMapIterator implements OrderedMapIterator, ResettableIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractIteratorDecorator.java index 70b2394d1..b40a17103 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/AbstractIteratorDecorator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractIteratorDecorator.java @@ -22,7 +22,9 @@ import java.util.Iterator; * Provides basic behavior for decorating an iterator with extra functionality. *

* All methods are forwarded to the decorated iterator. + *

* + * @param the type of the iterator being decorated. * @since 3.0 */ public abstract class AbstractIteratorDecorator extends AbstractUntypedIteratorDecorator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java index 3b4d67a08..44ddcbfdb 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java @@ -23,7 +23,9 @@ import java.util.Objects; * Provides basic behavior for decorating a list iterator with extra functionality. *

* All methods are forwarded to the decorated list iterator. + *

* + * @param the type of elements in this iterator. * @since 3.0 */ public class AbstractListIteratorDecorator implements ListIterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java index f24c888d8..59e817a84 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java @@ -20,10 +20,13 @@ import java.util.Iterator; import java.util.Objects; /** - * Provides basic behavior for decorating an iterator with extra functionality - * without committing the generic type of the Iterator implementation. + * Provides basic behavior for decorating an iterator with extra functionality without committing the generic type of the Iterator implementation. *

* All methods are forwarded to the decorated iterator. + *

+ * + * @param the type of the iterator being decorated. + * @param the type of elements returned by this iterator. * * @since 4.0 */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java index 4a153cb3f..61b8ba8a9 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java +++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java @@ -46,6 +46,7 @@ import java.util.Queue; * removed and {@link #size()} will return the number of remaining iterators in * the queue. * + * @param the type of elements in this iterator. * @since 2.1 */ public class IteratorChain implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java b/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java index de658845e..94811a9b1 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java +++ b/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java @@ -43,6 +43,7 @@ import java.util.Iterator; * NOTE: The LazyIteratorChain may contain no iterators. In this case the class will * function as an empty iterator. * + * @param the type of elements in this iterator. * @since 4.0 */ public abstract class LazyIteratorChain implements Iterator { diff --git a/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java b/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java index 48ab29f16..68060e630 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java @@ -43,6 +43,7 @@ import org.apache.commons.collections4.ResettableListIterator; *

* This class implements ResettableListIterator from Commons Collections 3.2. * + * @param the type of elements in this iterator. * @since 2.1 */ public class ListIteratorWrapper implements ResettableListIterator { diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java index f282c42a0..ce1b539a7 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java @@ -41,6 +41,7 @@ import org.apache.commons.collections4.OrderedIterator; * is here. *

* + * @param the type of elements in this list * @since 3.0 */ public abstract class AbstractLinkedList implements List { @@ -745,6 +746,8 @@ public abstract class AbstractLinkedList implements List { /** * A list iterator over the linked list. + * + * @param the type of elements in this iterator. */ protected static class LinkedListIterator implements ListIterator, OrderedIterator { @@ -904,6 +907,8 @@ public abstract class AbstractLinkedList implements List { /** * A list iterator over the linked sub list. + * + * @param the type of elements in this iterator. */ protected static class LinkedSubListIterator extends LinkedListIterator { @@ -947,6 +952,8 @@ public abstract class AbstractLinkedList implements List { /** * The sublist implementation for AbstractLinkedList. + * + * @param the type of elements in this list. */ protected static class LinkedSubList extends AbstractList { /** The main list */ diff --git a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java index 394a7ea63..828a3b894 100644 --- a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java @@ -392,6 +392,8 @@ public class CursorableLinkedList extends AbstractLinkedList implements Se /** * An extended {@code ListIterator} that allows concurrent changes to * the underlying list. + * + * @param the type of elements in this cursor. */ public static class Cursor extends AbstractLinkedList.LinkedListIterator { /** Is the cursor valid (not closed) */ @@ -562,6 +564,7 @@ public class CursorableLinkedList extends AbstractLinkedList implements Se /** * A cursor for the sublist based on LinkedSubListIterator. * + * @param the type of elements in this cursor. * @since 3.2 */ protected static class SubCursor extends Cursor {