Javadoc: Add missing @param tags for generics.

This commit is contained in:
Gary Gregory 2017-12-28 13:37:20 -07:00
parent 5d756cebd7
commit 36d33722c3
10 changed files with 19 additions and 0 deletions

View File

@ -36,6 +36,7 @@ import java.util.EmptyStackException;
* <b>Note:</b> From version 4.0 onwards, this class does not implement the * <b>Note:</b> From version 4.0 onwards, this class does not implement the
* removed {@code Buffer} interface anymore. * removed {@code Buffer} interface anymore.
* *
* @param <E> the type of elements in this list
* @see java.util.Stack * @see java.util.Stack
* @since 1.0 * @since 1.0
* @deprecated use {@link java.util.ArrayDeque} instead (available from Java 1.6) * @deprecated use {@link java.util.ArrayDeque} instead (available from Java 1.6)

View File

@ -27,6 +27,8 @@ import java.util.List;
* <li>Getting a value will return a {@link List}, holding all the values put to that key.</li> * <li>Getting a value will return a {@link List}, holding all the values put to that key.</li>
* </ul> * </ul>
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public interface ListValuedMap<K, V> extends MultiValuedMap<K, V> { public interface ListValuedMap<K, V> extends MultiValuedMap<K, V> {

View File

@ -42,6 +42,8 @@ import java.util.Set;
* <code>coll</code> will be a collection containing "A", "B", "C". * <code>coll</code> will be a collection containing "A", "B", "C".
* <p> * <p>
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public interface MultiValuedMap<K, V> { public interface MultiValuedMap<K, V> {

View File

@ -27,6 +27,8 @@ import java.util.Set;
* <li>Getting a value will return a {@link Set}, holding all the values put to that key.</li> * <li>Getting a value will return a {@link Set}, holding all the values put to that key.</li>
* </ul> * </ul>
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public interface SetValuedMap<K, V> extends MultiValuedMap<K, V> { public interface SetValuedMap<K, V> extends MultiValuedMap<K, V> {

View File

@ -32,6 +32,8 @@ import org.apache.commons.collections4.ListValuedMap;
* Subclasses specify a Map implementation to use as the internal storage and * Subclasses specify a Map implementation to use as the internal storage and
* the List implementation to use as values. * the List implementation to use as values.
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public abstract class AbstractListValuedMap<K, V> extends AbstractMultiValuedMap<K, V> public abstract class AbstractListValuedMap<K, V> extends AbstractMultiValuedMap<K, V>

View File

@ -51,6 +51,8 @@ import org.apache.commons.collections4.multiset.UnmodifiableMultiSet;
* <p> * <p>
* Subclasses specify a Map implementation to use as the internal storage. * Subclasses specify a Map implementation to use as the internal storage.
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K, V> { public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K, V> {

View File

@ -30,6 +30,8 @@ import org.apache.commons.collections4.SetValuedMap;
* Subclasses specify a Map implementation to use as the internal storage and * Subclasses specify a Map implementation to use as the internal storage and
* the Set implementation to use as values. * the Set implementation to use as values.
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public abstract class AbstractSetValuedMap<K, V> extends AbstractMultiValuedMap<K, V> public abstract class AbstractSetValuedMap<K, V> extends AbstractMultiValuedMap<K, V>

View File

@ -37,6 +37,8 @@ import org.apache.commons.collections4.MultiValuedMap;
* concurrently, you must use appropriate synchronization. This class may throw * concurrently, you must use appropriate synchronization. This class may throw
* exceptions when accessed by concurrent threads without synchronization. * exceptions when accessed by concurrent threads without synchronization.
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public class ArrayListValuedHashMap<K, V> extends AbstractListValuedMap<K, V> public class ArrayListValuedHashMap<K, V> extends AbstractListValuedMap<K, V>

View File

@ -36,6 +36,8 @@ import org.apache.commons.collections4.MultiValuedMap;
* concurrently, you must use appropriate synchronization. This class may throw * concurrently, you must use appropriate synchronization. This class may throw
* exceptions when accessed by concurrent threads without synchronization. * exceptions when accessed by concurrent threads without synchronization.
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public class HashSetValuedHashMap<K, V> extends AbstractSetValuedMap<K, V> public class HashSetValuedHashMap<K, V> extends AbstractSetValuedMap<K, V>

View File

@ -34,6 +34,8 @@ import org.apache.commons.collections4.Transformer;
* <p> * <p>
* <strong>Note that TransformedMultiValuedMap is not synchronized and is not thread-safe.</strong> * <strong>Note that TransformedMultiValuedMap is not synchronized and is not thread-safe.</strong>
* *
* @param <K> the type of the keys in this map
* @param <V> the type of the values in this map
* @since 4.1 * @since 4.1
*/ */
public class TransformedMultiValuedMap<K, V> extends AbstractMultiValuedMapDecorator<K, V> { public class TransformedMultiValuedMap<K, V> extends AbstractMultiValuedMapDecorator<K, V> {