Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@www.apache.org Received: (qmail 1404 invoked from network); 28 Dec 2003 14:55:50 -0000 Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12) by minotaur-2.apache.org with SMTP; 28 Dec 2003 14:55:50 -0000 Received: (qmail 71190 invoked by uid 500); 28 Dec 2003 14:55:42 -0000 Delivered-To: apmail-jakarta-commons-dev-archive@jakarta.apache.org Received: (qmail 71121 invoked by uid 500); 28 Dec 2003 14:55:42 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 71108 invoked by uid 500); 28 Dec 2003 14:55:42 -0000 Received: (qmail 71103 invoked from network); 28 Dec 2003 14:55:42 -0000 Received: from unknown (HELO minotaur.apache.org) (209.237.227.194) by daedalus.apache.org with SMTP; 28 Dec 2003 14:55:42 -0000 Received: (qmail 1382 invoked by uid 1529); 28 Dec 2003 14:55:46 -0000 Date: 28 Dec 2003 14:55:46 -0000 Message-ID: <20031228145546.1381.qmail@minotaur.apache.org> From: scolebourne@apache.org To: jakarta-commons-cvs@apache.org Subject: cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/bag TreeBag.java SynchronizedSortedBag.java SynchronizedBag.java HashBag.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N scolebourne 2003/12/28 06:55:46 Modified: collections/src/java/org/apache/commons/collections/bag TreeBag.java SynchronizedSortedBag.java SynchronizedBag.java HashBag.java Log: Improve documentation Revision Changes Path 1.3 +8 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java Index: TreeBag.java =================================================================== RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- TreeBag.java 3 Dec 2003 00:49:38 -0000 1.2 +++ TreeBag.java 28 Dec 2003 14:55:46 -0000 1.3 @@ -74,6 +74,12 @@ *

* Order will be maintained among the bag members and can be viewed through the * iterator. + *

+ * A Bag stores each object in the collection together with a + * count of occurances. Extra methods on the interface allow multiple copies + * of an object to be added or removed at once. It is important to read the + * interface javadoc carefully as several methods violate the + * Collection interface specification. * * @since Commons Collections 3.0 * @version $Revision$ $Date$ 1.2 +3 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/bag/SynchronizedSortedBag.java Index: SynchronizedSortedBag.java =================================================================== RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/SynchronizedSortedBag.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- SynchronizedSortedBag.java 16 Nov 2003 00:05:43 -0000 1.1 +++ SynchronizedSortedBag.java 28 Dec 2003 14:55:46 -0000 1.2 @@ -67,6 +67,7 @@ * for a multi-threaded environment. *

* Methods are synchronized, then forwarded to the decorated bag. + * Iterators must be separately synchronized around the loop. * * @since Commons Collections 3.0 * @version $Revision$ $Date$ 1.2 +3 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/bag/SynchronizedBag.java Index: SynchronizedBag.java =================================================================== RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/SynchronizedBag.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- SynchronizedBag.java 16 Nov 2003 00:05:43 -0000 1.1 +++ SynchronizedBag.java 28 Dec 2003 14:55:46 -0000 1.2 @@ -68,6 +68,7 @@ * for a multi-threaded environment. *

* Methods are synchronized, then forwarded to the decorated bag. + * Iterators must be separately synchronized around the loop. * * @since Commons Collections 3.0 * @version $Revision$ $Date$ 1.3 +8 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/bag/HashBag.java Index: HashBag.java =================================================================== RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/HashBag.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- HashBag.java 3 Dec 2003 00:49:38 -0000 1.2 +++ HashBag.java 28 Dec 2003 14:55:46 -0000 1.3 @@ -69,6 +69,12 @@ /** * Implements Bag, using a HashMap to provide the * data storage. This is the standard implementation of a bag. + *

+ * A Bag stores each object in the collection together with a + * count of occurances. Extra methods on the interface allow multiple copies + * of an object to be added or removed at once. It is important to read the + * interface javadoc carefully as several methods violate the + * Collection interface specification. * * @since Commons Collections 3.0 * @version $Revision$ $Date$ --------------------------------------------------------------------- To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org For additional commands, e-mail: commons-dev-help@jakarta.apache.org