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

[COLLECTIONS-508] Clarify javadoc of CollectionBag. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1575586 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2014-03-08 18:47:09 +00:00
parent c7599fd2a8
commit 00291db476
2 changed files with 72 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/changes/changes.xml
View File

@ -22,6 +22,9 @@
<body> <body>
<release version="4.1" date="TBD" description=""> <release version="4.1" date="TBD" description="">
<action issue="COLLECTIONS-508" dev="tn" type="fix">
Clarified javadoc of "CollectionBag" wrt changes from the original Bag interface.
</action>
<action issue="COLLECTIONS-507" dev="tn" type="fix" due-to="Gerson"> <action issue="COLLECTIONS-507" dev="tn" type="fix" due-to="Gerson">
Removed wrong type bounds for "ComparatorUtils#chainedComparator(...)". Removed wrong type bounds for "ComparatorUtils#chainedComparator(...)".
</action> </action>

69
src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
View File

@ -26,7 +26,15 @@ import org.apache.commons.collections4.Bag;
/** /**
* Decorates another {@link Bag} to comply with the Collection contract. * Decorates another {@link Bag} to comply with the Collection contract.
* <p>
* By decorating an existing {@link Bag} instance with a {@link CollectionBag},
* it can be safely passed on to methods that require Collection types that
* are fully compliant with the Collection contract.
* <p>
* The method javadoc highlights the differences compared to the original Bag interface.
* *
* @see Bag
* @param <E> the type held in the bag
* @since 4.0 * @since 4.0
* @version $Id$ * @version $Id$
*/ */
@ -88,6 +96,16 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
// Collection interface // Collection interface
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/**
* <i>(Change)</i>
* Returns <code>true</code> if the bag contains all elements in
* the given collection, <b>not</b> respecting cardinality. That is,
* if the given collection <code>coll</code> contains at least one of
* every object contained in this object.
*
* @param coll the collection to check against
* @return <code>true</code> if the Bag contains at least on of every object in the collection
*/
@Override @Override
public boolean containsAll(final Collection<?> coll) { public boolean containsAll(final Collection<?> coll) {
final Iterator<?> e = coll.iterator(); final Iterator<?> e = coll.iterator();
@ -99,6 +117,16 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
return true; return true;
} }
/**
* <i>(Change)</i>
* Adds one copy of the specified object to the Bag.
* <p>
* Since this method always increases the size of the bag, it
* will always return <code>true</code>.
*
* @param object the object to add
* @return <code>true</code>, always
*/
@Override @Override
public boolean add(final E object) { public boolean add(final E object) {
return add(object, 1); return add(object, 1);
@ -115,11 +143,30 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
return changed; return changed;
} }
/**
* <i>(Change)</i>
* Removes the first occurrence of the given object from the bag.
* <p>
* This will also remove the object from the {@link #uniqueSet()} if the
* bag contains no occurrence anymore of the object after this operation.
*
* @param object the object to remove
* @return <code>true</code> if this call changed the collection
*/
@Override @Override
public boolean remove(final Object object) { public boolean remove(final Object object) {
return remove(object, 1); return remove(object, 1);
} }
/**
* <i>(Change)</i>
* Remove all elements represented in the given collection,
* <b>not</b> respecting cardinality. That is, remove <i>all</i>
* occurrences of every object contained in the given collection.
*
* @param coll the collection to remove
* @return <code>true</code> if this call changed the collection
*/
@Override @Override
public boolean removeAll(final Collection<?> coll) { public boolean removeAll(final Collection<?> coll) {
if (coll != null) { if (coll != null) {
@ -137,6 +184,17 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
} }
} }
/**
* <i>(Change)</i>
* Remove any members of the bag that are not in the given
* collection, <i>not</i> respecting cardinality. That is, any object
* in the given collection <code>coll</code> will be retained in the
* bag with the same number of copies prior to this operation. All
* other objects will be completely removed from this bag.
*
* @param coll the collection to retain
* @return <code>true</code> if this call changed the collection
*/
@Override @Override
public boolean retainAll(final Collection<?> coll) { public boolean retainAll(final Collection<?> coll) {
if (coll != null) { if (coll != null) {
@ -159,6 +217,17 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
// Bag interface // Bag interface
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/**
* <i>(Change)</i>
* Adds <code>count</code> copies of the specified object to the Bag.
* <p>
* Since this method always increases the size of the bag, it
* will always return <code>true</code>.
*
* @param object the object to add
* @param count the number of copies to add
* @return <code>true</code>, always
*/
@Override @Override
public boolean add(final E object, final int count) { public boolean add(final E object, final int count) {
decorated().add(object, count); decorated().add(object, count);