commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1023771 - in /commons/proper/collections/trunk/src: java/org/apache/commons/collections/functors/ java/org/apache/commons/collections/map/ test/org/apache/commons/collections/ test/org/apache/commons/collections/bag/ test/org/apache/common...
Date Mon, 18 Oct 2010 12:43:21 GMT
Author: sebb
Date: Mon Oct 18 12:43:21 2010
New Revision: 1023771

URL: http://svn.apache.org/viewvc?rev=1023771&view=rev
Log:
Javadoc

Modified:
    commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/AllPredicate.java
    commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/ComparatorPredicate.java
    commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
    commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceMap.java
    commons/proper/collections/trunk/src/test/org/apache/commons/collections/AbstractTestLinkedList.java
    commons/proper/collections/trunk/src/test/org/apache/commons/collections/bag/AbstractTestBag.java
    commons/proper/collections/trunk/src/test/org/apache/commons/collections/list/AbstractTestList.java
    commons/proper/collections/trunk/src/test/org/apache/commons/collections/map/AbstractTestMap.java

Modified: commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/AllPredicate.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/AllPredicate.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/AllPredicate.java
(original)
+++ commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/AllPredicate.java
Mon Oct 18 12:43:21 2010
@@ -58,7 +58,7 @@ public final class AllPredicate<T> imple
      * @return the <code>all</code> predicate
      * @throws IllegalArgumentException if the predicates array is null
      * @throws IllegalArgumentException if any predicate in the array is null
