Javadoc: Add missing @param tags for generics.

This commit is contained in:
Gary Gregory 2017-12-28 13:22:24 -07:00
parent 8b66a577f4
commit 8e09f5f538
17 changed files with 17 additions and 3 deletions

View File

@ -38,7 +38,7 @@ import java.util.Set;
* In an ideal world, the interface would be changed to fix the problems, however * In an ideal world, the interface would be changed to fix the problems, however
* it has been decided to maintain backwards compatibility instead. * 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 * @since 2.0
*/ */
public interface Bag<E> extends Collection<E> { public interface Bag<E> extends Collection<E> {

View File

@ -22,7 +22,7 @@ import java.util.Comparator;
* Defines a type of <code>Bag</code> that maintains a sorted order among * Defines a type of <code>Bag</code> that maintains a sorted order among
* its unique representative members. * its unique representative members.
* *
* @param <E> the type to iterate over * @param <E> the type of elements in this bag
* @since 2.0 * @since 2.0
*/ */
public interface SortedBag<E> extends Bag<E> { public interface SortedBag<E> extends Bag<E> {

View File

@ -26,6 +26,7 @@ import org.apache.commons.collections4.collection.AbstractCollectionDecorator;
* <p> * <p>
* Methods are forwarded directly to the decorated bag. * Methods are forwarded directly to the decorated bag.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public abstract class AbstractBagDecorator<E> public abstract class AbstractBagDecorator<E>

View File

@ -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 * map will be used to map bag elements to a number; the number represents the
* number of occurrences of that element in the bag. * 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) * @since 3.0 (previously DefaultMapBag v2.0)
*/ */
public abstract class AbstractMapBag<E> implements Bag<E> { public abstract class AbstractMapBag<E> implements Bag<E> {

View File

@ -25,6 +25,7 @@ import org.apache.commons.collections4.SortedBag;
* <p> * <p>
* Methods are forwarded directly to the decorated bag. * Methods are forwarded directly to the decorated bag.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public abstract class AbstractSortedBagDecorator<E> public abstract class AbstractSortedBagDecorator<E>

View File

@ -34,7 +34,7 @@ import org.apache.commons.collections4.Bag;
* The method javadoc highlights the differences compared to the original Bag interface. * The method javadoc highlights the differences compared to the original Bag interface.
* *
* @see Bag * @see Bag
* @param <E> the type held in the bag * @param <E> the type of elements in this bag
* @since 4.0 * @since 4.0
*/ */
public final class CollectionBag<E> extends AbstractBagDecorator<E> { public final class CollectionBag<E> extends AbstractBagDecorator<E> {

View File

@ -27,6 +27,7 @@ import org.apache.commons.collections4.SortedBag;
/** /**
* Decorates another {@link SortedBag} to comply with the Collection contract. * Decorates another {@link SortedBag} to comply with the Collection contract.
* *
* @param <E> the type of elements in this bag
* @since 4.0 * @since 4.0
*/ */
public final class CollectionSortedBag<E> extends AbstractSortedBagDecorator<E> { public final class CollectionSortedBag<E> extends AbstractSortedBagDecorator<E> {

View File

@ -33,6 +33,7 @@ import java.util.HashMap;
* interface javadoc carefully as several methods violate the * interface javadoc carefully as several methods violate the
* {@link Collection} interface specification. * {@link Collection} interface specification.
* *
* @param <E> the type of elements in this bag
* @since 3.0 (previously in main package v2.0) * @since 3.0 (previously in main package v2.0)
*/ */
public class HashBag<E> extends AbstractMapBag<E> implements Serializable { public class HashBag<E> extends AbstractMapBag<E> implements Serializable {

View File

@ -37,6 +37,7 @@ import org.apache.commons.collections4.collection.PredicatedCollection;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class PredicatedBag<E> extends PredicatedCollection<E> implements Bag<E> { public class PredicatedBag<E> extends PredicatedCollection<E> implements Bag<E> {

View File

@ -36,6 +36,7 @@ import org.apache.commons.collections4.SortedBag;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class PredicatedSortedBag<E> extends PredicatedBag<E> implements SortedBag<E> { public class PredicatedSortedBag<E> extends PredicatedBag<E> implements SortedBag<E> {

View File

@ -30,6 +30,7 @@ import org.apache.commons.collections4.collection.SynchronizedCollection;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag<E> { public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag<E> {

View File

@ -30,6 +30,7 @@ import org.apache.commons.collections4.SortedBag;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class SynchronizedSortedBag<E> extends SynchronizedBag<E> implements SortedBag<E> { public class SynchronizedSortedBag<E> extends SynchronizedBag<E> implements SortedBag<E> {

View File

@ -33,6 +33,7 @@ import org.apache.commons.collections4.set.TransformedSet;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class TransformedBag<E> extends TransformedCollection<E> implements Bag<E> { public class TransformedBag<E> extends TransformedCollection<E> implements Bag<E> {

View File

@ -31,6 +31,7 @@ import org.apache.commons.collections4.Transformer;
* <p> * <p>
* This class is Serializable from Commons Collections 3.1. * This class is Serializable from Commons Collections 3.1.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public class TransformedSortedBag<E> extends TransformedBag<E> implements SortedBag<E> { public class TransformedSortedBag<E> extends TransformedBag<E> implements SortedBag<E> {

View File

@ -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 * 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. * 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) * @since 3.0 (previously in main package v2.0)
*/ */
public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Serializable { public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Serializable {

View File

@ -35,6 +35,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
* <p> * <p>
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableBag<E> public final class UnmodifiableBag<E>

View File

@ -35,6 +35,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
* <p> * <p>
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* *
* @param <E> the type of elements in this bag
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableSortedBag<E> public final class UnmodifiableSortedBag<E>