scolebourne 2004/04/27 13:43:05
Modified: collections RELEASE-NOTES.html
collections/src/java/org/apache/commons/collections Bag.java
Log:
Update Bag interface text to indicate that we won't break compatability
Revision Changes Path
1.42 +1 -0 jakarta-commons/collections/RELEASE-NOTES.html
Index: RELEASE-NOTES.html
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/RELEASE-NOTES.html,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- RELEASE-NOTES.html 27 Apr 2004 20:00:17 -0000 1.41
+++ RELEASE-NOTES.html 27 Apr 2004 20:43:05 -0000 1.42
@@ -75,6 +75,7 @@
<center><h3>JAVADOC</h3></center>
<ul>
+<li>Bag - Indicate that no changes are likely to the interface despite its
problems</li>
<li>TreeBidiMap - Add javadoc about requiring Comparable entries [26470]</li>
<li>MultiKey - Add extra explanatations, examples and warnings</li>
<li>MultiMap,MultiHashMap - Add extra documentation to clarify the interface and
implementation</li>
1.17 +9 -6
jakarta-commons/collections/src/java/org/apache/commons/collections/Bag.java
Index: Bag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Bag.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Bag.java 18 Feb 2004 01:15:42 -0000 1.16
+++ Bag.java 27 Apr 2004 20:43:05 -0000 1.17
@@ -27,12 +27,15 @@
* Calling [EMAIL PROTECTED] #getCount(Object)} on <code>a</code> would return 2,
while
* calling [EMAIL PROTECTED] #uniqueSet()} would return <code>{a, b, c}</code>.
* <p>
- * <i>Note that this interface violates the [EMAIL PROTECTED] Collection}
contract.</i>
+ * <i>NOTE: This interface violates the [EMAIL PROTECTED] Collection} contract.</i>
* The behavior specified in many of these methods is <i>not</i> the same
- * as the behavior specified by <code>Collection</code>. The noncompliant methods
- * are clearly marked with "(Violation)". A future
- * version of this class will specify the same behavior as <code>Collection</code>,
- * which unfortunately will break backwards compatibility with this version.
+ * as the behavior specified by <code>Collection</code>.
+ * The noncompliant methods are clearly marked with "(Violation)".
+ * Exercise caution when using a bag as a <code>Collection</code>.
+ * <p>
+ * This violation resulted from the original specification of this interface.
+ * In an ideal world, the interface would be changed to fix the problems, however
+ * it has been decided to maintain backwards compatibility instead.
*
* @since Commons Collections 2.0
* @version $Revision$ $Date$
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
