null Boolean objects
- * according to the value of {@link #trueFirst}.
+ * according to the value of {@link #sortsTrueFirst()}.
*
* @param b1 the first boolean to compare
* @param b2 the second boolean to compare
@@ -176,7 +176,7 @@ public final class BooleanComparator implements Comparator, Serializable {
*
* This implementation returns true
* iff that is a {@link BooleanComparator}
- * whose {@link #trueFirst} value is equal to mine.
+ * whose value of {@link #sortsTrueFirst()} is equal to mine.
*
* @param object the object to compare to
* @return true if equal
diff --git a/src/java/org/apache/commons/collections/map/LRUMap.java b/src/java/org/apache/commons/collections/map/LRUMap.java
index c72ec020a..2a15fdda9 100644
--- a/src/java/org/apache/commons/collections/map/LRUMap.java
+++ b/src/java/org/apache/commons/collections/map/LRUMap.java
@@ -41,7 +41,7 @@ import org.apache.commons.collections.BoundedMap;
* ResettableIterator and calling reset().
*
* @since Commons Collections 3.0 (previously in main package v1.0)
- * @version $Revision: 1.14 $ $Date: 2004/06/07 22:13:53 $
+ * @version $Revision: 1.15 $ $Date: 2004/10/16 21:26:14 $
*
* @author James Strachan
* @author Morgan Delagrange
@@ -198,7 +198,7 @@ public class LRUMap
* Updates an existing key-value mapping.
*
* This implementation moves the updated entry to the top of the list - * using {@link #moveToMRU(LinkEntry)}. + * using {@link #moveToMRU(AbstractLinkedMap.LinkEntry)}. * * @param entry the entry to update * @param newValue the new value to store @@ -212,7 +212,7 @@ public class LRUMap * Adds a new key-value mapping into this map. *
* This implementation checks the LRU size and determines whether to - * discard an entry or not using {@link #removeLRU(LinkEntry)}. + * discard an entry or not using {@link #removeLRU(AbstractLinkedMap.LinkEntry)}. *
* From Commons Collections 3.1 this method uses {@link #isFull()} rather
* than accessing size and maxSize directly.
diff --git a/src/java/org/apache/commons/collections/map/MultiKeyMap.java b/src/java/org/apache/commons/collections/map/MultiKeyMap.java
index 37695bcaf..9ce6cc6e4 100644
--- a/src/java/org/apache/commons/collections/map/MultiKeyMap.java
+++ b/src/java/org/apache/commons/collections/map/MultiKeyMap.java
@@ -67,7 +67,7 @@ import org.apache.commons.collections.keyvalue.MultiKey;
*
*
* @since Commons Collections 3.1
- * @version $Revision: 1.3 $ $Date: 2004/06/07 21:00:58 $
+ * @version $Revision: 1.4 $ $Date: 2004/10/16 21:26:14 $
*
* @author Stephen Colebourne
*/
@@ -829,14 +829,12 @@ public class MultiKeyMap
}
/**
- * Puts all the keys and values into this map.
+ * Copies all of the keys and values from the specified map to this map.
* Each key must be non-null and a MultiKey object.
*
- * @param key the non-null MultiKey object
- * @param value the value to store
- * @return the previous value for the key
+ * @param mapToCopy to this map
* @throws NullPointerException if the mapToCopy or any key within is null
- * @throws ClassCastException if any key is not a MultiKey
+ * @throws ClassCastException if any key in mapToCopy is not a MultiKey
*/
public void putAll(Map mapToCopy) {
for (Iterator it = mapToCopy.keySet().iterator(); it.hasNext();) {
diff --git a/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java b/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
index c9bb30d7c..18106d8b9 100644
--- a/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
+++ b/src/java/org/apache/commons/collections/map/ReferenceIdentityMap.java
@@ -45,7 +45,7 @@ import java.lang.ref.Reference;
* This map will violate the detail of various Map and map view contracts.
* As a general rule, don't compare this map to other maps.
*
- * This {@link Map} implementation does not allow null elements.
+ * This {@link java.util.Map Map} implementation does not allow null elements.
* Attempting to add a null key or value to the map will raise a NullPointerException.
*
* This implementation is not synchronized. @@ -59,7 +59,7 @@ import java.lang.ref.Reference; * @see java.lang.ref.Reference * * @since Commons Collections 3.0 (previously in main package v2.1) - * @version $Revision: 1.1 $ $Date: 2004/04/27 21:37:32 $ + * @version $Revision: 1.2 $ $Date: 2004/10/16 21:26:14 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/map/ReferenceMap.java b/src/java/org/apache/commons/collections/map/ReferenceMap.java index e4b66ccd6..a05772836 100644 --- a/src/java/org/apache/commons/collections/map/ReferenceMap.java +++ b/src/java/org/apache/commons/collections/map/ReferenceMap.java @@ -29,7 +29,7 @@ import java.io.Serializable; * If non-hard references are used, then the garbage collector can remove * mappings if a key or value becomes unreachable, or if the JVM's memory is * running low. For information on how the different reference types behave, - * see {@link Reference}. + * see {@link java.lang.ref.Reference Reference}. *
* Different types of references can be specified for keys and values.
* The keys can be configured to be weak but the values hard,
@@ -43,7 +43,7 @@ import java.io.Serializable;
* {@link org.apache.commons.collections.map.ReferenceIdentityMap ReferenceIdentityMap}.
* It differs in that keys and values in this class are compared using equals().
*
- * This {@link Map} implementation does not allow null elements.
+ * This {@link java.util.Map Map} implementation does not allow null elements.
* Attempting to add a null key or value to the map will raise a NullPointerException.
*
* This implementation is not synchronized.
@@ -61,7 +61,7 @@ import java.io.Serializable;
* @see java.lang.ref.Reference
*
* @since Commons Collections 3.0 (previously in main package v2.1)
- * @version $Revision: 1.13 $ $Date: 2004/04/27 21:35:23 $
+ * @version $Revision: 1.14 $ $Date: 2004/10/16 21:26:14 $
*
* @author Paul Jack
* @author Stephen Colebourne
diff --git a/src/java/org/apache/commons/collections/map/SingletonMap.java b/src/java/org/apache/commons/collections/map/SingletonMap.java
index ad89301aa..02e03020f 100644
--- a/src/java/org/apache/commons/collections/map/SingletonMap.java
+++ b/src/java/org/apache/commons/collections/map/SingletonMap.java
@@ -54,7 +54,7 @@ import org.apache.commons.collections.keyvalue.TiedMapEntry;
*
*
* @since Commons Collections 3.1
- * @version $Revision: 1.1 $ $Date: 2004/04/09 14:46:35 $
+ * @version $Revision: 1.2 $ $Date: 2004/10/16 21:26:14 $
*
* @author Stephen Colebourne
*/
@@ -103,12 +103,12 @@ public class SingletonMap
/**
* Constructor specifying the key and value as a MapEntry.
*
- * @param keyValue the key value pair to use
+ * @param mapEntry the mapEntry to use
*/
- public SingletonMap(Map.Entry entry) {
+ public SingletonMap(Map.Entry mapEntry) {
super();
- this.key = entry.getKey();
- this.value = entry.getValue();
+ this.key = mapEntry.getKey();
+ this.value = mapEntry.getValue();
}
/**