From 21a690adc64a59343cd2b7c63ae9e86fd0ffb4a3 Mon Sep 17 00:00:00 2001 From: Phil Steitz Date: Fri, 5 Sep 2003 03:35:07 +0000 Subject: [PATCH] javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131134 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/collections/ComparatorUtils.java | 2 +- .../decorators/AbstractMapEntryDecorator.java | 8 ++++---- .../collections/decorators/PredicatedMap.java | 18 +++++++++--------- .../decorators/PredicatedSortedMap.java | 18 +++++++++--------- .../decorators/SynchronizedCollection.java | 8 ++++---- .../decorators/TransformedSortedMap.java | 16 ++++++++-------- .../UnmodifiableBoundedCollection.java | 14 +++++++------- 7 files changed, 42 insertions(+), 42 deletions(-) diff --git a/src/java/org/apache/commons/collections/ComparatorUtils.java b/src/java/org/apache/commons/collections/ComparatorUtils.java index 32e999fdf..9bcdd89dc 100644 --- a/src/java/org/apache/commons/collections/ComparatorUtils.java +++ b/src/java/org/apache/commons/collections/ComparatorUtils.java @@ -131,7 +131,7 @@ public class ComparatorUtils { * The second comparator is used if the first comparator returns * that equal and so on. * - * @param iterators the comparators to use, not null or empty or contain nulls + * @param comparators the comparators to use, not null or empty or contain nulls * @return a combination comparator over the comparators * @throws NullPointerException if comparators array is null or contains a null */ diff --git a/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java b/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java index 67597d806..a5c01d09a 100644 --- a/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java +++ b/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractMapEntryDecorator.java,v 1.2 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/AbstractMapEntryDecorator.java,v 1.3 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -63,12 +63,12 @@ import java.util.Map; *

This Map.Entry wraps another Map.Entry * implementation, using the wrapped instance for its default * implementation. This class is used as a framework on which to - * build to extensions for its wrapped Map object which + * build extensions for its wrapped Map object which * would be unavailable or inconvenient via sub-classing (but usable * via composition).

* * @since Commons Collections 3.0 - * @version $Revision: 1.2 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.3 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne */ @@ -80,7 +80,7 @@ public abstract class AbstractMapEntryDecorator implements Map.Entry { /** * Constructor that wraps (not copies). * - * @param map the map to decorate, must not be null + * @param entry the Map.Entry to decorate, must not be null * @throws IllegalArgumentException if the collection is null */ public AbstractMapEntryDecorator(Map.Entry entry) { diff --git a/src/java/org/apache/commons/collections/decorators/PredicatedMap.java b/src/java/org/apache/commons/collections/decorators/PredicatedMap.java index f3380b8ca..996c3c310 100644 --- a/src/java/org/apache/commons/collections/decorators/PredicatedMap.java +++ b/src/java/org/apache/commons/collections/decorators/PredicatedMap.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/PredicatedMap.java,v 1.4 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/PredicatedMap.java,v 1.5 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -66,13 +66,13 @@ import org.apache.commons.collections.Predicate; /** * PredicatedMap decorates another Map - * to validate additions match a specified predicate. + * to validate that additions match a specified predicate. *

* If an object cannot be added to the map, an IllegalArgumentException - * is thrown. + * is thrown.

* * @since Commons Collections 3.0 - * @version $Revision: 1.4 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.5 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne * @author Paul Jack @@ -88,11 +88,11 @@ public class PredicatedMap extends AbstractMapDecorator { * Factory method to create a predicated (validating) map. *

* If there are any elements already in the list being decorated, they - * are validated. + * are validated.

* * @param map the map to decorate, must not be null - * @param keyPredicate, the predicate to validate the keys, null means no check - * @param valuePredicate, the predicate to validate to values, null means no check + * @param keyPredicate the predicate to validate the keys, null means no check + * @param valuePredicate the predicate to validate to values, null means no check * @throws IllegalArgumentException if the map is null */ public static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate) { @@ -103,8 +103,8 @@ public class PredicatedMap extends AbstractMapDecorator { * Constructor that wraps (not copies). * * @param map the map to decorate, must not be null - * @param keyPredicate, the predicate to validate the keys, null means no check - * @param valuePredicate, the predicate to validate to values, null means no check + * @param keyPredicate the predicate to validate the keys, null means no check + * @param valuePredicate the predicate to validate to values, null means no check * @throws IllegalArgumentException if the map is null */ protected PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate) { diff --git a/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java b/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java index cb5910ea1..49531d2a5 100644 --- a/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java +++ b/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/PredicatedSortedMap.java,v 1.3 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/PredicatedSortedMap.java,v 1.4 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -64,13 +64,13 @@ import org.apache.commons.collections.Predicate; /** * PredicatedSortedMap decorates another SortedMap - * to validate additions match a specified predicate. + * to validate that additions match a specified predicate. *

* If an object cannot be added to the map, an IllegalArgumentException - * is thrown. + * is thrown.

* * @since Commons Collections 3.0 - * @version $Revision: 1.3 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.4 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne * @author Paul Jack @@ -81,11 +81,11 @@ public class PredicatedSortedMap extends PredicatedMap implements SortedMap { * Factory method to create a predicated (validating) sorted map. *

* If there are any elements already in the list being decorated, they - * are validated. + * are validated.

* * @param map the map to decorate, must not be null - * @param keyPredicate, the predicate to validate the keys, null means no check - * @param valuePredicate, the predicate to validate to values, null means no check + * @param keyPredicate the predicate to validate the keys, null means no check + * @param valuePredicate the predicate to validate to values, null means no check * @throws IllegalArgumentException if the map is null */ public static SortedMap decorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate) { @@ -96,8 +96,8 @@ public class PredicatedSortedMap extends PredicatedMap implements SortedMap { * Constructor that wraps (not copies). * * @param map the map to decorate, must not be null - * @param keyPredicate, the predicate to validate the keys, null means no check - * @param valuePredicate, the predicate to validate to values, null means no check + * @param keyPredicate the predicate to validate the keys, null means no check + * @param valuePredicate the predicate to validate to values, null means no check * @throws IllegalArgumentException if the map is null */ protected PredicatedSortedMap(SortedMap map, Predicate keyPredicate, Predicate valuePredicate) { diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java b/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java index 56ea61ad2..63f6e994f 100644 --- a/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java +++ b/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedCollection.java,v 1.4 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedCollection.java,v 1.5 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -72,7 +72,7 @@ import java.util.Iterator; * } * * @since Commons Collections 3.0 - * @version $Revision: 1.4 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.5 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne */ @@ -96,7 +96,7 @@ public class SynchronizedCollection implements Collection { /** * Constructor that wraps (not copies). * - * @param coll the collection to decorate, must not be null + * @param collection the collection to decorate, must not be null * @throws IllegalArgumentException if the collection is null */ protected SynchronizedCollection(Collection collection) { @@ -110,7 +110,7 @@ public class SynchronizedCollection implements Collection { /** * Constructor that wraps (not copies). * - * @param coll the collection to decorate, must not be null + * @param collection the collection to decorate, must not be null * @param lock the lock object to use, must not be null * @throws IllegalArgumentException if the collection is null */ diff --git a/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java b/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java index 3f6022c6a..505806345 100644 --- a/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java +++ b/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/TransformedSortedMap.java,v 1.2 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/TransformedSortedMap.java,v 1.3 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -72,7 +72,7 @@ import org.apache.commons.collections.Transformer; * use the Integer form to remove objects. * * @since Commons Collections 3.0 - * @version $Revision: 1.2 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.3 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne */ @@ -82,11 +82,11 @@ public class TransformedSortedMap extends TransformedMap implements SortedMap { * Factory method to create a transforming sorted map. *

* If there are any elements already in the map being decorated, they - * are NOT transformed. + * are NOT transformed.

* * @param map the map to decorate, must not be null - * @param keyTransformer, the predicate to validate the keys, null means no transformation - * @param valueTransformer, the predicate to validate to values, null means no transformation + * @param keyTransformer the predicate to validate the keys, null means no transformation + * @param valueTransformer the predicate to validate to values, null means no transformation * @throws IllegalArgumentException if the map is null */ public static SortedMap decorate(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) { @@ -97,11 +97,11 @@ public class TransformedSortedMap extends TransformedMap implements SortedMap { * Constructor that wraps (not copies). *

* If there are any elements already in the collection being decorated, they - * are NOT transformed. + * are NOT transformed.

* * @param map the map to decorate, must not be null - * @param keyTransformer, the predicate to validate the keys, null means no transformation - * @param valueTransformer, the predicate to validate to values, null means no transformation + * @param keyTransformer the predicate to validate the keys, null means no transformation + * @param valueTransformer the predicate to validate to values, null means no transformation * @throws IllegalArgumentException if the map is null */ protected TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) { diff --git a/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java b/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java index f33b8b497..15b4e5b10 100644 --- a/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java +++ b/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableBoundedCollection.java,v 1.2 2003/08/31 17:24:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableBoundedCollection.java,v 1.3 2003/09/05 03:35:07 psteitz Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -71,7 +71,7 @@ import org.apache.commons.collections.BoundedCollection; * examining the package scope variables. * * @since Commons Collections 3.0 - * @version $Revision: 1.2 $ $Date: 2003/08/31 17:24:46 $ + * @version $Revision: 1.3 $ $Date: 2003/09/05 03:35:07 $ * * @author Stephen Colebourne */ @@ -80,7 +80,7 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem /** * Factory method to create an unmodifiable bounded collection. * - * @param bag the bag to decorate, must not be null + * @param coll the BoundedCollection to decorate, must not be null * @throws IllegalArgumentException if bag is null */ public static BoundedCollection decorate(BoundedCollection coll) { @@ -90,10 +90,10 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem /** * Factory method to create an unmodifiable bounded collection. *

- * This method is capable of drilling down through other decorators to find - * a suitable BoundedCollection + * This method is capable of drilling down through up to 1000 other decorators + * to find a suitable BoundedCollection.

* - * @param bag the bag to decorate, must not be null + * @param coll the BoundedCollection to decorate, must not be null * @throws IllegalArgumentException if bag is null */ public static BoundedCollection decorateUsing(Collection coll) { @@ -124,7 +124,7 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem * Constructor that wraps (not copies). * * @param coll the collection to decorate, must not be null - * @throws IllegalArgumentException if bag is null + * @throws IllegalArgumentException if coll is null */ protected UnmodifiableBoundedCollection(BoundedCollection coll) { super(coll);