Skip to content

Commit

Permalink
Add Javadoc @param tags
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jul 26, 2024
1 parent b1571cb commit 9b475c5
Show file tree
Hide file tree
Showing 30 changed files with 70 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
* Concrete subclasses must provide the iterator to be tested.
* They must also specify certain details of how the iterator operates by
* overriding the supportsXxx() methods if necessary.
* </p>
*
* @param <E> the type of elements tested by this iterator.
*/
public abstract class AbstractIteratorTest<E> extends AbstractObjectTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
* Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@
* Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@
* Concrete subclasses must provide the list iterator to be tested.
* They must also specify certain details of how the list iterator operates by
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

/**
* Tests the ArrayIterator with primitive type arrays.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ArrayIterator2Test<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
* Tests the ArrayIterator to ensure that the next() method will actually
* perform the iteration rather than the hasNext() method.
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

/**
* Test the ArrayListIterator class with primitives.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ArrayListIterator2Test<E> extends ArrayIterator2Test<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

/**
* Test the ArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ArrayListIteratorTest<E> extends ArrayIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@

/**
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@

/**
* Test the filter iterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class FilterIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

/**
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
/**
* Tests the ListIteratorWrapper to ensure that it simulates
* a ListIterator correctly.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ListIteratorWrapperTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

/**
* Tests the ObjectArrayIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ObjectArrayIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

/**
* Tests the ObjectArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ObjectArrayListIterator2Test<E> extends AbstractListIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

/**
* Tests the ObjectArrayListIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ObjectArrayListIteratorTest<E> extends ObjectArrayIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@

/**
* Tests the PeekingIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class PeekingIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@

/**
* Test class for PermutationIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class PermutationIteratorTest extends AbstractIteratorTest<List<Character>> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

/**
* Tests the PushbackIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class PushbackIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

/**
* Tests the ReverseListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class ReverseListIteratorTest<E> extends AbstractListIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
/**
* Tests the SingletonIterator to ensure that the next() method will actually
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
/**
* Tests the SingletonIterator to ensure that the next() method will actually
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

/**
* Tests the SingletonListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class SingletonListIteratorTest<E> extends AbstractListIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

/**
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

/**
* Tests the UniqueFilterIterator class.
*
* @param <E> the type of elements tested by this iterator.
*/
public class UniqueFilterIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

/**
* Tests the UnmodifiableIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class UnmodifiableIteratorTest<E> extends AbstractIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@

/**
* Tests the UnmodifiableListIterator.
*
* @param <E> the type of elements tested by this iterator.
*/
public class UnmodifiableListIteratorTest<E> extends AbstractListIteratorTest<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@

/**
* 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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@

/**
* 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> {

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@

/**
* 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> {

Expand Down

0 comments on commit 9b475c5

Please sign in to comment.