scolebourne 2003/12/13 15:51:28
Modified: collections/src/java/org/apache/commons/collections
SortedBag.java Closure.java
ResettableListIterator.java ResettableIterator.java
MultiMap.java package.html Transformer.java
Predicate.java Factory.java PriorityQueue.java
Buffer.java
Log:
Update javadoc
Revision Changes Path
1.7 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/SortedBag.java
Index: SortedBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/SortedBag.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SortedBag.java 31 Aug 2003 17:26:44 -0000 1.6
+++ SortedBag.java 13 Dec 2003 23:51:28 -0000 1.7
@@ -60,8 +60,8 @@
import java.util.Comparator;
/**
- * A type of [EMAIL PROTECTED] Bag} that maintains order among its unique
- * representative members.
+ * Defines a type of <code>Bag</code> that maintains a sorted order among
+ * its unique representative members.
*
* @since Commons Collections 2.0
* @version $Revision$ $Date$
1.8 +3 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/Closure.java
Index: Closure.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Closure.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Closure.java 31 Aug 2003 17:26:44 -0000 1.7
+++ Closure.java 13 Dec 2003 23:51:28 -0000 1.8
@@ -58,8 +58,7 @@
package org.apache.commons.collections;
/**
- * <code>Closure</code> defines an interface implemented by classes that
- * do something.
+ * Defines a functor interface implemented by classes that do something.
* <p>
* A Closure represents a block of code which is executed from inside some
* block, function or iteration. It operates an input object.
1.2 +5 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/ResettableListIterator.java
Index: ResettableListIterator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/ResettableListIterator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ResettableListIterator.java 1 Dec 2003 22:48:59 -0000 1.1
+++ ResettableListIterator.java 13 Dec 2003 23:51:28 -0000 1.2
@@ -60,8 +60,9 @@
import java.util.ListIterator;
/**
- * Interface implemented by those list iterators that can be reset back
- * to an initial state.
+ * Defines a list iterator that can be reset back to an initial state.
+ * <p>
+ * This interface allows an iterator to be repeatedly reused.
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
1.2 +5 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/ResettableIterator.java
Index: ResettableIterator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/ResettableIterator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ResettableIterator.java 1 Dec 2003 22:48:59 -0000 1.1
+++ ResettableIterator.java 13 Dec 2003 23:51:28 -0000 1.2
@@ -60,8 +60,9 @@
import java.util.Iterator;
/**
- * Interface implemented by those iterators that can be reset back to an
- * initial state.
+ * Defines an iterator that can be reset back to an initial state.
+ * <p>
+ * This interface allows an iterator to be repeatedly reused.
*
* @since Commons Collections 3.0
* @version $Revision$ $Date$
1.9 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/MultiMap.java
Index: MultiMap.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/MultiMap.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- MultiMap.java 9 Oct 2003 20:58:52 -0000 1.8
+++ MultiMap.java 13 Dec 2003 23:51:28 -0000 1.9
@@ -60,7 +60,7 @@
import java.util.Map;
/**
- * This is simply a Map with slightly different semantics.
+ * Defines a map that holds a collection of values against each key.
* <p>
* A <code>MultiMap</code> is a Map with slightly different semantics.
* Putting a value into the map will add the value to a Collection at that
1.10 +4 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/package.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- package.html 16 May 2003 16:00:29 -0000 1.9
+++ package.html 13 Dec 2003 23:51:28 -0000 1.10
@@ -1,6 +1,9 @@
<!-- $Id$ -->
<body>
<p>
+ This package contains new interfaces to complement the Java Collections
Framework,
+ and various utility classes.
+ <p>
The Apache Jakarta Commons Collections Framework extensions are implemented in
a number of packages.
<ul>
1.7 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/Transformer.java
Index: Transformer.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Transformer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Transformer.java 31 Aug 2003 17:26:44 -0000 1.6
+++ Transformer.java 13 Dec 2003 23:51:28 -0000 1.7
@@ -58,7 +58,7 @@
package org.apache.commons.collections;
/**
- * <code>Transformer</code> defines an interface implemented by classes that
+ * Defines a functor interface implemented by classes that
* transform one object into another. The original object is left unchanged.
* Transformers are typically used for type conversions, or extracting data
* from an object.
1.8 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/Predicate.java
Index: Predicate.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Predicate.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Predicate.java 31 Aug 2003 17:26:44 -0000 1.7
+++ Predicate.java 13 Dec 2003 23:51:28 -0000 1.8
@@ -58,7 +58,7 @@
package org.apache.commons.collections;
/**
- * <code>Predicate</code> defines an interface implemented by classes that
+ * Defines a functor interface implemented by classes that
* perform a predicate test on an object. Predicate instances can be used
* to implement queries or to do filtering.
*
1.6 +3 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/Factory.java
Index: Factory.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Factory.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Factory.java 31 Aug 2003 17:26:43 -0000 1.5
+++ Factory.java 13 Dec 2003 23:51:28 -0000 1.6
@@ -58,8 +58,7 @@
package org.apache.commons.collections;
/**
- * <code>Factory</code> defines an interface implemented by classes that
- * create objects.
+ * Defines a functor interface implemented by classes that create objects.
*
* @since Commons Collections 2.1
* @version $Revision$ $Date$
1.8 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/PriorityQueue.java
Index: PriorityQueue.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/PriorityQueue.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- PriorityQueue.java 31 Aug 2003 17:26:44 -0000 1.7
+++ PriorityQueue.java 13 Dec 2003 23:51:28 -0000 1.8
@@ -60,7 +60,8 @@
import java.util.NoSuchElementException;
/**
- * Interface for priority queues.
+ * Defines a collection for priority queues, which can insert, peek and pop.
+ * <p>
* This interface does not dictate whether it is min or max heap.
*
* @since Commons Collections 1.0
1.7 +7 -7
jakarta-commons/collections/src/java/org/apache/commons/collections/Buffer.java
Index: Buffer.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Buffer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Buffer.java 6 Sep 2003 20:41:12 -0000 1.6
+++ Buffer.java 13 Dec 2003 23:51:28 -0000 1.7
@@ -60,11 +60,11 @@
import java.util.Collection;
/**
- * A Buffer is a collection that allows objects to be removed in some
- * well-defined order. The removal order can be based on insertion order
- * (eg, a FIFO queue or a LIFO stack), on access order (eg, an LRU cache),
- * on some arbitrary comparator (eg, a priority queue) or on any other
- * well-defined ordering.
+ * Defines a collection that allows objects to be removed in some well-defined
order.
+ * <p>
+ * The removal order can be based on insertion order (eg, a FIFO queue or a
+ * LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator
+ * (eg, a priority queue) or on any other well-defined ordering.
* <p>
* Note that the removal order is not necessarily the same as the iteration
* order. A <code>Buffer</code> implementation may have equivalent removal
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
