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 method text to indicate that we won't break compatability 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131695 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-05-03 15:12:20 +00:00
parent 08756b758a
commit da463d13e7
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -38,7 +38,7 @@ import java.util.Set;
* it has been decided to maintain backwards compatibility instead. * it has been decided to maintain backwards compatibility instead.
* *
* @since Commons Collections 2.0 * @since Commons Collections 2.0
* @version $Revision: 1.17 $ $Date: 2004/04/27 20:43:05 $ * @version $Revision: 1.18 $ $Date: 2004/05/03 15:12:20 $
* *
* @author Chuck Burdick * @author Chuck Burdick
* @author Stephen Colebourne * @author Stephen Colebourne
@ -66,8 +66,7 @@ public interface Bag extends Collection {
* Since this method always increases the size of the bag, * Since this method always increases the size of the bag,
* according to the {@link Collection#add(Object)} contract, it * according to the {@link Collection#add(Object)} contract, it
* should always return <code>true</code>. Since it sometimes returns * should always return <code>true</code>. Since it sometimes returns
* <code>false</code>, this method violates the contract. A future * <code>false</code>, this method violates the contract.
* version of this method will comply by always returning <code>true</code>.
* *
* @param object the object to add * @param object the object to add
* @return <code>true</code> if the object was not already in the <code>uniqueSet</code> * @return <code>true</code> if the object was not already in the <code>uniqueSet</code>
@ -95,9 +94,7 @@ public interface Bag extends Collection {
* <p> * <p>
* According to the {@link Collection#remove(Object)} method, * According to the {@link Collection#remove(Object)} method,
* this method should only remove the <i>first</i> occurrence of the * this method should only remove the <i>first</i> occurrence of the
* given object, not <i>all</i> occurrences. A future version of this * given object, not <i>all</i> occurrences.
* method will comply with the contract by only removing one occurrence
* of the given object.
* *
* @return <code>true</code> if this call changed the collection * @return <code>true</code> if this call changed the collection
*/ */
@ -142,8 +139,7 @@ public interface Bag extends Collection {
* The {@link Collection#containsAll(Collection)} method specifies * The {@link Collection#containsAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should * that cardinality should <i>not</i> be respected; this method should
* return true if the bag contains at least one of every object contained * return true if the bag contains at least one of every object contained
* in the given collection. A future version of this method will comply * in the given collection.
* with that contract.
* *
* @param coll the collection to check against * @param coll the collection to check against
* @return <code>true</code> if the Bag contains all the collection * @return <code>true</code> if the Bag contains all the collection
@ -161,8 +157,7 @@ public interface Bag extends Collection {
* <P>The {@link Collection#removeAll(Collection)} method specifies * <P>The {@link Collection#removeAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should * that cardinality should <i>not</i> be respected; this method should
* remove <i>all</i> occurrences of every object contained in the * remove <i>all</i> occurrences of every object contained in the
* given collection. A future version of this method will comply * given collection.
* with that contract.
* *
* @param coll the collection to remove * @param coll the collection to remove
* @return <code>true</code> if this call changed the collection * @return <code>true</code> if this call changed the collection
@ -183,8 +178,7 @@ public interface Bag extends Collection {
* <P>The {@link Collection#retainAll(Collection)} method specifies * <P>The {@link Collection#retainAll(Collection)} method specifies
* that cardinality should <i>not</i> be respected; this method should * that cardinality should <i>not</i> be respected; this method should
* keep <i>all</i> occurrences of every object contained in the * keep <i>all</i> occurrences of every object contained in the
* given collection. A future version of this method will comply * given collection.
* with that contract.
* *
* @param coll the collection to retain * @param coll the collection to retain
* @return <code>true</code> if this call changed the collection * @return <code>true</code> if this call changed the collection