psteitz 2003/09/04 20:35:07
Modified: collections/src/java/org/apache/commons/collections
ComparatorUtils.java
collections/src/java/org/apache/commons/collections/decorators
AbstractMapEntryDecorator.java PredicatedMap.java
PredicatedSortedMap.java
SynchronizedCollection.java
TransformedSortedMap.java
UnmodifiableBoundedCollection.java
Log:
javadoc fixes
Revision Changes Path
1.9 +1 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/ComparatorUtils.java
Index: ComparatorUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/ComparatorUtils.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ComparatorUtils.java 31 Aug 2003 17:26:44 -0000 1.8
+++ ComparatorUtils.java 5 Sep 2003 03:35:06 -0000 1.9
@@ -131,7 +131,7 @@
* 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
*/
1.3 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java
Index: AbstractMapEntryDecorator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/AbstractMapEntryDecorator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractMapEntryDecorator.java 31 Aug 2003 17:24:46 -0000 1.2
+++ AbstractMapEntryDecorator.java 5 Sep 2003 03:35:07 -0000 1.3
@@ -63,7 +63,7 @@
* <p>This <code>Map.Entry</code> wraps another <code>Map.Entry</code>
* 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 <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
* via composition).</p>
*
@@ -80,7 +80,7 @@
/**
* 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
*/
public AbstractMapEntryDecorator(Map.Entry entry) {
1.5 +9 -9
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/PredicatedMap.java
Index: PredicatedMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/PredicatedMap.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PredicatedMap.java 31 Aug 2003 17:24:46 -0000 1.4
+++ PredicatedMap.java 5 Sep 2003 03:35:07 -0000 1.5
@@ -66,10 +66,10 @@
/**
* <code>PredicatedMap</code> decorates another <code>Map</code>
- * to validate additions match a specified predicate.
+ * to validate that additions match a specified predicate.
* <p>
* If an object cannot be added to the map, an IllegalArgumentException
- * is thrown.
+ * is thrown.</p>
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
@@ -88,11 +88,11 @@
* Factory method to create a predicated (validating) map.
* <p>
* 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 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 @@
* 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) {
1.4 +9 -9
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java
Index: PredicatedSortedMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/PredicatedSortedMap.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PredicatedSortedMap.java 31 Aug 2003 17:24:46 -0000 1.3
+++ PredicatedSortedMap.java 5 Sep 2003 03:35:07 -0000 1.4
@@ -64,10 +64,10 @@
/**
* <code>PredicatedSortedMap</code> decorates another <code>SortedMap </code>
- * to validate additions match a specified predicate.
+ * to validate that additions match a specified predicate.
* <p>
* If an object cannot be added to the map, an IllegalArgumentException
- * is thrown.
+ * is thrown.</p>
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
@@ -81,11 +81,11 @@
* Factory method to create a predicated (validating) sorted map.
* <p>
* 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 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 @@
* 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) {
1.5 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java
Index: SynchronizedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SynchronizedCollection.java 31 Aug 2003 17:24:46 -0000 1.4
+++ SynchronizedCollection.java 5 Sep 2003 03:35:07 -0000 1.5
@@ -96,7 +96,7 @@
/**
* 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 @@
/**
* 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
*/
1.3 +8 -8
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java
Index: TransformedSortedMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/TransformedSortedMap.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TransformedSortedMap.java 31 Aug 2003 17:24:46 -0000 1.2
+++ TransformedSortedMap.java 5 Sep 2003 03:35:07 -0000 1.3
@@ -82,11 +82,11 @@
* Factory method to create a transforming sorted map.
* <p>
* 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 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 @@
* Constructor that wraps (not copies).
* <p>
* 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 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) {
1.3 +7 -7
jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java
Index: UnmodifiableBoundedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiableBoundedCollection.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UnmodifiableBoundedCollection.java 31 Aug 2003 17:24:46 -0000 1.2
+++ UnmodifiableBoundedCollection.java 5 Sep 2003 03:35:07 -0000 1.3
@@ -80,7 +80,7 @@
/**
* 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
*/
public static BoundedCollection decorate(BoundedCollection coll) {
@@ -90,10 +90,10 @@
/**
* Factory method to create an unmodifiable bounded collection.
* <p>
- * 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.</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
*/
public static BoundedCollection decorateUsing(Collection coll) {
@@ -124,7 +124,7 @@
* 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);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
