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

Update Bag interface text to indicate that we won't break compatability 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131679 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-04-27 20:43:05 +00:00
parent a249eba720
commit d3077d07ae
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
RELEASE-NOTES.html
View File

@ -75,6 +75,7 @@ No interface changes, or deprecations have occurred.
<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>

15
src/java/org/apache/commons/collections/Bag.java
View File

@ -27,15 +27,18 @@ import java.util.Set;
* Calling {@link #getCount(Object)} on <code>a</code> would return 2, while
* calling {@link #uniqueSet()} would return <code>{a, b, c}</code>.
* <p>
* <i>Note that this interface violates the {@link Collection} contract.</i>
* <i>NOTE: This interface violates the {@link 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: 1.16 $ $Date: 2004/02/18 01:15:42 $
* @version $Revision: 1.17 $ $Date: 2004/04/27 20:43:05 $
*
* @author Chuck Burdick
* @author Stephen Colebourne