Repository: commons-collections Updated Branches: refs/heads/master 8b66a577f -> 8e09f5f53
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/8e09f5f5 Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/8e09f5f5 Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/8e09f5f5 Branch: refs/heads/master Commit: 8e09f5f538db789ba72b52b39c56e7b111f142d5 Parents: 8b66a57 Author: Gary Gregory <[email protected]> Authored: Thu Dec 28 13:22:24 2017 -0700 Committer: Gary Gregory <[email protected]> Committed: Thu Dec 28 13:22:24 2017 -0700 ---------------------------------------------------------------------- src/main/java/org/apache/commons/collections4/Bag.java | 2 +- src/main/java/org/apache/commons/collections4/SortedBag.java | 2 +- .../org/apache/commons/collections4/bag/AbstractBagDecorator.java | 1 + .../java/org/apache/commons/collections4/bag/AbstractMapBag.java | 1 + .../commons/collections4/bag/AbstractSortedBagDecorator.java | 1 + .../java/org/apache/commons/collections4/bag/CollectionBag.java | 2 +- .../org/apache/commons/collections4/bag/CollectionSortedBag.java | 1 + src/main/java/org/apache/commons/collections4/bag/HashBag.java | 1 + .../java/org/apache/commons/collections4/bag/PredicatedBag.java | 1 + .../org/apache/commons/collections4/bag/PredicatedSortedBag.java | 1 + .../java/org/apache/commons/collections4/bag/SynchronizedBag.java | 1 + .../org/apache/commons/collections4/bag/SynchronizedSortedBag.java | 1 + .../java/org/apache/commons/collections4/bag/TransformedBag.java | 1 + .../org/apache/commons/collections4/bag/TransformedSortedBag.java | 1 + src/main/java/org/apache/commons/collections4/bag/TreeBag.java | 1 + .../java/org/apache/commons/collections4/bag/UnmodifiableBag.java | 1 + .../org/apache/commons/collections4/bag/UnmodifiableSortedBag.java | 1 + 17 files changed, 17 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/Bag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/Bag.java b/src/main/java/org/apache/commons/collections4/Bag.java index 96c1943..c6d9781 100644 --- a/src/main/java/org/apache/commons/collections4/Bag.java +++ b/src/main/java/org/apache/commons/collections4/Bag.java @@ -38,7 +38,7 @@ import java.util.Set; * In an ideal world, the interface would be changed to fix the problems, however * it has been decided to maintain backwards compatibility instead. * - * @param <E> the type held in the bag + * @param <E> the type of elements in this bag * @since 2.0 */ public interface Bag<E> extends Collection<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/SortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/SortedBag.java b/src/main/java/org/apache/commons/collections4/SortedBag.java index 15c5feb..24324b0 100644 --- a/src/main/java/org/apache/commons/collections4/SortedBag.java +++ b/src/main/java/org/apache/commons/collections4/SortedBag.java @@ -22,7 +22,7 @@ import java.util.Comparator; * Defines a type of <code>Bag</code> that maintains a sorted order among * its unique representative members. * - * @param <E> the type to iterate over + * @param <E> the type of elements in this bag * @since 2.0 */ public interface SortedBag<E> extends Bag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java index 3c952af..99e4d6d 100644 --- a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java +++ b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java @@ -26,6 +26,7 @@ import org.apache.commons.collections4.collection.AbstractCollectionDecorator; * <p> * Methods are forwarded directly to the decorated bag. * + * @param <E> the type of elements in this bag * @since 3.0 */ public abstract class AbstractBagDecorator<E> http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java index 0d01270..8b7152e 100644 --- a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java @@ -38,6 +38,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet; * map will be used to map bag elements to a number; the number represents the * number of occurrences of that element in the bag. * + * @param <E> the type of elements in this bag * @since 3.0 (previously DefaultMapBag v2.0) */ public abstract class AbstractMapBag<E> implements Bag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java b/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java index 187fc95..99424fb 100644 --- a/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java +++ b/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java @@ -25,6 +25,7 @@ import org.apache.commons.collections4.SortedBag; * <p> * Methods are forwarded directly to the decorated bag. * + * @param <E> the type of elements in this bag * @since 3.0 */ public abstract class AbstractSortedBagDecorator<E> http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java index 7fbe346..c27d009 100644 --- a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java @@ -34,7 +34,7 @@ import org.apache.commons.collections4.Bag; * The method javadoc highlights the differences compared to the original Bag interface. * * @see Bag - * @param <E> the type held in the bag + * @param <E> the type of elements in this bag * @since 4.0 */ public final class CollectionBag<E> extends AbstractBagDecorator<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java index 88a4c76..ef433e5 100644 --- a/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/CollectionSortedBag.java @@ -27,6 +27,7 @@ import org.apache.commons.collections4.SortedBag; /** * Decorates another {@link SortedBag} to comply with the Collection contract. * + * @param <E> the type of elements in this bag * @since 4.0 */ public final class CollectionSortedBag<E> extends AbstractSortedBagDecorator<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/HashBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/HashBag.java b/src/main/java/org/apache/commons/collections4/bag/HashBag.java index 9fca842..33adb1f 100644 --- a/src/main/java/org/apache/commons/collections4/bag/HashBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/HashBag.java @@ -33,6 +33,7 @@ import java.util.HashMap; * interface javadoc carefully as several methods violate the * {@link Collection} interface specification. * + * @param <E> the type of elements in this bag * @since 3.0 (previously in main package v2.0) */ public class HashBag<E> extends AbstractMapBag<E> implements Serializable { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/PredicatedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/PredicatedBag.java b/src/main/java/org/apache/commons/collections4/bag/PredicatedBag.java index c79715a..bc69ad4 100644 --- a/src/main/java/org/apache/commons/collections4/bag/PredicatedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/PredicatedBag.java @@ -37,6 +37,7 @@ import org.apache.commons.collections4.collection.PredicatedCollection; * <p> * This class is Serializable from Commons Collections 3.1. * + * @param <E> the type of elements in this bag * @since 3.0 */ public class PredicatedBag<E> extends PredicatedCollection<E> implements Bag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/PredicatedSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/PredicatedSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/PredicatedSortedBag.java index 6524ee5..124d49c 100644 --- a/src/main/java/org/apache/commons/collections4/bag/PredicatedSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/PredicatedSortedBag.java @@ -36,6 +36,7 @@ import org.apache.commons.collections4.SortedBag; * <p> * This class is Serializable from Commons Collections 3.1. * + * @param <E> the type of elements in this bag * @since 3.0 */ public class PredicatedSortedBag<E> extends PredicatedBag<E> implements SortedBag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java index 6e2009b..362245f 100644 --- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java @@ -30,6 +30,7 @@ import org.apache.commons.collections4.collection.SynchronizedCollection; * <p> * This class is Serializable from Commons Collections 3.1. * + * @param <E> the type of elements in this bag * @since 3.0 */ public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java index 6d14ce1..6dae8d4 100644 --- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java @@ -30,6 +30,7 @@ import org.apache.commons.collections4.SortedBag; * <p> * This class is Serializable from Commons Collections 3.1. * + * @param <E> the type of elements in this bag * @since 3.0 */ public class SynchronizedSortedBag<E> extends SynchronizedBag<E> implements SortedBag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/TransformedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/TransformedBag.java b/src/main/java/org/apache/commons/collections4/bag/TransformedBag.java index 9298d62..34aa6e9 100644 --- a/src/main/java/org/apache/commons/collections4/bag/TransformedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/TransformedBag.java @@ -33,6 +33,7 @@ import org.apache.commons.collections4.set.TransformedSet; * <p> * This class is Serializable from Commons Collections 3.1. * + * @param <E> the type of elements in this bag * @since 3.0 */ public class TransformedBag<E> extends TransformedCollection<E> implements Bag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/TransformedSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/TransformedSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/TransformedSortedBag.java index c723a78..d33732e 100644 --- a/src/main/java/org/apache/commons/collections4/bag/TransformedSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/TransformedSortedBag.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 elements in this bag * @since 3.0 */ public class TransformedSortedBag<E> extends TransformedBag<E> implements SortedBag<E> { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/TreeBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/TreeBag.java b/src/main/java/org/apache/commons/collections4/bag/TreeBag.java index 084b21c..715871b 100644 --- a/src/main/java/org/apache/commons/collections4/bag/TreeBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/TreeBag.java @@ -38,6 +38,7 @@ import org.apache.commons.collections4.SortedBag; * copies of an object to be added or removed at once. It is important to read the interface * javadoc carefully as several methods violate the {@link Collection} interface specification. * + * @param <E> the type of elements in this bag * @since 3.0 (previously in main package v2.0) */ public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Serializable { http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java index 52fe51f..9100a61 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableBag.java @@ -35,6 +35,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet; * <p> * Attempts to modify it will result in an UnsupportedOperationException. * + * @param <E> the type of elements in this bag * @since 3.0 */ public final class UnmodifiableBag<E> http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java index 7ea2c94..c07e134 100644 --- a/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/UnmodifiableSortedBag.java @@ -35,6 +35,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet; * <p> * Attempts to modify it will result in an UnsupportedOperationException. * + * @param <E> the type of elements in this bag * @since 3.0 */ public final class UnmodifiableSortedBag<E>
