You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2012/03/10 15:28:38 UTC
svn commit: r1299209 - in /commons/proper/collections/trunk/src:
main/java/org/apache/commons/collections/
main/java/org/apache/commons/collections/functors/
main/java/org/apache/commons/collections/map/
test/java/org/apache/commons/collections/collect...
Author: sebb
Date: Sat Mar 10 14:28:37 2012
New Revision: 1299209
URL: http://svn.apache.org/viewvc?rev=1299209&view=rev
Log:
Javadoc fixes
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ComparatorUtils.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Get.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableGet.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableSortedMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/MapUtils.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Put.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/Equator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/DefaultedMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java
commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java
commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java
commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ComparatorUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ComparatorUtils.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ComparatorUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ComparatorUtils.java Sat Mar 10 14:28:37 2012
@@ -52,7 +52,7 @@ public class ComparatorUtils {
/**
* Comparator for natural sort order.
*
- * @see ComparableComparator#getInstance
+ * @see ComparableComparator#comparableComparator()
*/
@SuppressWarnings("unchecked")
public static final Comparator NATURAL_COMPARATOR = ComparableComparator.<Comparable>comparableComparator();
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/ExtendedProperties.java Sat Mar 10 14:28:37 2012
@@ -44,7 +44,7 @@ import java.util.Vector;
* instead of overwriting them.
* <p>
* <b>Please consider using the
- * {@link org.apache.commons.configuration.PropertiesConfiguration} class in
+ * {@code org.apache.commons.configuration.PropertiesConfiguration} class in
* <a href="http://commons.apache.org/configuration">Commons Configuration</a>.
* It's an evolution of <code>ExtendedProperties</code> supporting more
* features like automatic reloading, advanced interpolation, more type
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Get.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Get.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Get.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Get.java Sat Mar 10 14:28:37 2012
@@ -23,7 +23,7 @@ import java.util.Set;
/**
* The "read" subset of the {@link Map} interface.
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
* @see Put
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableGet.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableGet.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableGet.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableGet.java Sat Mar 10 14:28:37 2012
@@ -21,7 +21,7 @@ import java.util.Map;
/**
* The "read" subset of the {@link Map} interface.
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
* @see Put
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableSortedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableSortedMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableSortedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/IterableSortedMap.java Sat Mar 10 14:28:37 2012
@@ -24,7 +24,7 @@ import java.util.SortedMap;
* @param <K> the type of the keys in the map
* @param <V> the type of the values in the map
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
*
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/MapUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/MapUtils.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/MapUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/MapUtils.java Sat Mar 10 14:28:37 2012
@@ -1649,7 +1649,7 @@ public class MapUtils {
* @param map to wrap if necessary.
* @return IterableMap<K, V>
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
*/
public static <K, V> IterableMap<K, V> iterableMap(Map<K, V> map) {
if (map == null) {
@@ -1667,7 +1667,7 @@ public class MapUtils {
* @param sortedMap to wrap if necessary
* @return {@link IterableSortedMap}<K, V>
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
*/
public static <K, V> IterableSortedMap<K, V> iterableSortedMap(SortedMap<K, V> sortedMap) {
if (sortedMap == null) {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Put.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Put.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Put.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/Put.java Sat Mar 10 14:28:37 2012
@@ -21,7 +21,7 @@ import java.util.Map;
/**
* The "write" subset of the {@link Map} interface.
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
* @see Get
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/CatchAndRethrowClosure.java Sat Mar 10 14:28:37 2012
@@ -52,7 +52,7 @@ public abstract class CatchAndRethrowClo
* Execute this closure on the specified input object.
*
* @param input the input to execute on
- * @throws ClosureException (runtime) if the closure execution resulted in a
+ * @throws FunctorException (runtime) if the closure execution resulted in a
* checked exception.
*/
public void execute(E input) {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/Equator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/Equator.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/Equator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/functors/Equator.java Sat Mar 10 14:28:37 2012
@@ -38,8 +38,8 @@ public interface Equator<T> {
/**
* Calculates the hash for the object, based on the method of equality used in the equate
- * method. This is used for classes that delegate their {@link #equals(Object)} method to an
- * Equator (and so must also delegate their {@link #hashCode()} method), or for implementations
+ * method. This is used for classes that delegate their {@link Object#equals(Object) equals(Object)} method to an
+ * Equator (and so must also delegate their {@link Object#hashCode() hashCode()} method), or for implementations
* of {@link HashedMap} that use an Equator for the key objects.
*
* @param o the object to calculate the hash for.
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractIterableMap.java Sat Mar 10 14:28:37 2012
@@ -22,7 +22,7 @@ import org.apache.commons.collections.Ma
/**
* Provide a basic {@link IterableMap} implementation.
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
*
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractLinkedMap.java Sat Mar 10 14:28:37 2012
@@ -258,7 +258,7 @@ public abstract class AbstractLinkedMap<
* This implementation adds the entry to the data storage table and
* to the end of the linked list.
*
- * @param link the entry to add
+ * @param entry the entry to add
* @param hashIndex the index into the data array to store at
*/
@Override
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/AbstractReferenceMap.java Sat Mar 10 14:28:37 2012
@@ -152,9 +152,13 @@ public abstract class AbstractReferenceM
* 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 ReferenceStrength#HARD HARD},
+ * {@link ReferenceStrength#SOFT SOFT},
+ * {@link ReferenceStrength#WEAK WEAK}
* @param valueType the type of reference to use for values;
- * must be {@link #HARD}, {@link #SOFT}, {@link #WEAK}
+ * must be {@link ReferenceStrength#HARD},
+ * {@link ReferenceStrength#SOFT SOFT},
+ * {@link 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/main/java/org/apache/commons/collections/map/DefaultedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/DefaultedMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/DefaultedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/DefaultedMap.java Sat Mar 10 14:28:37 2012
@@ -149,8 +149,9 @@ public class DefaultedMap<K, V> extends
* Constructor that wraps (not copies).
*
* @param map the map to decorate, must not be null
- * @param value the value to use
+ * @param defaultValueTransformer the value transformer to use
* @throws IllegalArgumentException if map or transformer is null
+ * TODO does not check for null transformer: fix code or Javadoc
*/
protected DefaultedMap(Map<K, V> map, Transformer<? super K, ? extends V> defaultValueTransformer) {
super(map);
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java Sat Mar 10 14:28:37 2012
@@ -27,7 +27,7 @@ import org.apache.commons.collections.Re
* Adapts a Map entrySet to the MapIterator interface.
*
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
*
* @author Matt Benson
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/map/ListOrderedMap.java Sat Mar 10 14:28:37 2012
@@ -62,7 +62,7 @@ import org.apache.commons.collections.li
* {@link CaseInsensitiveMap}, or similar maps that violate the general
* contract of {@link java.util.Map}.</strong> The <code>ListOrderedMap</code>
* (or, more precisely, the underlying <code>List</code>) is relying on
- * {@link Object#java.lang.equals(Object) equals()}. This is fine, as long as the
+ * {@link Object#equals(Object) equals()}. This is fine, as long as the
* decorated <code>Map</code> is also based on {@link Object#equals(Object) equals()},
* and {@link Object#hashCode() hashCode()}, which {@link IdentityMap}, and
* {@link CaseInsensitiveMap} don't: The former uses <code>==</code>, and
Modified: commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java (original)
+++ commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/collection/AbstractTestCollection.java Sat Mar 10 14:28:37 2012
@@ -41,8 +41,9 @@ import org.apache.commons.collections.Ab
* <p>
* You should create a concrete subclass of this class to test any custom
* {@link Collection} implementation. At minimum, you'll have to
- * implement the {@link #makeCollection()} method. You might want to
- * override some of the additional public methods as well:
+ * implement the @{@link #makeObject()}, {@link #makeConfirmedCollection()}
+ * and {@link #makeConfirmedFullCollection()} methods.
+ * You might want to override some of the additional public methods as well:
* <p>
* <b>Element Population Methods</b>
* <p>
Modified: commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java (original)
+++ commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/iterators/TestFilterListIterator.java Sat Mar 10 14:28:37 2012
@@ -284,7 +284,7 @@ public class TestFilterListIterator exte
}
/**
- * Test for {@link https://issues.apache.org/jira/browse/COLLECTIONS-360 COLLECTIONS-360}.
+ * Test for {@link "https://issues.apache.org/jira/browse/COLLECTIONS-360 COLLECTIONS-360"}
*/
public void testCollections360() throws Throwable {
Collection<Predicate<Object>> var7 = new GrowthList<Predicate<Object>>();
Modified: commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java (original)
+++ commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestSplitMapUtils.java Sat Mar 10 14:28:37 2012
@@ -32,7 +32,7 @@ import org.apache.commons.collections.ma
* Tests for {@link TransformedMap}
*
* @since Commons Collections 5
- * @TODO fix version
+ * TODO fix version
* @version $Revision$ $Date$
*
* @author Stephen Colebourne
Modified: commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java?rev=1299209&r1=1299208&r2=1299209&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java (original)
+++ commons/proper/collections/trunk/src/test/java/org/apache/commons/collections/splitmap/TestTransformedMap.java Sat Mar 10 14:28:37 2012
@@ -29,7 +29,7 @@ import org.apache.commons.collections.fu
* Tests for {@link TransformedMap}
*
* @since Commons Collections 5
- * @TODO fix version, add Serialization tests
+ * TODO fix version, add Serialization tests
* @version $Revision$ $Date$
*
* @author Stephen Colebourne