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 a2dac490e Javadoc
a2dac490e is described below
commit a2dac490ece6f6a3a8dc7091c18318826f63a5ce
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Jun 24 07:55:22 2024 -0400
Javadoc
---
.../commons/collections4/bloomfilter/LayerManager.java | 6 +++++-
.../commons/collections4/list/AbstractLinkedList.java | 3 +++
.../commons/collections4/map/AbstractLinkedMap.java | 17 +++++++++++++++++
.../commons/collections4/trie/AbstractPatriciaTrie.java | 5 ++++-
.../collections4/map/AbstractIterableMapTest.java | 3 +++
.../commons/collections4/map/AbstractMapTest.java | 6 ++++++
.../apache/commons/collections4/map/IdentityMap.java | 5 ++++-
7 files changed, 42 insertions(+), 3 deletions(-)
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index b1300136f..574a92cfb 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -49,12 +49,16 @@ import java.util.function.Supplier;
* the {@code target} filter.</li>
* </ol>
*
+ *
+ * @param <T> the {@link BloomFilter} type.
* @since 4.5.0
*/
public class LayerManager<T extends BloomFilter> implements
BloomFilterExtractor {
/**
- * Builder to create Layer Manager
+ * Builder to create Layer Manager.
+ *
+ * @param <T> the {@link BloomFilter} type.
*/
public static class Builder<T extends BloomFilter> {
private Predicate<LayerManager<T>> extendCheck;
diff --git
a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
index 1d66a792f..95b271c93 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
@@ -404,6 +404,9 @@ public abstract class AbstractLinkedList<E> implements
List<E> {
* <p>
* From Commons Collections 3.1, all access to the {@code value} property
* is via the methods on this class.
+ * </p>
+ *
+ * @param <E> The node value type.
*/
protected static class Node<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
index 0a858ca79..4c4cd71c9 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
@@ -70,6 +70,9 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
/**
* EntrySet iterator.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected static class EntrySetIterator<K, V> extends LinkIterator<K, V>
implements
OrderedIterator<Map.Entry<K, V>>, ResettableIterator<Map.Entry<K,
V>> {
@@ -91,6 +94,8 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
/**
* KeySet iterator.
+ *
+ * @param <K> the key type.
*/
protected static class KeySetIterator<K> extends LinkIterator<K, Object>
implements
OrderedIterator<K>, ResettableIterator<K> {
@@ -118,6 +123,10 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
* then you will not be able to access the protected fields.
* The {@code entryXxx()} methods on {@code AbstractLinkedMap} exist
* to provide the necessary access.
+ * </p>
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected static class LinkEntry<K, V> extends HashEntry<K, V> {
/** The entry before this one in the order */
@@ -140,6 +149,9 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
/**
* Base Iterator that iterates in link order.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected abstract static class LinkIterator<K, V> {
@@ -223,6 +235,9 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
/**
* MapIterator implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected static class LinkMapIterator<K, V> extends LinkIterator<K, V>
implements
OrderedMapIterator<K, V>, ResettableIterator<K> {
@@ -271,6 +286,8 @@ public abstract class AbstractLinkedMap<K, V> extends
AbstractHashedMap<K, V> im
/**
* Values iterator.
+ *
+ * @param <V> the value type.
*/
protected static class ValuesIterator<V> extends LinkIterator<Object, V>
implements
OrderedIterator<V>, ResettableIterator<V> {
diff --git
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
index 85af6136f..ea3d3801a 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -972,7 +972,10 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * A {@link org.apache.commons.collections4.Trie} is a set of {@link
TrieEntry} nodes.
+ * A {@link org.apache.commons.collections4.Trie} is a set of {@link
TrieEntry} nodes.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected static class TrieEntry<K, V> extends BasicEntry<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
b/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
index 68bc2e32d..78ca9b0e3 100644
---
a/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
@@ -30,6 +30,9 @@ import org.junit.jupiter.api.Test;
/**
* Abstract test class for {@link IterableMap} methods and contracts.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public abstract class AbstractIterableMapTest<K, V> extends AbstractMapTest<K,
V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
index 5a845ae77..6ecbb3ec5 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -120,6 +120,9 @@ import org.junit.jupiter.api.Test;
* If your {@link Map} fails one of these tests by design, you may still use
this base set of cases. Simply override the test case (method) your map fails
* and/or the methods that define the assumptions used by the test cases. For
example, if your map does not allow duplicate values, override
* {@link #isAllowDuplicateValues()} and have it return {@code false}
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public abstract class AbstractMapTest<K, V> extends AbstractObjectTest {
@@ -489,6 +492,9 @@ public abstract class AbstractMapTest<K, V> extends
AbstractObjectTest {
/**
* Creates a new Map Entry that is independent of the first and the map.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public static <K, V> Map.Entry<K, V> cloneMapEntry(final Map.Entry<K, V>
entry) {
final HashMap<K, V> map = new HashMap<>();
diff --git a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
b/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
index d72e1ae47..9d67084eb 100644
--- a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
+++ b/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
@@ -47,7 +47,10 @@ public class IdentityMap<K, V>
extends AbstractHashedMap<K, V> implements Serializable, Cloneable {
/**
- * HashEntry
+ * HashEntry.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
protected static class IdentityEntry<K, V> extends HashEntry<K, V> {
