commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections/src/test/org/apache/commons/collections AbstractTestMap.java overview.html AbstractTestList.java AbstractTestCollection.java AbstractTestSet.java AbstractTestSortedSet.java
Date Fri, 10 Oct 2003 21:19:40 GMT
scolebourne    2003/10/10 14:19:40

  Modified:    collections/src/test/org/apache/commons/collections
                        AbstractTestMap.java overview.html
                        AbstractTestList.java AbstractTestCollection.java
                        AbstractTestSet.java AbstractTestSortedSet.java
  Log:
  Fix various javadoc link warnings
  bug 23680, from Eric Johnson
  
  Revision  Changes    Path
  1.8       +30 -25    jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestMap.java
  
  Index: AbstractTestMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestMap.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- AbstractTestMap.java	10 Oct 2003 21:08:26 -0000	1.7
  +++ AbstractTestMap.java	10 Oct 2003 21:19:39 -0000	1.8
  @@ -72,8 +72,8 @@
    * <p>
    * The forces at work here are similar to those in {@link AbstractTestCollection}.
    * If your class implements the full Map interface, including optional
  - * operations, simply extend this class, and implement the {@link
  - * #makeEmptyMap()} method.
  + * operations, simply extend this class, and implement the
  + * {@link #makeEmptyMap()} method.
    * <p>
    * 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
  @@ -131,12 +131,12 @@
    * 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},
  - * the {@link #verify()} method is invoked to compare the results.  The {@link
  - * verify()} method calls separate methods to verify the map and its three
  - * collection views ({@link verifyMap(), {@link verifyEntrySet()}, {@link
  - * verifyKeySet()}, and {@link verifyValues()}).  You may want to override one
  - * of the verification methodsto perform additional verifications.  For
  - * instance, {@link TestDoubleOrderedMap} would want override its
  + * the {@link #verify()} method is invoked to compare the results.  The
  + * {@link #verify} method calls separate methods to verify the map and its three
  + * collection views ({@link #verifyMap}, {@link #verifyEntrySet},
  + * {@link #verifyKeySet}, and {@link #verifyValues}).  You may want to override
  + * one of the verification methodsto perform additional verifications.  For
  + * instance, TestDoubleOrderedMap would want override its
    * {@link #verifyValues()} method to verify that the values are unique and in
    * ascending order.<P>
    *  
  @@ -292,9 +292,11 @@
   
       /**
        * Returns a list of string elements suitable for return by
  -     * {@link getOtherElements()}.  Override getOtherElements to return
  -     * the results of this method if your collection does not support
  -     * heterogenous elements or the null element.
  +     * {@link #getOtherKeys()} or {@link #getOtherValues}.
  +     *
  +     * <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() {
           return new Object[] {
  @@ -308,7 +310,7 @@
        * method must return an array with the same length as
        * {@link #getSampleKeys()}.  The default implementation constructs a set of
        * 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
        * <code>true</code>.
        */
  @@ -330,7 +332,7 @@
        * returned from this method should not be the same as those returned from
        * {@link #getSampleValues()}.  The default implementation constructs a
        * 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
        * <code>true</code>.  
        */
  @@ -390,7 +392,7 @@
        * Return a new, populated map.  The mappings in the map should match the
        * keys and values returned from {@link #getSampleKeys()} and {@link
        * #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.
        * 
        * @return the map to be tested
  @@ -787,7 +789,7 @@
               resetFull();
               int i = 0;
               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 value = confirmed.put(key, newValues[i]);
                   verify();
  @@ -988,8 +990,11 @@
        * from the map are removed from the values collection--also,
        * but that's a more difficult test to construct (lacking a
        * "removeValue" method.)
  -     * 
  -     * @see http://issues.apache.org/bugzilla/show_bug.cgi?id=9573
  +     * </p>
  +     * <p>
  +     * See bug <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=9573">
  +     * 9573</a>.
  +     * </p>
        */
       public void testValuesRemoveChangesMap() {
           resetFull();
  @@ -1061,11 +1066,11 @@
   
       /**
        * 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
        * 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() {
           return new TestMapEntrySet();
  @@ -1129,11 +1134,11 @@
   
       /**
        * 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
        * 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() {
           return new TestMapKeySet();
  @@ -1192,11 +1197,11 @@
   
       /**
        * 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
        * 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
        */
       public BulkTest bulkTestMapValues() {
  
  
  
  1.2       +3 -0      jakarta-commons/collections/src/test/org/apache/commons/collections/overview.html
  
  Index: overview.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/overview.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- overview.html	5 Oct 2003 23:11:00 -0000	1.1
  +++ overview.html	10 Oct 2003 21:19:39 -0000	1.2
  @@ -1,4 +1,7 @@
   <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>
   
   <p>
  
  
  
  1.2       +9 -9      jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestList.java
  
  Index: AbstractTestList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestList.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- AbstractTestList.java	2 Oct 2003 22:14:29 -0000	1.1
  +++ AbstractTestList.java	10 Oct 2003 21:19:39 -0000	1.2
  @@ -76,7 +76,7 @@
    * Abstract test class for {@link java.util.List} methods and contracts.
    * <p>
    * To use, simply extend this class, and implement
  - * the {@link #makeList} method.
  + * the {@link #makeEmptyList} method.
    * <p>
    * If your {@link List} fails one of these tests by design,
    * you may still use this base set of cases.  Simply override the
  @@ -184,7 +184,7 @@
       }
   
       /**
  -     * Returns {@link makeEmptyList()}.
  +     * Returns {@link #makeEmptyList()}.
        *
        * @return an empty list to be used for testing
        */
  @@ -193,7 +193,7 @@
       }
   
       /**
  -     * Returns {@link makeFullList()}.
  +     * Returns {@link #makeFullList()}.
        *
        * @return a full list to be used for testing
        */
  @@ -203,7 +203,7 @@
   
       //-----------------------------------------------------------------------
       /**
  -     * 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
        */
  @@ -212,7 +212,7 @@
       }
   
       /**
  -     * 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
        */
  @@ -499,7 +499,7 @@
       }
   
       /**
  -     *  Tests {@link List#indexOf()}.
  +     *  Tests {@link List#indexOf}.
        */
       public void testListIndexOf() {
           resetFull();
  @@ -523,7 +523,7 @@
       }
   
       /**
  -     *  Tests {@link List#lastIndexOf()}.
  +     *  Tests {@link List#lastIndexOf}.
        */
       public void testListLastIndexOf() {
           resetFull();
  
  
  
  1.5       +5 -5      jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestCollection.java
  
  Index: AbstractTestCollection.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestCollection.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- AbstractTestCollection.java	10 Oct 2003 21:07:48 -0000	1.4
  +++ AbstractTestCollection.java	10 Oct 2003 21:19:39 -0000	1.5
  @@ -122,7 +122,7 @@
    * {@link #confirmed}, the {@link #verify()} method is invoked to compare
    * the results.  You may want to override {@link #verify()} to perform
    * 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.
    * <p>
    * If you're extending this class directly, you will have to provide 
  @@ -135,8 +135,8 @@
    * Those methods should provide a confirmed collection implementation 
    * that's compatible with your collection implementation.
    * <p>
  - * If you're extending {@link TestList}, {@link TestSet},
  - * or {@link TestBag}, you probably don't have to worry about the
  + * If you're extending {@link AbstractTestList}, {@link AbstractTestSet},
  + * or {@link AbstractTestBag}, you probably don't have to worry about the
    * above methods, because those three classes already override the methods
    * to provide standard JDK confirmed collections.<P>
    * <p>
  
  
  
  1.3       +3 -3      jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestSet.java
  
  Index: AbstractTestSet.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestSet.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- AbstractTestSet.java	5 Oct 2003 23:10:31 -0000	1.2
  +++ AbstractTestSet.java	10 Oct 2003 21:19:39 -0000	1.3
  @@ -68,7 +68,7 @@
    * <p>
    * Since {@link Set} doesn't stipulate much new behavior that isn't already
    * 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
    * set.
    * <p>
  
  
  
  1.3       +5 -5      jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestSortedSet.java
  
  Index: AbstractTestSortedSet.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/test/org/apache/commons/collections/AbstractTestSortedSet.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- AbstractTestSortedSet.java	5 Oct 2003 23:10:31 -0000	1.2
  +++ AbstractTestSortedSet.java	10 Oct 2003 21:19:39 -0000	1.3
  @@ -159,7 +159,7 @@
       //-----------------------------------------------------------------------
       /**
        * 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
        * that the set and the other collection views are still valid.
        *
  @@ -176,7 +176,7 @@
   
       /**
        * 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
        * that the set and the other collection views are still valid.
        *
  @@ -193,7 +193,7 @@
   
       /**
        * 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
        * that the set and the other collection views are still valid.
        *
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message