Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131134 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Phil Steitz 2003-09-05 03:35:07 +00:00
parent 2c106dd4ea
commit 21a690adc6
7 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/java/org/apache/commons/collections/ComparatorUtils.java
View File

@ -131,7 +131,7 @@ public class ComparatorUtils {
* The second comparator is used if the first comparator returns * The second comparator is used if the first comparator returns
* that equal and so on. * 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 * @return a combination comparator over the comparators
* @throws NullPointerException if comparators array is null or contains a null * @throws NullPointerException if comparators array is null or contains a null
*/ */

8
src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -63,12 +63,12 @@ import java.util.Map;
* <p>This <code>Map.Entry</code> wraps another <code>Map.Entry</code> * <p>This <code>Map.Entry</code> wraps another <code>Map.Entry</code>
* implementation, using the wrapped instance for its default * implementation, using the wrapped instance for its default
* implementation. This class is used as a framework on which to * implementation. This class is used as a framework on which to
* build to extensions for its wrapped <code>Map</code> object which * build extensions for its wrapped <code>Map</code> object which
* would be unavailable or inconvenient via sub-classing (but usable * would be unavailable or inconvenient via sub-classing (but usable
* via composition).</p> * via composition).</p>
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */
@ -80,7 +80,7 @@ public abstract class AbstractMapEntryDecorator implements Map.Entry {
/** /**
* Constructor that wraps (not copies). * Constructor that wraps (not copies).
* *
* @param map the map to decorate, must not be null * @param entry the <code>Map.Entry</code> to decorate, must not be null
* @throws IllegalArgumentException if the collection is null * @throws IllegalArgumentException if the collection is null
*/ */
public AbstractMapEntryDecorator(Map.Entry entry) { public AbstractMapEntryDecorator(Map.Entry entry) {

18
src/java/org/apache/commons/collections/decorators/PredicatedMap.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -66,13 +66,13 @@ import org.apache.commons.collections.Predicate;
/** /**
* <code>PredicatedMap</code> decorates another <code>Map</code> * <code>PredicatedMap</code> decorates another <code>Map</code>
* to validate additions match a specified predicate. * to validate that additions match a specified predicate.
* <p> * <p>
* If an object cannot be added to the map, an IllegalArgumentException * If an object cannot be added to the map, an IllegalArgumentException
* is thrown. * is thrown.</p>
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
* @author Paul Jack * @author Paul Jack
@ -88,11 +88,11 @@ public class PredicatedMap extends AbstractMapDecorator {
* Factory method to create a predicated (validating) map. * Factory method to create a predicated (validating) map.
* <p> * <p>
* If there are any elements already in the list being decorated, they * If there are any elements already in the list being decorated, they
* are validated. * are validated.</p>
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyPredicate, the predicate to validate the keys, 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 * @param valuePredicate the predicate to validate to values, null means no check
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
public static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate) { public static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate) {
@ -103,8 +103,8 @@ public class PredicatedMap extends AbstractMapDecorator {
* Constructor that wraps (not copies). * Constructor that wraps (not copies).
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyPredicate, the predicate to validate the keys, 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 * @param valuePredicate the predicate to validate to values, null means no check
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
protected PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate) { protected PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate) {

18
src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -64,13 +64,13 @@ import org.apache.commons.collections.Predicate;
/** /**
* <code>PredicatedSortedMap</code> decorates another <code>SortedMap </code> * <code>PredicatedSortedMap</code> decorates another <code>SortedMap </code>
* to validate additions match a specified predicate. * to validate that additions match a specified predicate.
* <p> * <p>
* If an object cannot be added to the map, an IllegalArgumentException * If an object cannot be added to the map, an IllegalArgumentException
* is thrown. * is thrown.</p>
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
* @author Paul Jack * @author Paul Jack
@ -81,11 +81,11 @@ public class PredicatedSortedMap extends PredicatedMap implements SortedMap {
* Factory method to create a predicated (validating) sorted map. * Factory method to create a predicated (validating) sorted map.
* <p> * <p>
* If there are any elements already in the list being decorated, they * If there are any elements already in the list being decorated, they
* are validated. * are validated.</p>
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyPredicate, the predicate to validate the keys, 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 * @param valuePredicate the predicate to validate to values, null means no check
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
public static SortedMap decorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate) { 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). * Constructor that wraps (not copies).
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyPredicate, the predicate to validate the keys, 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 * @param valuePredicate the predicate to validate to values, null means no check
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
protected PredicatedSortedMap(SortedMap map, Predicate keyPredicate, Predicate valuePredicate) { protected PredicatedSortedMap(SortedMap map, Predicate keyPredicate, Predicate valuePredicate) {

8
src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -72,7 +72,7 @@ import java.util.Iterator;
* } * }
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
*/ */
@ -96,7 +96,7 @@ public class SynchronizedCollection implements Collection {
/** /**
* Constructor that wraps (not copies). * 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 * @throws IllegalArgumentException if the collection is null
*/ */
protected SynchronizedCollection(Collection collection) { protected SynchronizedCollection(Collection collection) {
@ -110,7 +110,7 @@ public class SynchronizedCollection implements Collection {
/** /**
* Constructor that wraps (not copies). * 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 * @param lock the lock object to use, must not be null
* @throws IllegalArgumentException if the collection is null * @throws IllegalArgumentException if the collection is null
*/ */

16
src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -72,7 +72,7 @@ import org.apache.commons.collections.Transformer;
* use the Integer form to remove objects. * use the Integer form to remove objects.
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */
@ -82,11 +82,11 @@ public class TransformedSortedMap extends TransformedMap implements SortedMap {
* Factory method to create a transforming sorted map. * Factory method to create a transforming sorted map.
* <p> * <p>
* If there are any elements already in the map being decorated, they * If there are any elements already in the map being decorated, they
* are NOT transformed. * are NOT transformed.</p>
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyTransformer, the predicate to validate the keys, 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 * @param valueTransformer the predicate to validate to values, null means no transformation
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
public static SortedMap decorate(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) { 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). * Constructor that wraps (not copies).
* <p> * <p>
* If there are any elements already in the collection being decorated, they * If there are any elements already in the collection being decorated, they
* are NOT transformed. * are NOT transformed.</p>
* *
* @param map the map to decorate, must not be null * @param map the map to decorate, must not be null
* @param keyTransformer, the predicate to validate the keys, 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 * @param valueTransformer the predicate to validate to values, null means no transformation
* @throws IllegalArgumentException if the map is null * @throws IllegalArgumentException if the map is null
*/ */
protected TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) { protected TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) {

14
src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -71,7 +71,7 @@ import org.apache.commons.collections.BoundedCollection;
* examining the package scope variables. * examining the package scope variables.
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */
@ -80,7 +80,7 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem
/** /**
* Factory method to create an unmodifiable bounded collection. * Factory method to create an unmodifiable bounded collection.
* *
* @param bag the bag to decorate, must not be null * @param coll the <code>BoundedCollection</code> to decorate, must not be null
* @throws IllegalArgumentException if bag is null * @throws IllegalArgumentException if bag is null
*/ */
public static BoundedCollection decorate(BoundedCollection coll) { public static BoundedCollection decorate(BoundedCollection coll) {
@ -90,10 +90,10 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem
/** /**
* Factory method to create an unmodifiable bounded collection. * Factory method to create an unmodifiable bounded collection.
* <p> * <p>
* This method is capable of drilling down through other decorators to find * This method is capable of drilling down through up to 1000 other decorators
* a suitable BoundedCollection * to find a suitable BoundedCollection.</p>
* *
* @param bag the bag to decorate, must not be null * @param coll the <code>BoundedCollection</code> to decorate, must not be null
* @throws IllegalArgumentException if bag is null * @throws IllegalArgumentException if bag is null
*/ */
public static BoundedCollection decorateUsing(Collection coll) { public static BoundedCollection decorateUsing(Collection coll) {
@ -124,7 +124,7 @@ public class UnmodifiableBoundedCollection extends UnmodifiableCollection implem
* Constructor that wraps (not copies). * Constructor that wraps (not copies).
* *
* @param coll the collection to decorate, must not be null * @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) { protected UnmodifiableBoundedCollection(BoundedCollection coll) {
super(coll); super(coll);