Javadoc: Add missing @param tags for generics.

This commit is contained in:
Gary Gregory 2019-07-05 10:37:07 -04:00
parent 7db45d3971
commit 38b8a8975f
16 changed files with 32 additions and 1 deletions

View File

@ -19,6 +19,8 @@ package org.apache.commons.collections4.iterators;
/** /**
* Provides an implementation of an empty map iterator. * Provides an implementation of an empty map iterator.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 4.0 * @since 4.0
*/ */
public abstract class AbstractEmptyMapIterator<K, V> extends AbstractEmptyIterator<K> { public abstract class AbstractEmptyMapIterator<K, V> extends AbstractEmptyIterator<K> {

View File

@ -23,6 +23,8 @@ import org.apache.commons.collections4.MapIterator;
* <p> * <p>
* All methods are forwarded to the decorated map iterator. * All methods are forwarded to the decorated map iterator.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> { public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> {

View File

@ -23,6 +23,8 @@ import org.apache.commons.collections4.OrderedMapIterator;
* <p> * <p>
* All methods are forwarded to the decorated map iterator. * All methods are forwarded to the decorated map iterator.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public class AbstractOrderedMapIteratorDecorator<K, V> implements OrderedMapIterator<K, V> { public class AbstractOrderedMapIteratorDecorator<K, V> implements OrderedMapIterator<K, V> {

View File

@ -22,6 +22,8 @@ import org.apache.commons.collections4.ResettableIterator;
/** /**
* Provides an implementation of an empty map iterator. * Provides an implementation of an empty map iterator.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.1 * @since 3.1
*/ */
public class EmptyMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> implements public class EmptyMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> implements

View File

@ -22,6 +22,8 @@ import org.apache.commons.collections4.ResettableIterator;
/** /**
* Provides an implementation of an empty ordered map iterator. * Provides an implementation of an empty ordered map iterator.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.1 * @since 3.1
*/ */
public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V>

View File

@ -34,6 +34,8 @@ import org.apache.commons.collections4.ResettableIterator;
* } * }
* </pre> * </pre>
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public class EntrySetMapIterator<K, V> implements MapIterator<K, V>, ResettableIterator<K> { public class EntrySetMapIterator<K, V> implements MapIterator<K, V>, ResettableIterator<K> {

View File

@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* </p> * </p>
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableMapIterator<K, V> implements MapIterator<K, V>, Unmodifiable { public final class UnmodifiableMapIterator<K, V> implements MapIterator<K, V>, Unmodifiable {

View File

@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException. * Attempts to modify it will result in an UnsupportedOperationException.
* </p> * </p>
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableOrderedMapIterator<K, V> implements OrderedMapIterator<K, V>, public final class UnmodifiableOrderedMapIterator<K, V> implements OrderedMapIterator<K, V>,

View File

@ -22,6 +22,8 @@ import org.apache.commons.collections4.KeyValue;
* Abstract pair class to assist with creating <code>KeyValue</code> * Abstract pair class to assist with creating <code>KeyValue</code>
* and {@link java.util.Map.Entry Map.Entry} implementations. * and {@link java.util.Map.Entry Map.Entry} implementations.
* *
* @param <K> the type of keys
* @param <V> the type of values
* @since 3.0 * @since 3.0
*/ */
public abstract class AbstractKeyValue<K, V> implements KeyValue<K, V> { public abstract class AbstractKeyValue<K, V> implements KeyValue<K, V> {

View File

@ -22,6 +22,8 @@ import java.util.Map;
* Abstract Pair class to assist with creating correct * Abstract Pair class to assist with creating correct
* {@link java.util.Map.Entry Map.Entry} implementations. * {@link java.util.Map.Entry Map.Entry} implementations.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public abstract class AbstractMapEntry<K, V> extends AbstractKeyValue<K, V> implements Map.Entry<K, V> { public abstract class AbstractMapEntry<K, V> extends AbstractKeyValue<K, V> implements Map.Entry<K, V> {

View File

@ -24,6 +24,8 @@ import org.apache.commons.collections4.KeyValue;
* Provides a base decorator that allows additional functionality to be * Provides a base decorator that allows additional functionality to be
* added to a {@link java.util.Map.Entry Map.Entry}. * added to a {@link java.util.Map.Entry Map.Entry}.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public abstract class AbstractMapEntryDecorator<K, V> implements Map.Entry<K, V>, KeyValue<K, V> { public abstract class AbstractMapEntryDecorator<K, V> implements Map.Entry<K, V>, KeyValue<K, V> {

View File

@ -28,6 +28,8 @@ import org.apache.commons.collections4.KeyValue;
* itself as a key or value. * itself as a key or value.
* </p> * </p>
* *
* @param <K> the type of keys
* @param <V> the type of values
* @since 3.0 * @since 3.0
*/ */
public class DefaultKeyValue<K, V> extends AbstractKeyValue<K, V> { public class DefaultKeyValue<K, V> extends AbstractKeyValue<K, V> {

View File

@ -24,6 +24,8 @@ import org.apache.commons.collections4.KeyValue;
* A restricted implementation of {@link java.util.Map.Entry Map.Entry} that prevents * A restricted implementation of {@link java.util.Map.Entry Map.Entry} that prevents
* the {@link java.util.Map.Entry Map.Entry} contract from being broken. * the {@link java.util.Map.Entry Map.Entry} contract from being broken.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public final class DefaultMapEntry<K, V> extends AbstractMapEntry<K, V> { public final class DefaultMapEntry<K, V> extends AbstractMapEntry<K, V> {

View File

@ -41,6 +41,7 @@ import java.util.Arrays;
* String localizedText = (String) map.get(multiKey); * String localizedText = (String) map.get(multiKey);
* </pre> * </pre>
* *
* @param <K> the type of keys
* @since 3.0 * @since 3.0
*/ */
public class MultiKey<K> implements Serializable { public class MultiKey<K> implements Serializable {

View File

@ -27,7 +27,9 @@ import org.apache.commons.collections4.KeyValue;
* This can be used to enable a map entry to make changes on the underlying * This can be used to enable a map entry to make changes on the underlying
* map, however this will probably mess up any iterators. * map, however this will probably mess up any iterators.
* </p> * </p>
s * *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public class TiedMapEntry<K, V> implements Map.Entry<K, V>, KeyValue<K, V>, Serializable { public class TiedMapEntry<K, V> implements Map.Entry<K, V>, KeyValue<K, V>, Serializable {

View File

@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* A {@link java.util.Map.Entry Map.Entry} that throws * A {@link java.util.Map.Entry Map.Entry} that throws
* UnsupportedOperationException when <code>setValue</code> is called. * UnsupportedOperationException when <code>setValue</code> is called.
* *
* @param <K> the type of keys
* @param <V> the type of mapped values
* @since 3.0 * @since 3.0
*/ */
public final class UnmodifiableMapEntry<K, V> extends AbstractMapEntry<K, V> implements Unmodifiable { public final class UnmodifiableMapEntry<K, V> extends AbstractMapEntry<K, V> implements Unmodifiable {