diff --git a/src/main/java/org/apache/commons/collections4/BoundedCollection.java b/src/main/java/org/apache/commons/collections4/BoundedCollection.java index e0472191b..2431cd535 100644 --- a/src/main/java/org/apache/commons/collections4/BoundedCollection.java +++ b/src/main/java/org/apache/commons/collections4/BoundedCollection.java @@ -28,6 +28,7 @@ import java.util.Collection; * @see CollectionUtils#isFull * @see CollectionUtils#maxSize * + * @param the type of elements in this collection * @since 3.0 */ public interface BoundedCollection extends Collection { diff --git a/src/main/java/org/apache/commons/collections4/BoundedMap.java b/src/main/java/org/apache/commons/collections4/BoundedMap.java index ec61cd787..cadc0abee 100644 --- a/src/main/java/org/apache/commons/collections4/BoundedMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public interface BoundedMap extends IterableMap { diff --git a/src/main/java/org/apache/commons/collections4/IterableMap.java b/src/main/java/org/apache/commons/collections4/IterableMap.java index 836aa2ab2..9c7fc1929 100644 --- a/src/main/java/org/apache/commons/collections4/IterableMap.java +++ b/src/main/java/org/apache/commons/collections4/IterableMap.java @@ -33,10 +33,11 @@ import java.util.Map; * } * * - * @param the type of the keys in the map - * @param the type of the values in the map + * @param the type of the keys in this map + * @param the type of the values in this map * * @since 3.0 */ public interface IterableMap extends Map, Put, IterableGet { + // empty } diff --git a/src/main/java/org/apache/commons/collections4/MultiMap.java b/src/main/java/org/apache/commons/collections4/MultiMap.java index 102451cc9..1d582d55e 100644 --- a/src/main/java/org/apache/commons/collections4/MultiMap.java +++ b/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 Map anyway. * + * @param the type of the keys in this map + * @param the type of the values in this map + * * @since 2.0 * @deprecated since 4.1, use {@link MultiValuedMap} instead */ diff --git a/src/main/java/org/apache/commons/collections4/Trie.java b/src/main/java/org/apache/commons/collections4/Trie.java index 326b7e7a6..9183a7d5d 100644 --- a/src/main/java/org/apache/commons/collections4/Trie.java +++ b/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 Tries. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 4.0 */ public interface Trie extends IterableSortedMap { diff --git a/src/main/java/org/apache/commons/collections4/bidimap/AbstractBidiMapDecorator.java b/src/main/java/org/apache/commons/collections4/bidimap/AbstractBidiMapDecorator.java index 14c151eee..d0e62e719 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractBidiMapDecorator.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public abstract class AbstractBidiMapDecorator diff --git a/src/main/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecorator.java b/src/main/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecorator.java index 15b005e44..e98f9351f 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecorator.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public abstract class AbstractOrderedBidiMapDecorator diff --git a/src/main/java/org/apache/commons/collections4/bidimap/AbstractSortedBidiMapDecorator.java b/src/main/java/org/apache/commons/collections4/bidimap/AbstractSortedBidiMapDecorator.java index 88b148b56..616ca44a4 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractSortedBidiMapDecorator.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public abstract class AbstractSortedBidiMapDecorator 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 18f8dfef0..0792f6080 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java +++ b/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 createMap method is ignored. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class DualTreeBidiMap extends AbstractDualBidiMap 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 5622cc175..b997c3b60 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map + * * @since 3.0 (previously DoubleOrderedMap v2.0) */ public class TreeBidiMap, V extends Comparable> 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 4f9052e24..500c6e1eb 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMap.java @@ -31,6 +31,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

* Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableBidiMap 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 a7d2d70bd..208844cdc 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableOrderedBidiMap.java @@ -31,6 +31,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

* Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableOrderedBidiMap 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 39389d291..4cff22b08 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/UnmodifiableSortedBidiMap.java @@ -33,6 +33,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

* Attempts to modify it will result in an {@link UnsupportedOperationException}. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableSortedBidiMap 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 2d298ff20..837c1eee5 100644 --- a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java +++ b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java @@ -37,6 +37,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator; *

* Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of elements in this collection * @since 3.0 */ public final class UnmodifiableBoundedCollection extends AbstractCollectionDecorator diff --git a/src/main/java/org/apache/commons/collections4/list/FixedSizeList.java b/src/main/java/org/apache/commons/collections4/list/FixedSizeList.java index 56fda3a7b..6e087a908 100644 --- a/src/main/java/org/apache/commons/collections4/list/FixedSizeList.java +++ b/src/main/java/org/apache/commons/collections4/list/FixedSizeList.java @@ -33,6 +33,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of elements in this collection * @since 3.0 */ public class FixedSizeList diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java index 1b91f3976..0e4b1565c 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class AbstractHashedMap extends AbstractMap implements IterableMap { diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractIterableMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractIterableMap.java index 2fd1739c2..6dcf1a57a 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractIterableMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 4.0 */ public abstract class AbstractIterableMap implements IterableMap { diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java index 1595a089a..670925c92 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public abstract class AbstractLinkedMap extends AbstractHashedMap implements OrderedMap { diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java b/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java index 568c1bca5..51a44f038 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public abstract class AbstractOrderedMapDecorator extends AbstractMapDecorator diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java index 82ac7e3cd..128741341 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java +++ b/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 ReferenceMap. * + * @param the type of the keys in this map + * @param the type of the values in this map + * * @see java.lang.ref.Reference * @since 3.1 (extracted from ReferenceMap in 3.0) */ diff --git a/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java b/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java index 334016c21..8eebc62aa 100644 --- a/src/main/java/org/apache/commons/collections4/map/CaseInsensitiveMap.java +++ b/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. *

* + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class CaseInsensitiveMap extends AbstractHashedMap implements Serializable, Cloneable { diff --git a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java index df19db91e..96710e204 100644 --- a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class CompositeMap extends AbstractIterableMap implements Serializable { diff --git a/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java b/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java index 89b4b776a..a9a23b1a9 100644 --- a/src/main/java/org/apache/commons/collections4/map/DefaultedMap.java +++ b/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. * + * @param the type of the keys in this map + * @param the type of the values in this map + * * @since 3.2 - * * @see LazyMap */ public class DefaultedMap extends AbstractMapDecorator implements Serializable { diff --git a/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java b/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java index 7322d12c0..a29e89c53 100644 --- a/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java +++ b/src/main/java/org/apache/commons/collections4/map/FixedSizeMap.java @@ -49,6 +49,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class FixedSizeMap diff --git a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java index 9b7c06e5f..66fec4cc9 100644 --- a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java @@ -51,6 +51,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class FixedSizeSortedMap diff --git a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java index c93e60179..aded12591 100644 --- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class Flat3Map implements IterableMap, Serializable, Cloneable { diff --git a/src/main/java/org/apache/commons/collections4/map/HashedMap.java b/src/main/java/org/apache/commons/collections4/map/HashedMap.java index 06353e4ff..fb8143e40 100644 --- a/src/main/java/org/apache/commons/collections4/map/HashedMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class HashedMap diff --git a/src/main/java/org/apache/commons/collections4/map/LRUMap.java b/src/main/java/org/apache/commons/collections4/map/LRUMap.java index d03754a0d..fde03594a 100644 --- a/src/main/java/org/apache/commons/collections4/map/LRUMap.java +++ b/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 * NullPointerException's when accessed by concurrent threads. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 (previously in main package v1.0) */ public class LRUMap diff --git a/src/main/java/org/apache/commons/collections4/map/LazyMap.java b/src/main/java/org/apache/commons/collections4/map/LazyMap.java index 51d933b8d..82cbdb97e 100644 --- a/src/main/java/org/apache/commons/collections4/map/LazyMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LazyMap.java @@ -56,6 +56,8 @@ import org.apache.commons.collections4.functors.FactoryTransformer; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class LazyMap extends AbstractMapDecorator implements Serializable { diff --git a/src/main/java/org/apache/commons/collections4/map/LazySortedMap.java b/src/main/java/org/apache/commons/collections4/map/LazySortedMap.java index a706c1b70..30dee1fb1 100644 --- a/src/main/java/org/apache/commons/collections4/map/LazySortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LazySortedMap.java @@ -53,6 +53,8 @@ import org.apache.commons.collections4.Transformer; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class LazySortedMap extends LazyMap implements SortedMap { diff --git a/src/main/java/org/apache/commons/collections4/map/LinkedMap.java b/src/main/java/org/apache/commons/collections4/map/LinkedMap.java index 3e73b7745..5454bc817 100644 --- a/src/main/java/org/apache/commons/collections4/map/LinkedMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class LinkedMap extends AbstractLinkedMap implements Serializable, Cloneable { diff --git a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java index 34bd0bd44..6dd9d79b1 100644 --- a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java @@ -72,6 +72,8 @@ import org.apache.commons.collections4.list.UnmodifiableList; *

* This class is {@link Serializable} starting with Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class ListOrderedMap diff --git a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java b/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java index 960a3ba48..1a0a769f9 100644 --- a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.1 */ public class MultiKeyMap extends AbstractMapDecorator, V> diff --git a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java index a9290065c..f500bfa34 100644 --- a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.2 * @deprecated since 4.1, use {@link org.apache.commons.collections4.MultiValuedMap MultiValuedMap} instead */ diff --git a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java index 32d2af053..91d0dfa11 100644 --- a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java +++ b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java @@ -55,8 +55,8 @@ import java.util.concurrent.TimeUnit; * synchronization. *

* - * @param the type of the keys in the map - * @param the type of the values in the map + * @param the type of the keys in this map + * @param the type of the values in this map * @since 4.0 */ public class PassiveExpiringMap diff --git a/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java b/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java index abcd11d8e..453249aa4 100644 --- a/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/PredicatedMap.java @@ -44,6 +44,8 @@ import org.apache.commons.collections4.Predicate; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class PredicatedMap diff --git a/src/main/java/org/apache/commons/collections4/map/PredicatedSortedMap.java b/src/main/java/org/apache/commons/collections4/map/PredicatedSortedMap.java index a2abd53b6..466846bcf 100644 --- a/src/main/java/org/apache/commons/collections4/map/PredicatedSortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/PredicatedSortedMap.java @@ -45,6 +45,8 @@ import org.apache.commons.collections4.Predicate; *

* This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class PredicatedSortedMap extends PredicatedMap implements SortedMap { diff --git a/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java b/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java index 270854d87..79323ec86 100644 --- a/src/main/java/org/apache/commons/collections4/map/ReferenceIdentityMap.java +++ b/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. *

* + * @param the type of the keys in this map + * @param 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 extends AbstractReferenceMap implements Serializable { diff --git a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java index 59fc61585..8b0b65443 100644 --- a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java +++ b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java @@ -53,6 +53,8 @@ import org.apache.commons.collections4.keyvalue.TiedMapEntry; *
  • the KeyValue interface (just cast - no object creation) * * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.1 */ public class SingletonMap diff --git a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java b/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java index 9915bbd0c..e6399bc05 100644 --- a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java +++ b/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.

    * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 (previously in main package v2.1) */ public final class StaticBucketMap extends AbstractIterableMap { diff --git a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java index fcd8287bc..4d8862ace 100644 --- a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java @@ -40,8 +40,11 @@ import org.apache.commons.collections4.Transformer; *

    * This class is Serializable from Commons Collections 3.1. *

    + * + * @param the type of the keys in this map + * @param the type of the values in this map + * * @see org.apache.commons.collections4.splitmap.TransformedSplitMap - * * @since 3.0 */ public class TransformedMap diff --git a/src/main/java/org/apache/commons/collections4/map/TransformedSortedMap.java b/src/main/java/org/apache/commons/collections4/map/TransformedSortedMap.java index 34a0082cc..5168fe3ab 100644 --- a/src/main/java/org/apache/commons/collections4/map/TransformedSortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/TransformedSortedMap.java @@ -38,6 +38,8 @@ import org.apache.commons.collections4.Transformer; *

    * This class is Serializable from Commons Collections 3.1. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class TransformedSortedMap diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java index 02378b684..ec57f1229 100644 --- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java +++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableMap.java @@ -39,6 +39,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

    * Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableMap diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java index d16860374..6b3b43bb4 100644 --- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableOrderedMap.java @@ -38,6 +38,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

    * Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableOrderedMap extends AbstractOrderedMapDecorator implements diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java index a49e85636..0383796d6 100644 --- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableSortedMap.java @@ -37,6 +37,8 @@ import org.apache.commons.collections4.set.UnmodifiableSet; *

    * Attempts to modify it will result in an UnsupportedOperationException. * + * @param the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public final class UnmodifiableSortedMap diff --git a/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java b/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java index 8beb531ef..b8bfe407a 100644 --- a/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java +++ b/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java @@ -43,6 +43,7 @@ import org.apache.commons.collections4.BoundedCollection; *

    * This queue prevents null objects from being added. * + * @param the type of elements in this collection * @since 4.0 */ public class CircularFifoQueue extends AbstractCollection diff --git a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java index 04f53fa98..986c4328f 100644 --- a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 4.0 */ public abstract class AbstractBitwiseTrie extends AbstractMap diff --git a/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java b/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java index 81ae5e981..b4e16fcd6 100644 --- a/src/main/java/org/apache/commons/collections4/trie/PatriciaTrie.java +++ b/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 the type of the values in this map + * * @see Radix Tree * @see PATRICIA * @see Crit-Bit Tree diff --git a/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java b/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java index a18f7ef30..d8041d4fa 100644 --- a/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 4.0 */ public class UnmodifiableTrie implements Trie, Serializable, Unmodifiable { diff --git a/src/test/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecoratorTest.java b/src/test/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecoratorTest.java index 9558a2c4a..c95c2bf94 100644 --- a/src/test/java/org/apache/commons/collections4/bidimap/AbstractOrderedBidiMapDecoratorTest.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map */ public class AbstractOrderedBidiMapDecoratorTest extends AbstractOrderedBidiMapTest { diff --git a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java b/src/test/java/org/apache/commons/collections4/map/IdentityMap.java index c3ecb5b05..8e83f5a87 100644 --- a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java +++ b/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 the type of the keys in this map + * @param the type of the values in this map * @since 3.0 */ public class IdentityMap