Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix various javadoc link warnings 

bug 23680, from Eric Johnson


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131282 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-10-10 21:19:39 +00:00
parent dac6d48cb0
commit dea6e42a7c
6 changed files with 55 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/test/org/apache/commons/collections/AbstractTestCollection.java
View File

@ -1,5 +1,5 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestCollection.java,v 1.4 2003/10/10 21:07:48 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestCollection.java,v 1.5 2003/10/10 21:19:39 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -122,7 +122,7 @@ import java.util.NoSuchElementException;
* {@link #confirmed}, the {@link #verify()} method is invoked to compare * {@link #confirmed}, the {@link #verify()} method is invoked to compare
* the results. You may want to override {@link #verify()} to perform * the results. You may want to override {@link #verify()} to perform
* additional verifications. For instance, when testing the collection * additional verifications. For instance, when testing the collection
* views of a map, {@link TestMap} would override {@link #verify()} to make * views of a map, {@link AbstractTestMap} would override {@link #verify()} to make
* sure the map is changed after the collection view is changed. * sure the map is changed after the collection view is changed.
* <p> * <p>
* If you're extending this class directly, you will have to provide * If you're extending this class directly, you will have to provide
@ -135,8 +135,8 @@ import java.util.NoSuchElementException;
* Those methods should provide a confirmed collection implementation * Those methods should provide a confirmed collection implementation
* that's compatible with your collection implementation. * that's compatible with your collection implementation.
* <p> * <p>
* If you're extending {@link TestList}, {@link TestSet}, * If you're extending {@link AbstractTestList}, {@link AbstractTestSet},
* or {@link TestBag}, you probably don't have to worry about the * or {@link AbstractTestBag}, you probably don't have to worry about the
* above methods, because those three classes already override the methods * above methods, because those three classes already override the methods
* to provide standard JDK confirmed collections.<P> * to provide standard JDK confirmed collections.<P>
* <p> * <p>
@ -146,7 +146,7 @@ import java.util.NoSuchElementException;
* 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 Collection} fails. * test case (method) your {@link Collection} fails.
* *
* @version $Revision: 1.4 $ $Date: 2003/10/10 21:07:48 $ * @version $Revision: 1.5 $ $Date: 2003/10/10 21:19:39 $
* *
* @author Rodney Waldhoff * @author Rodney Waldhoff
* @author Paul Jack * @author Paul Jack

18
src/test/org/apache/commons/collections/AbstractTestList.java
View File

@ -1,5 +1,5 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestList.java,v 1.1 2003/10/02 22:14:29 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestList.java,v 1.2 2003/10/10 21:19:39 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -76,14 +76,14 @@ import java.util.NoSuchElementException;
* Abstract test class for {@link java.util.List} methods and contracts. * Abstract test class for {@link java.util.List} methods and contracts.
* <p> * <p>
* To use, simply extend this class, and implement * To use, simply extend this class, and implement
* the {@link #makeList} method. * the {@link #makeEmptyList} method.
* <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 AbstractTestCollection. * protected methods from AbstractTestCollection.
* *
* @version $Revision: 1.1 $ $Date: 2003/10/02 22:14:29 $ * @version $Revision: 1.2 $ $Date: 2003/10/10 21:19:39 $
* *
* @author Rodney Waldhoff * @author Rodney Waldhoff
* @author Paul Jack * @author Paul Jack
@ -184,7 +184,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
} }
/** /**
* Returns {@link makeEmptyList()}. * Returns {@link #makeEmptyList()}.
* *
* @return an empty list to be used for testing * @return an empty list to be used for testing
*/ */
@ -193,7 +193,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
} }
/** /**
* Returns {@link makeFullList()}. * Returns {@link #makeFullList()}.
* *
* @return a full list to be used for testing * @return a full list to be used for testing
*/ */
@ -203,7 +203,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
* Returns the {@link collection} field cast to a {@link List}. * Returns the {@link #collection} field cast to a {@link List}.
* *
* @return the collection field as a List * @return the collection field as a List
*/ */
@ -212,7 +212,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
} }
/** /**
* Returns the {@link confirmed} field cast to a {@link List}. * Returns the {@link #confirmed} field cast to a {@link List}.
* *
* @return the confirmed field as a List * @return the confirmed field as a List
*/ */
@ -499,7 +499,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
} }
/** /**
* Tests {@link List#indexOf()}. * Tests {@link List#indexOf}.
*/ */
public void testListIndexOf() { public void testListIndexOf() {
resetFull(); resetFull();
@ -523,7 +523,7 @@ public abstract class AbstractTestList extends AbstractTestCollection {
} }
/** /**
* Tests {@link List#lastIndexOf()}. * Tests {@link List#lastIndexOf}.
*/ */
public void testListLastIndexOf() { public void testListLastIndexOf() {
resetFull(); resetFull();

55
src/test/org/apache/commons/collections/AbstractTestMap.java
View File

@ -1,5 +1,5 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestMap.java,v 1.7 2003/10/10 21:08:26 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestMap.java,v 1.8 2003/10/10 21:19:39 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -72,8 +72,8 @@ import java.util.Set;
* <p> * <p>
* The forces at work here are similar to those in {@link AbstractTestCollection}. * The forces at work here are similar to those in {@link AbstractTestCollection}.
* If your class implements the full Map interface, including optional * If your class implements the full Map interface, including optional
* operations, simply extend this class, and implement the {@link * operations, simply extend this class, and implement the
* #makeEmptyMap()} method. * {@link #makeEmptyMap()} method.
* <p> * <p>
* On the other hand, if your map implementation is weird, you may have to * On the other hand, if your map implementation is weird, you may have to
* override one or more of the other protected methods. They're described * override one or more of the other protected methods. They're described
@ -131,12 +131,12 @@ import java.util.Set;
* empty or full maps, so that tests can proceed from a known state.<P> * empty or full maps, so that tests can proceed from a known state.<P>
* *
* After a modification operation to both {@link #map} and {@link #confirmed}, * After a modification operation to both {@link #map} and {@link #confirmed},
* the {@link #verify()} method is invoked to compare the results. The {@link * the {@link #verify()} method is invoked to compare the results. The
* verify()} method calls separate methods to verify the map and its three * {@link #verify} method calls separate methods to verify the map and its three
* collection views ({@link verifyMap(), {@link verifyEntrySet()}, {@link * collection views ({@link #verifyMap}, {@link #verifyEntrySet},
* verifyKeySet()}, and {@link verifyValues()}). You may want to override one * {@link #verifyKeySet}, and {@link #verifyValues}). You may want to override
* of the verification methodsto perform additional verifications. For * one of the verification methodsto perform additional verifications. For
* instance, {@link TestDoubleOrderedMap} would want override its * instance, TestDoubleOrderedMap would want override its
* {@link #verifyValues()} method to verify that the values are unique and in * {@link #verifyValues()} method to verify that the values are unique and in
* ascending order.<P> * ascending order.<P>
* *
@ -152,7 +152,7 @@ import java.util.Set;
* @author Rodney Waldhoff * @author Rodney Waldhoff
* @author Paul Jack * @author Paul Jack
* @author Stephen Colebourne * @author Stephen Colebourne
* @version $Revision: 1.7 $ $Date: 2003/10/10 21:08:26 $ * @version $Revision: 1.8 $ $Date: 2003/10/10 21:19:39 $
*/ */
public abstract class AbstractTestMap extends AbstractTestObject { public abstract class AbstractTestMap extends AbstractTestObject {
@ -292,9 +292,11 @@ public abstract class AbstractTestMap extends AbstractTestObject {
/** /**
* Returns a list of string elements suitable for return by * Returns a list of string elements suitable for return by
* {@link getOtherElements()}. Override getOtherElements to return * {@link #getOtherKeys()} or {@link #getOtherValues}.
* the results of this method if your collection does not support *
* heterogenous elements or the null element. * <p>Override getOtherElements to returnthe results of this method if your
* collection does not support heterogenous elements or the null element.
* </p>
*/ */
protected Object[] getOtherNonNullStringElements() { protected Object[] getOtherNonNullStringElements() {
return new Object[] { return new Object[] {
@ -308,7 +310,7 @@ public abstract class AbstractTestMap extends AbstractTestObject {
* method must return an array with the same length as * method must return an array with the same length as
* {@link #getSampleKeys()}. The default implementation constructs a set of * {@link #getSampleKeys()}. The default implementation constructs a set of
* String values and includes a single null value if * String values and includes a single null value if
* {@link #isNullValueSupported()} returns <code>true</code>, and includes * {@link #isAllowNullValue()} returns <code>true</code>, and includes
* two values that are the same if {@link #isAllowDuplicateValues()} returns * two values that are the same if {@link #isAllowDuplicateValues()} returns
* <code>true</code>. * <code>true</code>.
*/ */
@ -330,7 +332,7 @@ public abstract class AbstractTestMap extends AbstractTestObject {
* returned from this method should not be the same as those returned from * returned from this method should not be the same as those returned from
* {@link #getSampleValues()}. The default implementation constructs a * {@link #getSampleValues()}. The default implementation constructs a
* set of String values and includes a single null value if * set of String values and includes a single null value if
* {@link #isNullValueSupported()} returns <code>true</code>, and includes two values * {@link #isAllowNullValue()} returns <code>true</code>, and includes two values
* that are the same if {@link #isAllowDuplicateValues()} returns * that are the same if {@link #isAllowDuplicateValues()} returns
* <code>true</code>. * <code>true</code>.
*/ */
@ -390,7 +392,7 @@ public abstract class AbstractTestMap extends AbstractTestObject {
* Return a new, populated map. The mappings in the map should match the * Return a new, populated map. The mappings in the map should match the
* keys and values returned from {@link #getSampleKeys()} and {@link * keys and values returned from {@link #getSampleKeys()} and {@link
* #getSampleValues()}. The default implementation uses makeEmptyMap() * #getSampleValues()}. The default implementation uses makeEmptyMap()
* and calls {@link #addSampleMappings()} to add all the mappings to the * and calls {@link #addSampleMappings} to add all the mappings to the
* map. * map.
* *
* @return the map to be tested * @return the map to be tested
@ -787,7 +789,7 @@ public abstract class AbstractTestMap extends AbstractTestObject {
resetFull(); resetFull();
int i = 0; int i = 0;
for (Iterator it = map.keySet().iterator(); it.hasNext() && i < newValues.length; i++) { for (Iterator it = map.keySet().iterator(); it.hasNext() && i < newValues.length; i++) {
Object key = (Object) it.next(); Object key = it.next();
Object o = map.put(key, newValues[i]); Object o = map.put(key, newValues[i]);
Object value = confirmed.put(key, newValues[i]); Object value = confirmed.put(key, newValues[i]);
verify(); verify();
@ -988,8 +990,11 @@ public abstract class AbstractTestMap extends AbstractTestObject {
* from the map are removed from the values collection--also, * from the map are removed from the values collection--also,
* but that's a more difficult test to construct (lacking a * but that's a more difficult test to construct (lacking a
* "removeValue" method.) * "removeValue" method.)
* * </p>
* @see http://issues.apache.org/bugzilla/show_bug.cgi?id=9573 * <p>
* See bug <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=9573">
* 9573</a>.
* </p>
*/ */
public void testValuesRemoveChangesMap() { public void testValuesRemoveChangesMap() {
resetFull(); resetFull();
@ -1061,11 +1066,11 @@ public abstract class AbstractTestMap extends AbstractTestObject {
/** /**
* Bulk test {@link Map#entrySet()}. This method runs through all of * Bulk test {@link Map#entrySet()}. This method runs through all of
* the tests in {@link TestSet}. * the tests in {@link AbstractTestSet}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the map and the other collection views are still valid. * that the map and the other collection views are still valid.
* *
* @return a {@link TestSet} instance for testing the map's entry set * @return a {@link AbstractTestSet} instance for testing the map's entry set
*/ */
public BulkTest bulkTestMapEntrySet() { public BulkTest bulkTestMapEntrySet() {
return new TestMapEntrySet(); return new TestMapEntrySet();
@ -1129,11 +1134,11 @@ public abstract class AbstractTestMap extends AbstractTestObject {
/** /**
* Bulk test {@link Map#keySet()}. This method runs through all of * Bulk test {@link Map#keySet()}. This method runs through all of
* the tests in {@link TestSet}. * the tests in {@link AbstractTestSet}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the map and the other collection views are still valid. * that the map and the other collection views are still valid.
* *
* @return a {@link TestSet} instance for testing the map's key set * @return a {@link AbstractTestSet} instance for testing the map's key set
*/ */
public BulkTest bulkTestMapKeySet() { public BulkTest bulkTestMapKeySet() {
return new TestMapKeySet(); return new TestMapKeySet();
@ -1192,11 +1197,11 @@ public abstract class AbstractTestMap extends AbstractTestObject {
/** /**
* Bulk test {@link Map#values()}. This method runs through all of * Bulk test {@link Map#values()}. This method runs through all of
* the tests in {@link TestCollection}. * the tests in {@link AbstractTestCollection}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the map and the other collection views are still valid. * that the map and the other collection views are still valid.
* *
* @return a {@link TestCollection} instance for testing the map's * @return a {@link AbstractTestCollection} instance for testing the map's
* values collection * values collection
*/ */
public BulkTest bulkTestMapValues() { public BulkTest bulkTestMapValues() {

6
src/test/org/apache/commons/collections/AbstractTestSet.java
View File

@ -1,5 +1,5 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestSet.java,v 1.2 2003/10/05 23:10:31 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestSet.java,v 1.3 2003/10/10 21:19:39 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import java.util.Set;
* <p> * <p>
* Since {@link Set} doesn't stipulate much new behavior that isn't already * Since {@link Set} doesn't stipulate much new behavior that isn't already
* found in {@link Collection}, this class basically just adds tests for * found in {@link Collection}, this class basically just adds tests for
* {@link Set#equals()} and {@link Set#hashCode()} along with an updated * {@link Set#equals} and {@link Set#hashCode()} along with an updated
* {@link #verify()} that ensures elements do not appear more than once in the * {@link #verify()} that ensures elements do not appear more than once in the
* set. * set.
* <p> * <p>
@ -78,7 +78,7 @@ import java.util.Set;
* elements may be added; see {@link AbstractTestCollection} for more details. * elements may be added; see {@link AbstractTestCollection} for more details.
* *
* @since Commons Collections 3.0 * @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/10/05 23:10:31 $ * @version $Revision: 1.3 $ $Date: 2003/10/10 21:19:39 $
* *
* @author Paul Jack * @author Paul Jack
*/ */

10
src/test/org/apache/commons/collections/AbstractTestSortedSet.java
View File

@ -1,5 +1,5 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestSortedSet.java,v 1.2 2003/10/05 23:10:31 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/AbstractTestSortedSet.java,v 1.3 2003/10/10 21:19:39 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -72,7 +72,7 @@ import java.util.TreeSet;
* elements may be added; see {@link AbstractTestCollection} for more details. * elements may be added; see {@link AbstractTestCollection} for more details.
* *
* @since Commons Collections 3.0 * @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/10/05 23:10:31 $ * @version $Revision: 1.3 $ $Date: 2003/10/10 21:19:39 $
* *
* @author Stephen Colebourne * @author Stephen Colebourne
* @author Dieter Wimberger * @author Dieter Wimberger
@ -159,7 +159,7 @@ public abstract class AbstractTestSortedSet extends AbstractTestSet {
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/** /**
* Bulk test {@link SortedSet#subSet(Object, Object)}. This method runs through all of * Bulk test {@link SortedSet#subSet(Object, Object)}. This method runs through all of
* the tests in {@link TestSortedSet}. * the tests in {@link AbstractTestSortedSet}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the set and the other collection views are still valid. * that the set and the other collection views are still valid.
* *
@ -176,7 +176,7 @@ public abstract class AbstractTestSortedSet extends AbstractTestSet {
/** /**
* Bulk test {@link SortedSet#headSet(Object)}. This method runs through all of * Bulk test {@link SortedSet#headSet(Object)}. This method runs through all of
* the tests in {@link TestSortedSet}. * the tests in {@link AbstractTestSortedSet}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the set and the other collection views are still valid. * that the set and the other collection views are still valid.
* *
@ -193,7 +193,7 @@ public abstract class AbstractTestSortedSet extends AbstractTestSet {
/** /**
* Bulk test {@link SortedSet#tailSet(Object)}. This method runs through all of * Bulk test {@link SortedSet#tailSet(Object)}. This method runs through all of
* the tests in {@link TestSortedSet}. * the tests in {@link AbstractTestSortedSet}.
* After modification operations, {@link #verify()} is invoked to ensure * After modification operations, {@link #verify()} is invoked to ensure
* that the set and the other collection views are still valid. * that the set and the other collection views are still valid.
* *

3
src/test/org/apache/commons/collections/overview.html
View File

@ -1,4 +1,7 @@
<body> <body>
<p>The Collections Test Framework is an extension to JUnit to enable quick and easy testing
of collections.</p>
<h3>Apache Jakarta Commons Collections Test Framework</h3> <h3>Apache Jakarta Commons Collections Test Framework</h3>
<p> <p>