-     * @deprecated Use {@link #allPredicate(Predicate<? super T>...)} instead
+     * @deprecated Use {@link #allPredicate(Predicate...)} instead
      */
     @Deprecated
     public static <T> Predicate<T> getInstance(Predicate<? super T> ...
predicates) {
@@ -98,7 +98,7 @@ public final class AllPredicate<T> imple
      * @return the <code>all</code> predicate
      * @throws IllegalArgumentException if the predicates array is null
      * @throws IllegalArgumentException if any predicate in the array is null
-     * @deprecated Use {@link #allPredicate(Collection<Predicate<? super T>>)}
instead
+     * @deprecated Use {@link #allPredicate(Collection)} instead
      */
     @Deprecated
     public static <T> Predicate<T> getInstance(Collection<Predicate<T>>
predicates) {

Modified: commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/ComparatorPredicate.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/ComparatorPredicate.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/ComparatorPredicate.java
(original)
+++ commons/proper/collections/trunk/src/java/org/apache/commons/collections/functors/ComparatorPredicate.java
Mon Oct 18 12:43:21 2010
@@ -116,7 +116,7 @@ public class ComparatorPredicate<T> impl
 	 * @param comparator  the comparator to use for comparison
 	 * @param criterion  the criterion to use to evaluate comparison
 	 * @return the predicate
-	 * @throws IllegalArgumentexception if comparator is null of criterion is invalid
+	 * @throws IllegalArgumentException if comparator is null of criterion is invalid
 	 */
 	public static <T> Predicate<T> getInstance(T object, Comparator<T> comparator,
Criterion criterion) {
         if (comparator == null) {
@@ -155,7 +155,7 @@ public class ComparatorPredicate<T> impl
 	 * </ul>
 	 * 
 	 * @see org.apache.commons.collections.Predicate#evaluate(java.lang.Object)
-	 * @see java.util.Comparator.compare(java.lang.Object first, java.lang.Object second)
+	 * @see java.util.Comparator#compare(java.lang.Object first, java.lang.Object second)
 	 * 
 	 * @throws IllegalStateException if the criterion is invalid (really not possible)
 	 */

Modified: commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
(original)
+++ commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
Mon Oct 18 12:43:21 2010
@@ -89,9 +89,13 @@ public class ReferenceIdentityMap<K, V> 
      * use the specified types of references.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      */
     public ReferenceIdentityMap(ReferenceStrength keyType, ReferenceStrength valueType) {
         super(keyType, valueType, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR, false);
@@ -102,9 +106,13 @@ public class ReferenceIdentityMap<K, V> 
      * use the specified types of references.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param purgeValues should the value be automatically purged when the 
      *   key is garbage collected 
      */
@@ -118,9 +126,13 @@ public class ReferenceIdentityMap<K, V> 
      * specified reference types, load factor and initial capacity.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param capacity  the initial capacity for the map
      * @param loadFactor  the load factor for the map
      */
@@ -134,9 +146,13 @@ public class ReferenceIdentityMap<K, V> 
      * specified reference types, load factor and initial capacity.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param capacity  the initial capacity for the map
      * @param loadFactor  the load factor for the map
      * @param purgeValues  should the value be automatically purged when the 

Modified: commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceMap.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceMap.java
(original)
+++ commons/proper/collections/trunk/src/java/org/apache/commons/collections/map/ReferenceMap.java
Mon Oct 18 12:43:21 2010
@@ -92,9 +92,13 @@ public class ReferenceMap<K, V> extends 
      * use the specified types of references.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      */
     public ReferenceMap(ReferenceStrength keyType, ReferenceStrength valueType) {
         super(keyType, valueType, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR, false);
@@ -105,9 +109,13 @@ public class ReferenceMap<K, V> extends 
      * use the specified types of references.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param purgeValues should the value be automatically purged when the 
      *   key is garbage collected 
      */
@@ -121,9 +129,13 @@ public class ReferenceMap<K, V> extends 
      * capacity.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param capacity  the initial capacity for the map
      * @param loadFactor  the load factor for the map
      */
@@ -138,9 +150,13 @@ public class ReferenceMap<K, V> extends 
      * capacity.
      *
      * @param keyType  the type of reference to use for keys;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT}, 
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param valueType  the type of reference to use for values;
-     *   must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+     *   must be {@link AbstractReferenceMap.ReferenceStrength#HARD HARD},
+     *   {@link AbstractReferenceMap.ReferenceStrength#SOFT SOFT},
+     *   {@link AbstractReferenceMap.ReferenceStrength#WEAK WEAK}
      * @param capacity  the initial capacity for the map
      * @param loadFactor  the load factor for the map
      * @param purgeValues  should the value be automatically purged when the 

Modified: commons/proper/collections/trunk/src/test/org/apache/commons/collections/AbstractTestLinkedList.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/org/apache/commons/collections/AbstractTestLinkedList.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/org/apache/commons/collections/AbstractTestLinkedList.java
(original)
+++ commons/proper/collections/trunk/src/test/org/apache/commons/collections/AbstractTestLinkedList.java
Mon Oct 18 12:43:21 2010
@@ -28,7 +28,7 @@ import org.apache.commons.collections.li
  * Tests base {@link java.util.LinkedList} methods and contracts.
  * <p>
  * To use, simply extend this class, and implement
- * the {@link #makeEmptyLinkedList()} method.
+ * the {@link #makeObject()} method.
  * <p>
  * If your {@link LinkedList} fails one of these tests by design,
  * you may still use this base set of cases.  Simply override the

Modified: commons/proper/collections/trunk/src/test/org/apache/commons/collections/bag/AbstractTestBag.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/org/apache/commons/collections/bag/AbstractTestBag.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/org/apache/commons/collections/bag/AbstractTestBag.java
(original)
+++ commons/proper/collections/trunk/src/test/org/apache/commons/collections/bag/AbstractTestBag.java
Mon Oct 18 12:43:21 2010
@@ -31,7 +31,7 @@ import org.apache.commons.collections.Ba
  * Abstract test class for {@link org.apache.commons.collections.Bag Bag} methods and contracts.
  * <p>
  * To use, simply extend this class, and implement
- * the {@link #makeBag} method.
+ * the {@link #makeObject} method.
  * <p>
  * If your bag fails one of these tests by design,
  * you may still use this base set of cases.  Simply override the

Modified: commons/proper/collections/trunk/src/test/org/apache/commons/collections/list/AbstractTestList.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/org/apache/commons/collections/list/AbstractTestList.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/org/apache/commons/collections/list/AbstractTestList.java
(original)
+++ commons/proper/collections/trunk/src/test/org/apache/commons/collections/list/AbstractTestList.java
Mon Oct 18 12:43:21 2010
@@ -39,7 +39,7 @@ import org.apache.commons.collections.it
  * Abstract test class for {@link java.util.List} methods and contracts.
  * <p>
  * To use, simply extend this class, and implement
- * the {@link #makeEmptyList} method.
+ * the {@link #makeObject} 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
@@ -67,7 +67,7 @@ public abstract class AbstractTestList<E
     //-----------------------------------------------------------------------
     /**
      *  Returns true if the collections produced by
-     *  {@link #makeCollection()} and {@link #makeFullCollection()}
+     *  {@link #makeObject()} and {@link #makeFullCollection()}
      *  support the <code>set operation.<p>
      *  Default implementation returns true.  Override if your collection
      *  class does not support set.
@@ -140,7 +140,7 @@ public abstract class AbstractTestList<E
     }
 
     /**
-     * Returns {@link #makeEmptyList()}.
+     * Returns {@link #makeObject()}.
      *
      * @return an empty list to be used for testing
      */

Modified: commons/proper/collections/trunk/src/test/org/apache/commons/collections/map/AbstractTestMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/org/apache/commons/collections/map/AbstractTestMap.java?rev=1023771&r1=1023770&r2=1023771&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/org/apache/commons/collections/map/AbstractTestMap.java
(original)
+++ commons/proper/collections/trunk/src/test/org/apache/commons/collections/map/AbstractTestMap.java
Mon Oct 18 12:43:21 2010
@@ -37,7 +37,7 @@ import org.apache.commons.collections.se
  * 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.
+ * {@link #makeObject()} 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
@@ -166,7 +166,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * support the <code>put</code> and <code>putAll</code> operations
      * adding new mappings.
      * <p>
@@ -179,7 +179,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * support the <code>put</code> and <code>putAll</code> operations
      * changing existing mappings.
      * <p>
@@ -192,7 +192,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * support the <code>setValue</code> operation on entrySet entries.
      * <p>
      * Default implementation returns isPutChangeSupported().
@@ -205,7 +205,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * support the <code>remove</code> and <code>clear</code> operations.
      * <p>
      * Default implementation returns true.
@@ -217,7 +217,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * can cause structural modification on a get(). The example is LRUMap.
      * <p>
      * Default implementation returns false.
@@ -240,7 +240,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * supports null keys.
      * <p>
      * Default implementation returns true.
@@ -252,7 +252,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * supports null values.
      * <p>
      * Default implementation returns true.
@@ -264,7 +264,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * supports duplicate values.
      * <p>
      * Default implementation returns true.
@@ -276,7 +276,7 @@ public abstract class AbstractTestMap<K,
 
     /**
      * Returns true if the maps produced by
-     * {@link #makeEmptyMap()} and {@link #makeFullMap()}
+     * {@link #makeObject()} and {@link #makeFullMap()}
      * provide fail-fast behavior on their various iterators.
      * <p>
      * Default implementation returns true.



Mime
View raw message