commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject commons-collections git commit: Javadoc: Add missing @param tags for generics.
Date Thu, 28 Dec 2017 20:56:08 GMT
Repository: commons-collections
Updated Branches:
  refs/heads/master 36d33722c -> 6044892b8


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/6044892b
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/6044892b
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/6044892b

Branch: refs/heads/master
Commit: 6044892b8817841714cb79200b944611a9c22944
Parents: 36d3372
Author: Gary Gregory <ggregory@apache.org>
Authored: Thu Dec 28 13:56:04 2017 -0700
Committer: Gary Gregory <ggregory@apache.org>
Committed: Thu Dec 28 13:56:04 2017 -0700

----------------------------------------------------------------------
 src/main/java/org/apache/commons/collections4/Get.java           | 4 +++-
 src/main/java/org/apache/commons/collections4/IterableGet.java   | 4 +++-
 src/main/java/org/apache/commons/collections4/Put.java           | 4 +++-
 .../apache/commons/collections4/bidimap/AbstractDualBidiMap.java | 3 +++
 .../org/apache/commons/collections4/bidimap/DualHashBidiMap.java | 3 +++
 .../commons/collections4/bidimap/DualLinkedHashBidiMap.java      | 3 +++
 .../commons/collections4/comparators/ComparableComparator.java   | 3 ++-
 .../apache/commons/collections4/comparators/ComparatorChain.java | 1 +
 .../commons/collections4/comparators/FixedOrderComparator.java   | 1 +
 .../apache/commons/collections4/comparators/NullComparator.java  | 1 +
 .../commons/collections4/comparators/ReverseComparator.java      | 3 ++-
 .../commons/collections4/comparators/TransformingComparator.java | 3 +++
 .../java/org/apache/commons/collections4/map/CompositeMap.java   | 3 +++
 .../commons/collections4/map/EntrySetToMapIteratorAdapter.java   | 3 +++
 .../java/org/apache/commons/collections4/map/ReferenceMap.java   | 4 +++-
 .../apache/commons/collections4/map/UnmodifiableEntrySet.java    | 3 +++
 .../commons/collections4/multiset/AbstractMapMultiSet.java       | 1 +
 .../apache/commons/collections4/multiset/AbstractMultiSet.java   | 1 +
 .../commons/collections4/multiset/AbstractMultiSetDecorator.java | 1 +
 .../org/apache/commons/collections4/multiset/HashMultiSet.java   | 1 +
 .../apache/commons/collections4/multiset/PredicatedMultiSet.java | 1 +
 .../commons/collections4/multiset/SynchronizedMultiSet.java      | 1 +
 .../commons/collections4/multiset/UnmodifiableMultiSet.java      | 1 +
 .../org/apache/commons/collections4/queue/PredicatedQueue.java   | 1 +
 .../org/apache/commons/collections4/queue/TransformedQueue.java  | 1 +
 .../org/apache/commons/collections4/queue/UnmodifiableQueue.java | 1 +
 .../collections4/set/AbstractSerializableSetDecorator.java       | 1 +
 .../apache/commons/collections4/set/AbstractSetDecorator.java    | 2 +-
 .../java/org/apache/commons/collections4/set/CompositeSet.java   | 1 +
 .../java/org/apache/commons/collections4/set/ListOrderedSet.java | 1 +
 .../java/org/apache/commons/collections4/set/MapBackedSet.java   | 2 ++
 .../apache/commons/collections4/set/PredicatedNavigableSet.java  | 1 +
 .../java/org/apache/commons/collections4/set/PredicatedSet.java  | 1 +
 .../org/apache/commons/collections4/set/PredicatedSortedSet.java | 1 +
 .../apache/commons/collections4/set/TransformedNavigableSet.java | 1 +
 .../java/org/apache/commons/collections4/set/TransformedSet.java | 1 +
 .../apache/commons/collections4/set/TransformedSortedSet.java    | 1 +
 .../commons/collections4/set/UnmodifiableNavigableSet.java       | 1 +
 .../org/apache/commons/collections4/set/UnmodifiableSet.java     | 1 +
 .../apache/commons/collections4/set/UnmodifiableSortedSet.java   | 1 +
 .../collections4/splitmap/AbstractIterableGetMapDecorator.java   | 2 ++
 .../commons/collections4/splitmap/TransformedSplitMap.java       | 4 ++++
 .../java/org/apache/commons/collections4/trie/KeyAnalyzer.java   | 1 +
 43 files changed, 72 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/Get.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/Get.java b/src/main/java/org/apache/commons/collections4/Get.java
