Javadoc: Add missing @param tags for generics.

src/main/java/org/apache/commons/collections4/BoundedCollection.java

@@ -28,6 +28,7 @@ import java.util.Collection;
  * @see CollectionUtils#isFull
  * @see CollectionUtils#maxSize
  *
+ * @param <E> the type of elements in this collection
  * @since 3.0
  */
 public interface BoundedCollection<E> extends Collection<E> {

src/main/java/org/apache/commons/collections4/BoundedMap.java

@@ -23,6 +23,8 @@ package org.apache.commons.collections4;
  * maximum number of elements. This interface allows the querying of details
  * associated with the maximum number of elements.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public interface BoundedMap<K, V> extends IterableMap<K, V> {

src/main/java/org/apache/commons/collections4/IterableMap.java

@@ -33,10 +33,11 @@ import java.util.Map;
  * }
  * </pre>
  *
- * @param <K> the type of the keys in the map
+ * @param <K> the type of the keys in this map
- * @param <V> the type of the values in the map
+ * @param <V> the type of the values in this map
  *
  * @since 3.0
  */
 public interface IterableMap<K, V> extends Map<K, V>, Put<K, V>, IterableGet<K, V> {
+    // empty
 }

src/main/java/org/apache/commons/collections4/MultiMap.java

@@ -39,6 +39,9 @@ import java.util.Collection;
  * These were added solely for documentation purposes and do not change the interface
  * as they were defined in the superinterface <code>Map</code> anyway.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @since 2.0
  * @deprecated since 4.1, use {@link MultiValuedMap} instead
  */

src/main/java/org/apache/commons/collections4/Trie.java

@@ -22,6 +22,8 @@ import java.util.SortedMap;
  * Defines the interface for a prefix tree, an ordered tree data structure. For
  * more information, see <a href="http://en.wikipedia.org/wiki/Trie">Tries</a>.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.0
  */
 public interface Trie<K, V> extends IterableSortedMap<K, V> {

src/main/java/org/apache/commons/collections4/bidimap/AbstractBidiMapDecorator.java

@@ -34,6 +34,8 @@ import org.apache.commons.collections4.map.AbstractMapDecorator;
  * it would provide a loophole around the validation.
  * But, you might want that loophole, so this class is kept simple.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public abstract class AbstractBidiMapDecorator<K, V>

src/main/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecorator.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections4.OrderedMapIterator;
  * it would provide a loophole around the validation.
  * But, you might want that loophole, so this class is kept simple.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public abstract class AbstractOrderedBidiMapDecorator<K, V>

src/main/java/org/apache/commons/collections4/bidimap/AbstractSortedBidiMapDecorator.java

@@ -33,6 +33,8 @@ import org.apache.commons.collections4.SortedBidiMap;
  * it would provide a loophole around the validation.
  * But, you might want that loophole, so this class is kept simple.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public abstract class AbstractSortedBidiMapDecorator<K, V>

src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java

@@ -49,6 +49,8 @@ import org.apache.commons.collections4.map.AbstractSortedMapDecorator;
  * NOTE: From Commons Collections 3.1, all subclasses will use {@link TreeMap}
  * and the flawed <code>createMap</code> method is ignored.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V>

src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java

@@ -72,6 +72,9 @@ import org.apache.commons.collections4.keyvalue.UnmodifiableMapEntry;
  * not allow setValue() and will throw an
  * UnsupportedOperationException on attempts to call that method.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @since 3.0 (previously DoubleOrderedMap v2.0)
  */
 public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>>

src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableBidiMap<K, V>

src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableOrderedBidiMap<K, V>

src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java

@@ -33,6 +33,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an {@link UnsupportedOperationException}.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableSortedBidiMap<K, V>

src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java

@@ -37,6 +37,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type of elements in this collection
  * @since 3.0
  */
 public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDecorator<E>

src/main/java/org/apache/commons/collections4/list/FixedSizeList.java

@@ -33,6 +33,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of elements in this collection
  * @since 3.0
  */
 public class FixedSizeList<E>

src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java

@@ -52,6 +52,8 @@ import org.apache.commons.collections4.iterators.EmptyMapIterator;
  * This is to provide backwards compatibility for ReferenceMap between v3.0 and v3.1.
  * This extends clause will be removed in v5.0.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements IterableMap<K, V> {

src/main/java/org/apache/commons/collections4/map/AbstractIterableMap.java

@@ -22,6 +22,8 @@ import org.apache.commons.collections4.MapIterator;
 /**
  * Provide a basic {@link IterableMap} implementation.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.0
  */
 public abstract class AbstractIterableMap<K, V> implements IterableMap<K, V> {

src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java

@@ -56,6 +56,8 @@ import org.apache.commons.collections4.iterators.EmptyOrderedMapIterator;
  * The implementation is also designed to be subclassed, with lots of useful
  * methods exposed.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> implements OrderedMap<K, V> {

src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java

@@ -31,6 +31,8 @@ import org.apache.commons.collections4.OrderedMapIterator;
  * it would provide a loophole around the validation.
  * But, you might want that loophole, so this class is kept simple.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public abstract class AbstractOrderedMapDecorator<K, V> extends AbstractMapDecorator<K, V>

src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java

@@ -75,6 +75,9 @@ import org.apache.commons.collections4.keyvalue.DefaultMapEntry;
  * You can use {@link java.util.Collections#synchronizedMap} to
  * provide synchronized access to a <code>ReferenceMap</code>.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @see java.lang.ref.Reference
  * @since 3.1 (extracted from ReferenceMap in 3.0)
  */

src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java

@@ -59,6 +59,8 @@ import java.util.Map;
  * exceptions when accessed by concurrent threads without synchronization.
  * </p>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class CaseInsensitiveMap<K, V> extends AbstractHashedMap<K, V> implements Serializable, Cloneable {

src/main/java/org/apache/commons/collections4/map/CompositeMap.java

@@ -39,6 +39,8 @@ import org.apache.commons.collections4.collection.CompositeCollection;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Serializable {

src/main/java/org/apache/commons/collections4/map/DefaultedMap.java

@@ -56,8 +56,10 @@ import org.apache.commons.collections4.functors.FactoryTransformer;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
- * @since 3.2
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * 
+ * @since 3.2
  * @see LazyMap
  */
 public class DefaultedMap<K, V> extends AbstractMapDecorator<K, V> implements Serializable {

src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java

@@ -49,6 +49,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class FixedSizeMap<K, V>

src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java

@@ -51,6 +51,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class FixedSizeSortedMap<K, V>

src/main/java/org/apache/commons/collections4/map/Flat3Map.java

@@ -67,6 +67,8 @@ import org.apache.commons.collections4.iterators.EmptyMapIterator;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneable {

src/main/java/org/apache/commons/collections4/map/HashedMap.java

@@ -36,6 +36,8 @@ import java.util.Map;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class HashedMap<K, V>

src/main/java/org/apache/commons/collections4/map/LRUMap.java

@@ -54,6 +54,8 @@ import org.apache.commons.collections4.BoundedMap;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * <code>NullPointerException</code>'s when accessed by concurrent threads.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0 (previously in main package v1.0)
  */
 public class LRUMap<K, V>

src/main/java/org/apache/commons/collections4/map/LazyMap.java

@@ -56,6 +56,8 @@ import org.apache.commons.collections4.functors.FactoryTransformer;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class LazyMap<K, V> extends AbstractMapDecorator<K, V> implements Serializable {

src/main/java/org/apache/commons/collections4/map/LazySortedMap.java

@@ -53,6 +53,8 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class LazySortedMap<K,V> extends LazyMap<K,V> implements SortedMap<K,V> {

src/main/java/org/apache/commons/collections4/map/LinkedMap.java

@@ -57,6 +57,8 @@ import org.apache.commons.collections4.list.UnmodifiableList;
  * using {@link java.util.Collections#synchronizedMap(Map)}. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class LinkedMap<K, V> extends AbstractLinkedMap<K, V> implements Serializable, Cloneable {

src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java

@@ -72,6 +72,8 @@ import org.apache.commons.collections4.list.UnmodifiableList;
  * <p>
  * This class is {@link Serializable} starting with Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class ListOrderedMap<K, V>

src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java

@@ -71,6 +71,8 @@ import org.apache.commons.collections4.keyvalue.MultiKey;
  * appropriate synchronization. This class may throw exceptions when accessed
  * by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.1
  */
 public class MultiKeyMap<K, V> extends AbstractMapDecorator<MultiKey<? extends K>, V>

src/main/java/org/apache/commons/collections4/map/MultiValueMap.java

@@ -59,6 +59,8 @@ import org.apache.commons.collections4.iterators.TransformIterator;
  * appropriate synchronization. This class may throw exceptions when accessed
  * by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.2
  * @deprecated since 4.1, use {@link org.apache.commons.collections4.MultiValuedMap MultiValuedMap} instead
  */

src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java

@@ -55,8 +55,8 @@ import java.util.concurrent.TimeUnit;
  * synchronization.
  * </p>
  *
- * @param <K> the type of the keys in the map
+ * @param <K> the type of the keys in this map
- * @param <V> the type of the values in the map
+ * @param <V> the type of the values in this map
  * @since 4.0
  */
 public class PassiveExpiringMap<K, V>

src/main/java/org/apache/commons/collections4/map/PredicatedMap.java

@@ -44,6 +44,8 @@ import org.apache.commons.collections4.Predicate;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class PredicatedMap<K, V>

src/main/java/org/apache/commons/collections4/map/PredicatedSortedMap.java

@@ -45,6 +45,8 @@ import org.apache.commons.collections4.Predicate;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class PredicatedSortedMap<K, V> extends PredicatedMap<K, V> implements SortedMap<K, V> {

src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java

@@ -70,8 +70,10 @@ import java.lang.ref.Reference;
  * exceptions when accessed by concurrent threads without synchronization.
  * </p>
  *
- * @see java.lang.ref.Reference
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * 
+ * @see java.lang.ref.Reference
  * @since 3.0 (previously in main package v2.1)
  */
 public class ReferenceIdentityMap<K, V> extends AbstractReferenceMap<K, V> implements Serializable {

src/main/java/org/apache/commons/collections4/map/SingletonMap.java

@@ -53,6 +53,8 @@ import org.apache.commons.collections4.keyvalue.TiedMapEntry;
  * <li>the <code>KeyValue</code> interface (just cast - no object creation)
  * </ul>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.1
  */
 public class SingletonMap<K, V>

src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java

@@ -90,6 +90,8 @@ import org.apache.commons.collections4.KeyValue;
  * iterations, or if you can make your own guarantees about how bulk
  * operations will affect the map.<p>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0 (previously in main package v2.1)
  */
 public final class StaticBucketMap<K, V> extends AbstractIterableMap<K, V> {

src/main/java/org/apache/commons/collections4/map/TransformedMap.java

@@ -40,8 +40,11 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  * <p>
- * @see org.apache.commons.collections4.splitmap.TransformedSplitMap
  * 
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
+ * @see org.apache.commons.collections4.splitmap.TransformedSplitMap
  * @since 3.0
  */
 public class TransformedMap<K, V>

src/main/java/org/apache/commons/collections4/map/TransformedSortedMap.java

@@ -38,6 +38,8 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class TransformedSortedMap<K, V>

src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java

@@ -39,6 +39,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableMap<K, V>

src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java

@@ -38,6 +38,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableOrderedMap<K, V> extends AbstractOrderedMapDecorator<K, V> implements

src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java

@@ -37,6 +37,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public final class UnmodifiableSortedMap<K, V>

src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java

@@ -43,6 +43,7 @@ import org.apache.commons.collections4.BoundedCollection;
  * <p>
  * This queue prevents null objects from being added.
  *
+ * @param <E> the type of elements in this collection
  * @since 4.0
  */
 public class CircularFifoQueue<E> extends AbstractCollection<E>

src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java

@@ -27,6 +27,8 @@ import org.apache.commons.collections4.Trie;
  * This class provides some basic {@link Trie} functionality and
  * utility methods for actual bitwise {@link Trie} implementations.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.0
  */
 public abstract class AbstractBitwiseTrie<K, V> extends AbstractMap<K, V>

src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java

@@ -51,6 +51,8 @@ import org.apache.commons.collections4.trie.analyzer.StringKeyAnalyzer;
  * length & fixed length keys. Some methods, such as {@link #prefixMap(Object)}
  * are suited only to variable length keys.
  *
+ * @param <E> the type of the values in this map
+ * 
  * @see <a href="http://en.wikipedia.org/wiki/Radix_tree">Radix Tree</a>
  * @see <a href="http://www.csse.monash.edu.au/~lloyd/tildeAlgDS/Tree/PATRICIA">PATRICIA</a>
  * @see <a href="http://www.imperialviolet.org/binary/critbit.pdf">Crit-Bit Tree</a>

src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java

@@ -32,6 +32,8 @@ import org.apache.commons.collections4.iterators.UnmodifiableOrderedMapIterator;
 /**
  * An unmodifiable {@link Trie}.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.0
  */
 public class UnmodifiableTrie<K, V> implements Trie<K, V>, Serializable, Unmodifiable {

src/test/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecoratorTest.java

@@ -24,6 +24,8 @@ import org.apache.commons.collections4.OrderedBidiMap;
 /**
  * Test class for AbstractOrderedBidiMapDecorator.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  */
 public class AbstractOrderedBidiMapDecoratorTest<K, V>
         extends AbstractOrderedBidiMapTest<K, V> {

src/test/java/org/apache/commons/collections4/map/IdentityMap.java

@@ -40,6 +40,8 @@ import java.util.Map;
  * From 4.0, this class is replaced by java.util.IdentityHashMap but kept as a
  * test-class because it is still used by the ReferenceIdentityMapTest.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 3.0
  */
 public class IdentityMap<K, V>