Add Javadoc @param tags

This commit is contained in:
Gary Gregory 2024-07-26 10:13:07 -04:00
parent b1571cb080
commit 9b475c56f5
30 changed files with 70 additions and 0 deletions

View File

@ -35,6 +35,9 @@ import org.junit.jupiter.api.Test;
* Concrete subclasses must provide the iterator to be tested. * Concrete subclasses must provide the iterator to be tested.
* They must also specify certain details of how the iterator operates by * They must also specify certain details of how the iterator operates by
* overriding the supportsXxx() methods if necessary. * overriding the supportsXxx() methods if necessary.
* </p>
*
* @param <E> the type of elements tested by this iterator.
*/ */
public abstract class AbstractIteratorTest<E> extends AbstractObjectTest { public abstract class AbstractIteratorTest<E> extends AbstractObjectTest {

View File

@ -35,6 +35,9 @@ import org.junit.jupiter.api.Test;
* Concrete subclasses must provide the list iterator to be tested. * Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by * They must also specify certain details of how the list iterator operates by
* overriding the supportsXxx() methods if necessary. * overriding the supportsXxx() methods if necessary.
* </p>
*
* @param <E> the type of elements tested by this iterator.
*/ */
public abstract class AbstractListIteratorTest<E> extends AbstractIteratorTest<E> { public abstract class AbstractListIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -38,6 +38,10 @@ import org.junit.jupiter.api.Test;
* Concrete subclasses must provide the list iterator to be tested. * Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by * They must also specify certain details of how the list iterator operates by
* overriding the supportsXxx() methods if necessary. * overriding the supportsXxx() methods if necessary.
* </p>
*
* @param <K> the type of the keys in the maps tested.
* @param <V> the type of the values in the maps tested.
*/ */
public abstract class AbstractMapIteratorTest<K, V> extends AbstractIteratorTest<K> { public abstract class AbstractMapIteratorTest<K, V> extends AbstractIteratorTest<K> {

View File

@ -40,6 +40,9 @@ import org.junit.jupiter.api.Test;
* Concrete subclasses must provide the list iterator to be tested. * Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by * They must also specify certain details of how the list iterator operates by
* overriding the supportsXxx() methods if necessary. * overriding the supportsXxx() methods if necessary.
*
* @param <K> the type of the keys in the maps tested.
* @param <V> the type of the values in the maps tested.
*/ */
public abstract class AbstractOrderedMapIteratorTest<K, V> extends AbstractMapIteratorTest<K, V> { public abstract class AbstractOrderedMapIteratorTest<K, V> extends AbstractMapIteratorTest<K, V> {

View File

@ -29,6 +29,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ArrayIterator with primitive type arrays. * Tests the ArrayIterator with primitive type arrays.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ArrayIterator2Test<E> extends AbstractIteratorTest<E> { public class ArrayIterator2Test<E> extends AbstractIteratorTest<E> {

View File

@ -29,6 +29,8 @@ import org.junit.jupiter.api.Test;
* Tests the ArrayIterator to ensure that the next() method will actually * Tests the ArrayIterator to ensure that the next() method will actually
* perform the iteration rather than the hasNext() method. * perform the iteration rather than the hasNext() method.
* The code of this test was supplied by Mauricio S. Moura. * The code of this test was supplied by Mauricio S. Moura.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ArrayIteratorTest<E> extends AbstractIteratorTest<E> { public class ArrayIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -18,6 +18,8 @@ package org.apache.commons.collections4.iterators;
/** /**
* Test the ArrayListIterator class with primitives. * Test the ArrayListIterator class with primitives.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ArrayListIterator2Test<E> extends ArrayIterator2Test<E> { public class ArrayListIterator2Test<E> extends ArrayIterator2Test<E> {

View File

@ -28,6 +28,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Test the ArrayListIterator class. * Test the ArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ArrayListIteratorTest<E> extends ArrayIteratorTest<E> { public class ArrayListIteratorTest<E> extends ArrayIteratorTest<E> {

View File

@ -37,6 +37,8 @@ import org.junit.jupiter.api.Test;
/** /**
* A unit test to test the basic functions of {@link BoundedIterator}. * A unit test to test the basic functions of {@link BoundedIterator}.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class BoundedIteratorTest<E> extends AbstractIteratorTest<E> { public class BoundedIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -38,6 +38,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Test the filter iterator. * Test the filter iterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class FilterIteratorTest<E> extends AbstractIteratorTest<E> { public class FilterIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -31,6 +31,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ListIteratorWrapper to ensure that it behaves as expected when wrapping a ListIterator. * Tests the ListIteratorWrapper to ensure that it behaves as expected when wrapping a ListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ListIteratorWrapper2Test<E> extends AbstractIteratorTest<E> { public class ListIteratorWrapper2Test<E> extends AbstractIteratorTest<E> {

View File

@ -32,6 +32,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ListIteratorWrapper to ensure that it simulates * Tests the ListIteratorWrapper to ensure that it simulates
* a ListIterator correctly. * a ListIterator correctly.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ListIteratorWrapperTest<E> extends AbstractIteratorTest<E> { public class ListIteratorWrapperTest<E> extends AbstractIteratorTest<E> {

View File

@ -27,6 +27,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ObjectArrayIterator. * Tests the ObjectArrayIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ObjectArrayIteratorTest<E> extends AbstractIteratorTest<E> { public class ObjectArrayIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -18,6 +18,8 @@ package org.apache.commons.collections4.iterators;
/** /**
* Tests the ObjectArrayListIterator class. * Tests the ObjectArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ObjectArrayListIterator2Test<E> extends AbstractListIteratorTest<E> { public class ObjectArrayListIterator2Test<E> extends AbstractListIteratorTest<E> {

View File

@ -28,6 +28,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ObjectArrayListIterator class. * Tests the ObjectArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ObjectArrayListIteratorTest<E> extends ObjectArrayIteratorTest<E> { public class ObjectArrayListIteratorTest<E> extends ObjectArrayIteratorTest<E> {

View File

@ -34,6 +34,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the PeekingIterator. * Tests the PeekingIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class PeekingIteratorTest<E> extends AbstractIteratorTest<E> { public class PeekingIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -34,6 +34,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Test class for PermutationIterator. * Test class for PermutationIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class PermutationIteratorTest extends AbstractIteratorTest<List<Character>> { public class PermutationIteratorTest extends AbstractIteratorTest<List<Character>> {

View File

@ -31,6 +31,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the PushbackIterator. * Tests the PushbackIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class PushbackIteratorTest<E> extends AbstractIteratorTest<E> { public class PushbackIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -33,6 +33,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the ReverseListIterator. * Tests the ReverseListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class ReverseListIteratorTest<E> extends AbstractListIteratorTest<E> { public class ReverseListIteratorTest<E> extends AbstractListIteratorTest<E> {

View File

@ -29,6 +29,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the SingletonIterator to ensure that the next() method will actually * Tests the SingletonIterator to ensure that the next() method will actually
* perform the iteration rather than the hasNext() method. * perform the iteration rather than the hasNext() method.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class SingletonIterator2Test<E> extends AbstractIteratorTest<E> { public class SingletonIterator2Test<E> extends AbstractIteratorTest<E> {

View File

@ -29,6 +29,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the SingletonIterator to ensure that the next() method will actually * Tests the SingletonIterator to ensure that the next() method will actually
* perform the iteration rather than the hasNext() method. * perform the iteration rather than the hasNext() method.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class SingletonIteratorTest<E> extends AbstractIteratorTest<E> { public class SingletonIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -28,6 +28,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the SingletonListIterator. * Tests the SingletonListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class SingletonListIteratorTest<E> extends AbstractListIteratorTest<E> { public class SingletonListIteratorTest<E> extends AbstractListIteratorTest<E> {

View File

@ -33,6 +33,8 @@ import org.junit.jupiter.api.Test;
/** /**
* A unit test to test the basic functions of {@link SkippingIterator}. * A unit test to test the basic functions of {@link SkippingIterator}.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class SkippingIteratorTest<E> extends AbstractIteratorTest<E> { public class SkippingIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -29,6 +29,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the UniqueFilterIterator class. * Tests the UniqueFilterIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class UniqueFilterIteratorTest<E> extends AbstractIteratorTest<E> { public class UniqueFilterIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -33,6 +33,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the UnmodifiableIterator. * Tests the UnmodifiableIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class UnmodifiableIteratorTest<E> extends AbstractIteratorTest<E> { public class UnmodifiableIteratorTest<E> extends AbstractIteratorTest<E> {

View File

@ -33,6 +33,8 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the UnmodifiableListIterator. * Tests the UnmodifiableListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/ */
public class UnmodifiableListIteratorTest<E> extends AbstractListIteratorTest<E> { public class UnmodifiableListIteratorTest<E> extends AbstractListIteratorTest<E> {

View File

@ -32,6 +32,9 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the UnmodifiableMapIterator. * Tests the UnmodifiableMapIterator.
*
* @param <K> the type of the keys in the maps tested.
* @param <V> the type of the values in the maps tested.
*/ */
public class UnmodifiableMapIteratorTest<K, V> extends AbstractMapIteratorTest<K, V> { public class UnmodifiableMapIteratorTest<K, V> extends AbstractMapIteratorTest<K, V> {

View File

@ -33,6 +33,9 @@ import org.junit.jupiter.api.Test;
/** /**
* Tests the UnmodifiableOrderedMapIterator. * Tests the UnmodifiableOrderedMapIterator.
*
* @param <K> the type of the keys in the maps tested.
* @param <V> the type of the values in the maps tested.
*/ */
public class UnmodifiableOrderedMapIteratorTest<K, V> extends AbstractOrderedMapIteratorTest<K, V> { public class UnmodifiableOrderedMapIteratorTest<K, V> extends AbstractOrderedMapIteratorTest<K, V> {

View File

@ -47,11 +47,15 @@ import org.junit.jupiter.api.Test;
* <p> * <p>
* To use, simply extend this class, and implement * To use, simply extend this class, and implement
* the {@link #makeObject} method. * the {@link #makeObject} method.
* </p>
* <p> * <p>
* If your {@link List} fails one of these tests by design, * If your {@link List} fails one of these tests by design,
* you may still use this base set of cases. Simply override the * you may still use this base set of cases. Simply override the
* test case (method) your {@link List} fails or override one of the * test case (method) your {@link List} fails or override one of the
* protected methods from AbstractCollectionTest. * protected methods from AbstractCollectionTest.
* </p>
*
* @param <E> the type of elements returned by this iterator
*/ */
public abstract class AbstractListTest<E> extends AbstractCollectionTest<E> { public abstract class AbstractListTest<E> extends AbstractCollectionTest<E> {

View File

@ -38,6 +38,9 @@ import org.junit.jupiter.api.Test;
/** /**
* Abstract test class for {@link OrderedMap} methods and contracts. * Abstract test class for {@link OrderedMap} methods and contracts.
*
* @param <K> the type of the keys in the maps tested.
* @param <V> the type of the values in the maps tested.
*/ */
public abstract class AbstractOrderedMapTest<K, V> extends AbstractIterableMapTest<K, V> { public abstract class AbstractOrderedMapTest<K, V> extends AbstractIterableMapTest<K, V> {