index b414f8f..431155d 100644
--- a/src/main/java/org/apache/commons/collections4/Get.java
+++ b/src/main/java/org/apache/commons/collections4/Get.java
@@ -22,8 +22,10 @@ import java.util.Set;
 /**
  * The "read" subset of the {@link java.util.Map} interface.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @since 4.0
- *
  * @see Put
  */
 public interface Get<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/IterableGet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/IterableGet.java b/src/main/java/org/apache/commons/collections4/IterableGet.java
index 39c5bb8..abc0a9f 100644
--- a/src/main/java/org/apache/commons/collections4/IterableGet.java
+++ b/src/main/java/org/apache/commons/collections4/IterableGet.java
@@ -19,8 +19,10 @@ package org.apache.commons.collections4;
 /**
  * The "read" subset of the {@link java.util.Map} interface.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @since 4.0
- *
  * @see Put
  */
 public interface IterableGet<K, V> extends Get<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/Put.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/Put.java b/src/main/java/org/apache/commons/collections4/Put.java
index 438064f..8530f35 100644
--- a/src/main/java/org/apache/commons/collections4/Put.java
+++ b/src/main/java/org/apache/commons/collections4/Put.java
@@ -27,8 +27,10 @@ import java.util.Map;
  * of, a "reading" interface) and thus defines {@link #put(Object, Object)} as returning
  * {@link Object}.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
+ * 
  * @since 4.0
- *
  * @see Get
  */
 public interface Put<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
----------------------------------------------------------------------
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 450f29d..276d1b7 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
@@ -34,6 +34,9 @@ import org.apache.commons.collections4.keyvalue.AbstractMapEntryDecorator;
  * An implementation can be written simply by implementing the
  * {@link #createBidiMap(Map, Map, BidiMap)} method.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @see DualHashBidiMap
  * @see DualTreeBidiMap
  * @since 3.0

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/bidimap/DualHashBidiMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/bidimap/DualHashBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/DualHashBidiMap.java
index 742c5b2..0514cc7 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/DualHashBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/DualHashBidiMap.java
@@ -36,6 +36,9 @@ import org.apache.commons.collections4.BidiMap;
  * NOTE: From Commons Collections 3.1, all subclasses will use {@link HashMap}
  * and the flawed <code>createMap</code> method is ignored.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @since 3.0
  */
 public class DualHashBidiMap<K, V> extends AbstractDualBidiMap<K, V> implements
Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
b/src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
index 7374f6d..c1dd0a2 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/DualLinkedHashBidiMap.java
@@ -31,6 +31,9 @@ import org.apache.commons.collections4.BidiMap;
  * Two <code>LinkedHashMap</code> instances are used in this class.
  * This provides fast lookups at the expense of storing two sets of map entries and two linked
lists.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @since 4.0
  */
 public class DualLinkedHashBidiMap<K, V> extends AbstractDualBidiMap<K, V> implements
Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/ComparableComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/ComparableComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/ComparableComparator.java
index f5a548b..d3da147 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/ComparableComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/ComparableComparator.java
@@ -35,8 +35,9 @@ import java.util.Comparator;
  * This is no longer the case. See {@link #compare(Object, Object) compare} for
  * details.
  *
+ * @param <E> the type of objects compared by this comparator
+ * 
  * @since 2.0
- *
  * @see java.util.Collections#reverseOrder()
  */
 public class ComparableComparator<E extends Comparable<? super E>> implements
Comparator<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
index 408e611..3eb9ea0 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
@@ -44,6 +44,7 @@ import java.util.List;
  * thread-safe at construction time, but it <i>is</i> thread-safe to perform
  * multiple comparisons after all the setup operations are complete.
  *
+ * @param <E> the type of objects compared by this comparator
  * @since 2.0
  */
 public class ComparatorChain<E> implements Comparator<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
index b045c8a..bf80c2d 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
@@ -43,6 +43,7 @@ import java.util.Map;
  * <p>
  * This class is Serializable from Commons Collections 4.0.
  *
+ * @param <T> the type of objects compared by this comparator
  * @since 3.0
  */
 public class FixedOrderComparator<T> implements Comparator<T>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
index 9b4aa6f..dd31333 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
@@ -25,6 +25,7 @@ import org.apache.commons.collections4.ComparatorUtils;
  * A Comparator that will compare nulls to be either lower or higher than
  * other objects.
  *
+ * @param <E> the type of objects compared by this comparator
  * @since 2.0
  */
 public class NullComparator<E> implements Comparator<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
index fdb581d..8c0b63d 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
@@ -25,8 +25,9 @@ import org.apache.commons.collections4.ComparatorUtils;
  * Reverses the order of another comparator by reversing the arguments
  * to its {@link #compare(Object, Object) compare} method.
  *
+ * @param <E> the type of objects compared by this comparator
+ * 
  * @since 2.0
- *
  * @see java.util.Collections#reverseOrder()
  */
 public class ReverseComparator<E> implements Comparator<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
index 95a7876..11cbabc 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
@@ -29,6 +29,9 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * This class is Serializable from Commons Collections 4.0.
  *
+ * @param <I> the input type to the transformer
+ * @param <O> the output type from the transformer
+ * 
  * @since 2.1
  *
  * @see org.apache.commons.collections4.Transformer

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
----------------------------------------------------------------------
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 96710e2..897374e 100644
--- a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
@@ -500,6 +500,9 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K,
V> implements Ser
      * This interface allows definition for all of the indeterminate
      * mutators in a CompositeMap, as well as providing a hook for
      * callbacks on key collisions.
+     * 
+     * @param <K> the type of the keys in the map
+     * @param <V> the type of the values in the map
      */
     public static interface MapMutator<K, V> extends Serializable {
         /**

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
index 8b4cbe5..eb69a3a 100644
--- a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
+++ b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
@@ -26,6 +26,9 @@ import org.apache.commons.collections4.ResettableIterator;
 /**
  * Adapts a Map entrySet to the MapIterator interface.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @since 4.0
  */
 public class EntrySetToMapIteratorAdapter<K, V> implements MapIterator<K, V>,
ResettableIterator<K> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java b/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
index aa82ff9..8baefae 100644
--- a/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/ReferenceMap.java
@@ -65,8 +65,10 @@ import java.io.Serializable;
  * (previously it extended AbstractMap). As a result, the implementation is now
  * extensible and provides a <code>MapIterator</code>.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @see java.lang.ref.Reference
- *
  * @since 3.0 (previously in main package v2.1)
  */
 public class ReferenceMap<K, V> extends AbstractReferenceMap<K, V> implements
Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
index 82a46b6..8b328ce 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
@@ -32,6 +32,9 @@ import org.apache.commons.collections4.set.AbstractSetDecorator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <K> the type of the keys in the map
+ * @param <V> the type of the values in the map
+ * 
  * @since 3.0
  */
 public final class UnmodifiableEntrySet<K, V>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
index f742854..4ae4d81 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -35,6 +35,7 @@ import org.apache.commons.collections4.iterators.AbstractIteratorDecorator;
  * map will be used to map multiset elements to a number; the number represents the
  * number of occurrences of that element in the multiset.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
index 261175f..8386ee5 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
@@ -33,6 +33,7 @@ import org.apache.commons.collections4.Transformer;
  * Abstract implementation of the {@link MultiSet} interface to simplify the
  * creation of subclass implementations.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public abstract class AbstractMultiSet<E> extends AbstractCollection<E> implements
MultiSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSetDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSetDecorator.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSetDecorator.java
index 4c80eb5..10394a2 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSetDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSetDecorator.java
@@ -26,6 +26,7 @@ import org.apache.commons.collections4.collection.AbstractCollectionDecorator;
  * <p>
  * Methods are forwarded directly to the decorated multiset.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public abstract class AbstractMultiSetDecorator<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java b/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
index 0c19848..6916bb8e 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/HashMultiSet.java
@@ -31,6 +31,7 @@ import java.util.HashMap;
  * count of occurrences. Extra methods on the interface allow multiple copies
  * of an object to be added or removed at once.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public class HashMultiSet<E> extends AbstractMapMultiSet<E> implements Serializable
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/PredicatedMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/PredicatedMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/PredicatedMultiSet.java
index b5d1b7e..4483039 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/PredicatedMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/PredicatedMultiSet.java
@@ -38,6 +38,7 @@ import org.apache.commons.collections4.collection.PredicatedCollection;
  *                                            NotNullPredicate.notNullPredicate());
  * </pre>
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public class PredicatedMultiSet<E> extends PredicatedCollection<E> implements
MultiSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
index f069720..297d836 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
@@ -28,6 +28,7 @@ import org.apache.commons.collections4.collection.SynchronizedCollection;
  * Methods are synchronized, then forwarded to the decorated multiset.
  * Iterators must be separately synchronized around the loop.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public class SynchronizedMultiSet<E> extends SynchronizedCollection<E> implements
MultiSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
index ddfadc0..beb9454 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSet.java
@@ -33,6 +33,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type held in the multiset
  * @since 4.1
  */
 public final class UnmodifiableMultiSet<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/queue/PredicatedQueue.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/queue/PredicatedQueue.java b/src/main/java/org/apache/commons/collections4/queue/PredicatedQueue.java
index 016b95d..12697e8 100644
--- a/src/main/java/org/apache/commons/collections4/queue/PredicatedQueue.java
+++ b/src/main/java/org/apache/commons/collections4/queue/PredicatedQueue.java
@@ -32,6 +32,7 @@ import org.apache.commons.collections4.collection.PredicatedCollection;
  * One usage would be to ensure that no null entries are added to the queue.
  * <pre>Queue queue = PredicatedQueue.predicatedQueue(new UnboundedFifoQueue(), NotNullPredicate.INSTANCE);</pre>
  *
+ * @param <E> the type of elements held in this queue
  * @since 4.0
  */
 public class PredicatedQueue<E> extends PredicatedCollection<E> implements Queue<E>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/queue/TransformedQueue.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/queue/TransformedQueue.java b/src/main/java/org/apache/commons/collections4/queue/TransformedQueue.java
index b42366c..4925321 100644
--- a/src/main/java/org/apache/commons/collections4/queue/TransformedQueue.java
+++ b/src/main/java/org/apache/commons/collections4/queue/TransformedQueue.java
@@ -29,6 +29,7 @@ import org.apache.commons.collections4.collection.TransformedCollection;
  * For example, if the transformation converts Strings to Integers, you must
  * use the Integer form to remove objects.
  *
+ * @param <E> the type of elements held in this queue
  * @since 4.0
  */
 public class TransformedQueue<E> extends TransformedCollection<E> implements
Queue<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/queue/UnmodifiableQueue.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/queue/UnmodifiableQueue.java b/src/main/java/org/apache/commons/collections4/queue/UnmodifiableQueue.java
index 309aaac..0963a19 100644
--- a/src/main/java/org/apache/commons/collections4/queue/UnmodifiableQueue.java
+++ b/src/main/java/org/apache/commons/collections4/queue/UnmodifiableQueue.java
@@ -31,6 +31,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type of elements held in this queue
  * @since 4.0
  */
 public final class UnmodifiableQueue<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
index 29c6bc1..36829f7 100644
--- a/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java
@@ -25,6 +25,7 @@ import java.util.Set;
 /**
  * Serializable subclass of AbstractSetDecorator.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.1
  */
 public abstract class AbstractSerializableSetDecorator<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java b/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
index 1dc1ae7..dd38421 100644
--- a/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
@@ -25,7 +25,7 @@ import org.apache.commons.collections4.collection.AbstractCollectionDecorator;
  * <p>
  * Methods are forwarded directly to the decorated set.
  *
- * @param <E> the type of the elements in the set
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public abstract class AbstractSetDecorator<E> extends AbstractCollectionDecorator<E>
implements

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
index 104a179..a7ccf11 100644
--- a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
@@ -43,6 +43,7 @@ import org.apache.commons.collections4.list.UnmodifiableList;
  * See <a href="https://issues.apache.org/jira/browse/COLLECTIONS-424">COLLECTIONS-424</a>
  * for more details.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class CompositeSet<E> implements Set<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
index 65f7184..4c9cc35 100644
--- a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
@@ -49,6 +49,7 @@ import org.apache.commons.collections4.list.UnmodifiableList;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class ListOrderedSet<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/MapBackedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/MapBackedSet.java b/src/main/java/org/apache/commons/collections4/set/MapBackedSet.java
index 88f1900..6e246a5 100644
--- a/src/main/java/org/apache/commons/collections4/set/MapBackedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/MapBackedSet.java
@@ -32,6 +32,8 @@ import java.util.Set;
  * Most map implementation can be used to create a set by passing in dummy values.
  * Exceptions include <code>BidiMap</code> implementations, as they require unique
values.
  *
+ * @param <E> the type of the elements in this set
+ * @param <V> the dummy value type in this map
  * @since 3.1
  */
 public final class MapBackedSet<E, V> implements Set<E>, Serializable {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/PredicatedNavigableSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/PredicatedNavigableSet.java
b/src/main/java/org/apache/commons/collections4/set/PredicatedNavigableSet.java
index 3411ceb..dda2a5f 100644
--- a/src/main/java/org/apache/commons/collections4/set/PredicatedNavigableSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/PredicatedNavigableSet.java
@@ -36,6 +36,7 @@ import org.apache.commons.collections4.Predicate;
  *                                              NotNullPredicate.notNullPredicate());
  * </pre>
  *
+ * @param <E> the type of the elements in this set
  * @since 4.1
  */
 public class PredicatedNavigableSet<E> extends PredicatedSortedSet<E> implements
NavigableSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/PredicatedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/PredicatedSet.java b/src/main/java/org/apache/commons/collections4/set/PredicatedSet.java
index 333e205..a888c40 100644
--- a/src/main/java/org/apache/commons/collections4/set/PredicatedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/PredicatedSet.java
@@ -34,6 +34,7 @@ import org.apache.commons.collections4.collection.PredicatedCollection;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class PredicatedSet<E> extends PredicatedCollection<E> implements Set<E>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/PredicatedSortedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/PredicatedSortedSet.java b/src/main/java/org/apache/commons/collections4/set/PredicatedSortedSet.java
index 1f225c0..a36de26 100644
--- a/src/main/java/org/apache/commons/collections4/set/PredicatedSortedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/PredicatedSortedSet.java
@@ -38,6 +38,7 @@ import org.apache.commons.collections4.Predicate;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class PredicatedSortedSet<E> extends PredicatedSet<E> implements SortedSet<E>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/TransformedNavigableSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/TransformedNavigableSet.java
b/src/main/java/org/apache/commons/collections4/set/TransformedNavigableSet.java
index eea49d7..3c1ec54 100644
--- a/src/main/java/org/apache/commons/collections4/set/TransformedNavigableSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/TransformedNavigableSet.java
@@ -29,6 +29,7 @@ import org.apache.commons.collections4.Transformer;
  * For example, if the transformation converts Strings to Integers, you must
  * use the Integer form to remove objects.
  *
+ * @param <E> the type of the elements in this set
  * @since 4.1
  */
 public class TransformedNavigableSet<E> extends TransformedSortedSet<E> implements
NavigableSet<E> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/TransformedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/TransformedSet.java b/src/main/java/org/apache/commons/collections4/set/TransformedSet.java
index 8b3131e..0c8abfd 100644
--- a/src/main/java/org/apache/commons/collections4/set/TransformedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/TransformedSet.java
@@ -31,6 +31,7 @@ import org.apache.commons.collections4.collection.TransformedCollection;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class TransformedSet<E> extends TransformedCollection<E> implements Set<E>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/TransformedSortedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/TransformedSortedSet.java b/src/main/java/org/apache/commons/collections4/set/TransformedSortedSet.java
index 8d9a599..2954e47 100644
--- a/src/main/java/org/apache/commons/collections4/set/TransformedSortedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/TransformedSortedSet.java
@@ -31,6 +31,7 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * This class is Serializable from Commons Collections 3.1.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public class TransformedSortedSet<E> extends TransformedSet<E> implements SortedSet<E>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
b/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
index 40b4dc4..6c09a6a 100644
--- a/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/UnmodifiableNavigableSet.java
@@ -32,6 +32,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type of the elements in this set
  * @since 4.1
  */
 public final class UnmodifiableNavigableSet<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSet.java b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSet.java
index 159192a..022c9dc 100644
--- a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSet.java
@@ -30,6 +30,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public final class UnmodifiableSet<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
index 7131874..6a60e8c 100644
--- a/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/UnmodifiableSortedSet.java
@@ -33,6 +33,7 @@ import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  * <p>
  * Attempts to modify it will result in an UnsupportedOperationException.
  *
+ * @param <E> the type of the elements in this set
  * @since 3.0
  */
 public final class UnmodifiableSortedSet<E>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
index 6c788d9..81cdc29 100644
--- a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
@@ -28,6 +28,8 @@ import org.apache.commons.collections4.map.EntrySetToMapIteratorAdapter;
  * {@link IterableGet} that uses a {@link Map}&lt;K, V&gt; for the
  * {@link org.apache.commons.collections4.Get Get}&lt;K, V&gt; 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 class AbstractIterableGetMapDecorator<K, V> implements IterableGet<K, V>
{

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
index cb0f4b8..2344f6a 100644
--- a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
+++ b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java
@@ -52,6 +52,10 @@ import org.apache.commons.collections4.map.LinkedMap;
  * but is intended to be worked with either directly or by {@link Put} and
  * {@link org.apache.commons.collections4.Get Get} generalizations.
  *
+ * @param <J> the type of the keys to put in this map
+ * @param <K> the type of the keys to get in this map
+ * @param <U> the type of the values to put in this map
+ * @param <V> the type of the values to get in this map
  * @since 4.0
  *
  * @see org.apache.commons.collections4.SplitMapUtils#readableMap(org.apache.commons.collections4.Get)

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java b/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
index a62d8f9..474db5d 100644
--- a/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
+++ b/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
@@ -29,6 +29,7 @@ import java.util.Comparator;
  * key (if the key and found key are equal than the return value is
  * {@link #EQUAL_BIT_KEY}).
  *
+ * @param <K> the type of objects that may be compared by this analyzer
  * @since 4.0
  */
 public abstract class KeyAnalyzer<K> implements Comparator<K>, Serializable {


Mime
View raw message