This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new 38b8a89 Javadoc: Add missing @param tags for generics.
38b8a89 is described below
commit 38b8a8975fbe4da63d5ed0dc14ebcc3af17ab394
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jul 5 10:37:07 2019 -0400
Javadoc: Add missing @param tags for generics.
---
.../commons/collections4/iterators/AbstractEmptyMapIterator.java | 2 ++
.../commons/collections4/iterators/AbstractMapIteratorDecorator.java | 2 ++
.../collections4/iterators/AbstractOrderedMapIteratorDecorator.java | 2 ++
.../org/apache/commons/collections4/iterators/EmptyMapIterator.java | 2 ++
.../commons/collections4/iterators/EmptyOrderedMapIterator.java | 2 ++
.../apache/commons/collections4/iterators/EntrySetMapIterator.java | 2 ++
.../commons/collections4/iterators/UnmodifiableMapIterator.java | 2 ++
.../collections4/iterators/UnmodifiableOrderedMapIterator.java | 2 ++
.../org/apache/commons/collections4/keyvalue/AbstractKeyValue.java | 2 ++
.../org/apache/commons/collections4/keyvalue/AbstractMapEntry.java | 2 ++
.../commons/collections4/keyvalue/AbstractMapEntryDecorator.java | 2 ++
.../org/apache/commons/collections4/keyvalue/DefaultKeyValue.java | 2 ++
.../org/apache/commons/collections4/keyvalue/DefaultMapEntry.java | 2 ++
src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java | 1 +
.../java/org/apache/commons/collections4/keyvalue/TiedMapEntry.java | 4 +++-
.../apache/commons/collections4/keyvalue/UnmodifiableMapEntry.java | 2 ++
16 files changed, 32 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
index 8705c3d..2b11ee8 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyMapIterator.java
@@ -19,6 +19,8 @@ package org.apache.commons.collections4.iterators;
/**
* Provides an implementation of an empty map iterator.
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 4.0
*/
public abstract class AbstractEmptyMapIterator<K, V> extends AbstractEmptyIterator<K> {
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
index 419aa91..99b0250 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
@@ -23,6 +23,8 @@ import org.apache.commons.collections4.MapIterator;
* <p>
* 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
*/
public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
index 5ec24fe..43d438a 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
@@ -23,6 +23,8 @@ import org.apache.commons.collections4.OrderedMapIterator;
* <p>
* 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
*/
public class AbstractOrderedMapIteratorDecorator<K, V> implements OrderedMapIterator<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
index a890811..6620725 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
@@ -22,6 +22,8 @@ import org.apache.commons.collections4.ResettableIterator;
/**
* Provides an implementation of an empty map iterator.
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.1
*/
public class EmptyMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> implements
diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
index dab9aed..cc760d1 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
@@ -22,6 +22,8 @@ import org.apache.commons.collections4.ResettableIterator;
/**
* 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
*/
public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V>
diff --git a/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java
index ecc9eb8..7cae5d6 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java
@@ -34,6 +34,8 @@ import org.apache.commons.collections4.ResettableIterator;
* }
* </pre>
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public class EntrySetMapIterator<K, V> implements MapIterator<K, V>, ResettableIterator<K> {
diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java
index b215d3f..c82b8de 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java
@@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException.
* </p>
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public final class UnmodifiableMapIterator<K, V> implements MapIterator<K, V>, Unmodifiable {
diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java
index b976e35..d764a64 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java
@@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* Attempts to modify it will result in an UnsupportedOperationException.
* </p>
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public final class UnmodifiableOrderedMapIterator<K, V> implements OrderedMapIterator<K, V>,
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java
index 6f7a5e1..3cc008c 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java
@@ -22,6 +22,8 @@ import org.apache.commons.collections4.KeyValue;
* Abstract pair class to assist with creating <code>KeyValue</code>
* and {@link java.util.Map.Entry Map.Entry} implementations.
*
+ * @param <K> the type of keys
+ * @param <V> the type of values
* @since 3.0
*/
public abstract class AbstractKeyValue<K, V> implements KeyValue<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntry.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntry.java
index 15d461e..b27d4d5 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntry.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntry.java
@@ -22,6 +22,8 @@ import java.util.Map;
* Abstract Pair class to assist with creating correct
* {@link java.util.Map.Entry Map.Entry} implementations.
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public abstract class AbstractMapEntry<K, V> extends AbstractKeyValue<K, V> implements Map.Entry<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
index 713ee8b..40e0c94 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
@@ -24,6 +24,8 @@ import org.apache.commons.collections4.KeyValue;
* Provides a base decorator that allows additional functionality to be
* 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
*/
public abstract class AbstractMapEntryDecorator<K, V> implements Map.Entry<K, V>, KeyValue<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/DefaultKeyValue.java b/src/main/java/org/apache/commons/collections4/keyvalue/DefaultKeyValue.java
index aab6e1d..05b5cea 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/DefaultKeyValue.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/DefaultKeyValue.java
@@ -28,6 +28,8 @@ import org.apache.commons.collections4.KeyValue;
* itself as a key or value.
* </p>
*
+ * @param <K> the type of keys
+ * @param <V> the type of values
* @since 3.0
*/
public class DefaultKeyValue<K, V> extends AbstractKeyValue<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/DefaultMapEntry.java b/src/main/java/org/apache/commons/collections4/keyvalue/DefaultMapEntry.java
index a1c8539..29c2d7d 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/DefaultMapEntry.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/DefaultMapEntry.java
@@ -24,6 +24,8 @@ import org.apache.commons.collections4.KeyValue;
* 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.
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public final class DefaultMapEntry<K, V> extends AbstractMapEntry<K, V> {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
index 63627aa..1df58fc 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
@@ -41,6 +41,7 @@ import java.util.Arrays;
* String localizedText = (String) map.get(multiKey);
* </pre>
*
+ * @param <K> the type of keys
* @since 3.0
*/
public class MultiKey<K> implements Serializable {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/TiedMapEntry.java b/src/main/java/org/apache/commons/collections4/keyvalue/TiedMapEntry.java
index a216fce..5748778 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/TiedMapEntry.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/TiedMapEntry.java
@@ -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
* map, however this will probably mess up any iterators.
* </p>
-s *
+ *
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public class TiedMapEntry<K, V> implements Map.Entry<K, V>, KeyValue<K, V>, Serializable {
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/UnmodifiableMapEntry.java b/src/main/java/org/apache/commons/collections4/keyvalue/UnmodifiableMapEntry.java
index 2bc3027..83c6817 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/UnmodifiableMapEntry.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/UnmodifiableMapEntry.java
@@ -25,6 +25,8 @@ import org.apache.commons.collections4.Unmodifiable;
* A {@link java.util.Map.Entry Map.Entry} that throws
* UnsupportedOperationException when <code>setValue</code> is called.
*
+ * @param <K> the type of keys
+ * @param <V> the type of mapped values
* @since 3.0
*/
public final class UnmodifiableMapEntry<K, V> extends AbstractMapEntry<K, V> implements Unmodifiable {