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 8dd0cc14b Javadoc
8dd0cc14b is described below
commit 8dd0cc14bc5a3a15e538ba16335be8163cdab9a3
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Sep 23 10:49:40 2024 -0400
Javadoc
---
.../org/apache/commons/collections4/map/AbstractSortedMapTest.java | 3 +++
.../org/apache/commons/collections4/map/CaseInsensitiveMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/CompositeMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/DefaultedMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/FixedSizeMapTest.java | 3 +++
.../org/apache/commons/collections4/map/FixedSizeSortedMapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/Flat3MapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/HashedMapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/LRUMapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/LazyMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/LazySortedMapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/LinkedMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/ListOrderedMap2Test.java | 3 +++
.../java/org/apache/commons/collections4/map/ListOrderedMapTest.java | 3 +++
src/test/java/org/apache/commons/collections4/map/MultiKeyMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/MultiValueMapTest.java | 3 +++
.../org/apache/commons/collections4/map/PassiveExpiringMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/PredicatedMapTest.java | 3 +++
.../org/apache/commons/collections4/map/PredicatedSortedMapTest.java | 3 +++
.../org/apache/commons/collections4/map/ReferenceIdentityMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/ReferenceMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/SingletonMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/StaticBucketMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/TransformedMapTest.java | 3 +++
.../org/apache/commons/collections4/map/TransformedSortedMapTest.java | 3 +++
.../java/org/apache/commons/collections4/map/UnmodifiableMapTest.java | 3 +++
.../apache/commons/collections4/map/UnmodifiableOrderedMapTest.java | 3 +++
.../org/apache/commons/collections4/map/UnmodifiableSortedMapTest.java | 3 +++
28 files changed, 84 insertions(+)
diff --git
a/src/test/java/org/apache/commons/collections4/map/AbstractSortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/AbstractSortedMapTest.java
index b375dbf0e..d854e00b8 100644
---
a/src/test/java/org/apache/commons/collections4/map/AbstractSortedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/AbstractSortedMapTest.java
@@ -32,6 +32,9 @@ import org.junit.jupiter.api.Test;
/**
* Abstract test class for {@link java.util.SortedMap} methods and contracts.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public abstract class AbstractSortedMapTest<K, V> extends AbstractMapTest<K,
V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/CaseInsensitiveMapTest.java
b/src/test/java/org/apache/commons/collections4/map/CaseInsensitiveMapTest.java
index 71417bb87..9ec7bef3e 100644
---
a/src/test/java/org/apache/commons/collections4/map/CaseInsensitiveMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/CaseInsensitiveMapTest.java
@@ -30,6 +30,9 @@ import org.junit.jupiter.api.Test;
/**
* Tests for the {@link CaseInsensitiveMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class CaseInsensitiveMapTest<K, V> extends AbstractIterableMapTest<K,
V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
b/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
index 2ea551129..6cfdd785b 100644
--- a/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
@@ -31,6 +31,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the
* {@link CompositeMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class CompositeMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/DefaultedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/DefaultedMapTest.java
index e7ba8a2d7..2fc17830a 100644
--- a/src/test/java/org/apache/commons/collections4/map/DefaultedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/DefaultedMapTest.java
@@ -36,6 +36,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the
* {@link DefaultedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class DefaultedMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/FixedSizeMapTest.java
b/src/test/java/org/apache/commons/collections4/map/FixedSizeMapTest.java
index 5b86428c4..9be20e686 100644
--- a/src/test/java/org/apache/commons/collections4/map/FixedSizeMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/FixedSizeMapTest.java
@@ -24,6 +24,9 @@ import org.apache.commons.collections4.IterableMap;
/**
* Extension of {@link AbstractMapTest} for exercising the {@link FixedSizeMap}
* implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class FixedSizeMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/FixedSizeSortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/FixedSizeSortedMapTest.java
index 552cff47c..acf768428 100644
---
a/src/test/java/org/apache/commons/collections4/map/FixedSizeSortedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/FixedSizeSortedMapTest.java
@@ -22,6 +22,9 @@ import java.util.TreeMap;
/**
* Extension of {@link AbstractSortedMapTest} for exercising the {@link
FixedSizeSortedMap}
* implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class FixedSizeSortedMapTest<K, V> extends AbstractSortedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/Flat3MapTest.java
b/src/test/java/org/apache/commons/collections4/map/Flat3MapTest.java
index 0e85dbf44..a13c743a4 100644
--- a/src/test/java/org/apache/commons/collections4/map/Flat3MapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/Flat3MapTest.java
@@ -41,6 +41,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class Flat3MapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/HashedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/HashedMapTest.java
index fbeedb0a9..216896360 100644
--- a/src/test/java/org/apache/commons/collections4/map/HashedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/HashedMapTest.java
@@ -23,6 +23,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class HashedMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git a/src/test/java/org/apache/commons/collections4/map/LRUMapTest.java
b/src/test/java/org/apache/commons/collections4/map/LRUMapTest.java
index 0a4be6229..8c17fcb5d 100644
--- a/src/test/java/org/apache/commons/collections4/map/LRUMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/LRUMapTest.java
@@ -39,6 +39,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class LRUMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
diff --git a/src/test/java/org/apache/commons/collections4/map/LazyMapTest.java
b/src/test/java/org/apache/commons/collections4/map/LazyMapTest.java
index 68ca3d7b0..344131938 100644
--- a/src/test/java/org/apache/commons/collections4/map/LazyMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/LazyMapTest.java
@@ -32,6 +32,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the
* {@link LazyMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
@SuppressWarnings("boxing")
public class LazyMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/LazySortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/LazySortedMapTest.java
index 418e1fccd..7d341bdba 100644
--- a/src/test/java/org/apache/commons/collections4/map/LazySortedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/LazySortedMapTest.java
@@ -39,6 +39,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link LazyMapTest} for exercising the
* {@link LazySortedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
@SuppressWarnings("boxing")
public class LazySortedMapTest<K, V> extends AbstractSortedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/LinkedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/LinkedMapTest.java
index 6d58d40a5..6afea17e2 100644
--- a/src/test/java/org/apache/commons/collections4/map/LinkedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/LinkedMapTest.java
@@ -34,6 +34,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class LinkedMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/ListOrderedMap2Test.java
b/src/test/java/org/apache/commons/collections4/map/ListOrderedMap2Test.java
index 4e6c89804..0c05682af 100644
--- a/src/test/java/org/apache/commons/collections4/map/ListOrderedMap2Test.java
+++ b/src/test/java/org/apache/commons/collections4/map/ListOrderedMap2Test.java
@@ -30,6 +30,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractOrderedMapTest} for exercising the {@link
ListOrderedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class ListOrderedMap2Test<K, V> extends AbstractOrderedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/ListOrderedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/ListOrderedMapTest.java
index e05f52021..ea7926dce 100644
--- a/src/test/java/org/apache/commons/collections4/map/ListOrderedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/ListOrderedMapTest.java
@@ -36,6 +36,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractOrderedMapTest} for exercising the {@link
ListOrderedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class ListOrderedMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/MultiKeyMapTest.java
b/src/test/java/org/apache/commons/collections4/map/MultiKeyMapTest.java
index a1f0ae68d..795b0bf58 100644
--- a/src/test/java/org/apache/commons/collections4/map/MultiKeyMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/MultiKeyMapTest.java
@@ -32,6 +32,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class MultiKeyMapTest<K, V> extends AbstractIterableMapTest<MultiKey<?
extends K>, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/MultiValueMapTest.java
b/src/test/java/org/apache/commons/collections4/map/MultiValueMapTest.java
index 353bb495b..c129cc7da 100644
--- a/src/test/java/org/apache/commons/collections4/map/MultiValueMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/MultiValueMapTest.java
@@ -44,6 +44,9 @@ import org.junit.jupiter.api.Test;
/**
* TestMultiValueMap.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
@Deprecated
public class MultiValueMapTest<K, V> extends AbstractObjectTest {
diff --git
a/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
b/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
index 7554a1718..e6fa7ff6f 100644
---
a/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
@@ -35,6 +35,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class PassiveExpiringMapTest<K, V> extends AbstractMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/PredicatedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/PredicatedMapTest.java
index ffcc97dbd..d6c7a8f88 100644
--- a/src/test/java/org/apache/commons/collections4/map/PredicatedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/PredicatedMapTest.java
@@ -33,6 +33,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the
* {@link PredicatedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class PredicatedMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/PredicatedSortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/PredicatedSortedMapTest.java
index 026336728..06c62467c 100644
---
a/src/test/java/org/apache/commons/collections4/map/PredicatedSortedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/PredicatedSortedMapTest.java
@@ -38,6 +38,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link PredicatedMapTest} for exercising the
* {@link PredicatedSortedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class PredicatedSortedMapTest<K, V> extends AbstractSortedMapTest<K, V>
{
diff --git
a/src/test/java/org/apache/commons/collections4/map/ReferenceIdentityMapTest.java
b/src/test/java/org/apache/commons/collections4/map/ReferenceIdentityMapTest.java
index cde2d200d..555928a6d 100644
---
a/src/test/java/org/apache/commons/collections4/map/ReferenceIdentityMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/ReferenceIdentityMapTest.java
@@ -35,6 +35,9 @@ import org.junit.jupiter.api.Test;
/**
* Tests for ReferenceIdentityMap.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class ReferenceIdentityMapTest<K, V> extends AbstractIterableMapTest<K,
V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/ReferenceMapTest.java
b/src/test/java/org/apache/commons/collections4/map/ReferenceMapTest.java
index c91261719..345fceda1 100644
--- a/src/test/java/org/apache/commons/collections4/map/ReferenceMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/ReferenceMapTest.java
@@ -44,6 +44,9 @@ import org.junit.jupiter.api.Test;
/**
* Tests for ReferenceMap.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class ReferenceMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/SingletonMapTest.java
b/src/test/java/org/apache/commons/collections4/map/SingletonMapTest.java
index dfd074ab9..d0a34d247 100644
--- a/src/test/java/org/apache/commons/collections4/map/SingletonMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/SingletonMapTest.java
@@ -29,6 +29,9 @@ import org.junit.jupiter.api.Test;
/**
* JUnit tests.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class SingletonMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/StaticBucketMapTest.java
b/src/test/java/org/apache/commons/collections4/map/StaticBucketMapTest.java
index eba38e68c..9a5d23fcb 100644
--- a/src/test/java/org/apache/commons/collections4/map/StaticBucketMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/StaticBucketMapTest.java
@@ -26,6 +26,9 @@ import org.junit.jupiter.api.Test;
/**
* Unit tests.
* {@link StaticBucketMap}.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class StaticBucketMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/TransformedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/TransformedMapTest.java
index 0349fd86e..bec86bcbe 100644
--- a/src/test/java/org/apache/commons/collections4/map/TransformedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/TransformedMapTest.java
@@ -34,6 +34,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the {@link
TransformedMap}
* implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class TransformedMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/TransformedSortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/TransformedSortedMapTest.java
index 7b79b65e7..170d4b0b3 100644
---
a/src/test/java/org/apache/commons/collections4/map/TransformedSortedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/TransformedSortedMapTest.java
@@ -34,6 +34,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractSortedMapTest} for exercising the {@link
TransformedSortedMap}
* implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class TransformedSortedMapTest<K, V> extends AbstractSortedMapTest<K,
V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/UnmodifiableMapTest.java
b/src/test/java/org/apache/commons/collections4/map/UnmodifiableMapTest.java
index 9b3c5e6fc..230c33f14 100644
--- a/src/test/java/org/apache/commons/collections4/map/UnmodifiableMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/UnmodifiableMapTest.java
@@ -30,6 +30,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractMapTest} for exercising the
* {@link UnmodifiableMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class UnmodifiableMapTest<K, V> extends AbstractIterableMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/UnmodifiableOrderedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/UnmodifiableOrderedMapTest.java
index 34c53c97b..4cbaccc9e 100644
---
a/src/test/java/org/apache/commons/collections4/map/UnmodifiableOrderedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/UnmodifiableOrderedMapTest.java
@@ -29,6 +29,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractOrderedMapTest} for exercising the
* {@link UnmodifiableOrderedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class UnmodifiableOrderedMapTest<K, V> extends
AbstractOrderedMapTest<K, V> {
diff --git
a/src/test/java/org/apache/commons/collections4/map/UnmodifiableSortedMapTest.java
b/src/test/java/org/apache/commons/collections4/map/UnmodifiableSortedMapTest.java
index fdd9fa48e..9bae3a78a 100644
---
a/src/test/java/org/apache/commons/collections4/map/UnmodifiableSortedMapTest.java
+++
b/src/test/java/org/apache/commons/collections4/map/UnmodifiableSortedMapTest.java
@@ -29,6 +29,9 @@ import org.junit.jupiter.api.Test;
/**
* Extension of {@link AbstractSortedMapTest} for exercising the
* {@link UnmodifiableSortedMap} implementation.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
*/
public class UnmodifiableSortedMapTest<K, V> extends AbstractSortedMapTest<K,
V> {
