Implements org.apache.commons.collections4.Bag.add.

Doc from org.apache.commons.collections4.Bag.add.

Adds nCopies copies of the specified object to the Bag.

If the object is already in the uniqueSet() then increment its count as reported by getCount(Object). Otherwise add it to the uniqueSet() and report its count as nCopies.

Parameters

object:E

the object to add

count:int

the number of copies to add

Returns:boolean

true if the object was not already in the uniqueSet

Annotations

@Override

Overrides org.apache.commons.collections4.collection.SynchronizedCollection.equals.

Implements java.util.Collection.equals.

Doc from java.util.Collection.equals.

Compares the specified object with this collection for equality.

While the Collection interface adds no stipulations to the general contract for the Object.equals, programmers who implement the Collection interface "directly" (in other words, create a class that is a Collection but is not a Set or a List) must exercise care if they choose to override the Object.equals. It is not necessary to do so, and the simplest course of action is to rely on Object's implementation, but the implementor may wish to implement a "value comparison" in place of the default "reference comparison." (The List and Set interfaces mandate such value comparisons.)

The general contract for the Object.equals method states that equals must be symmetric (in other words, a.equals(b) if and only if b.equals(a)). The contracts for List.equals and Set.equals state that lists are only equal to other lists, and sets to other sets. Thus, a custom equals method for a collection class that implements neither the List nor Set interface must return false when this collection is compared to any list or set. (By the same logic, it is not possible to write a class that correctly implements both the Set and List interfaces.)

Parameters

object:Object

object to be compared for equality with this collection

Returns:boolean

true if the specified object is equal to this collection

Annotations

@Override

Implements org.apache.commons.collections4.Bag.getCount.

Doc from org.apache.commons.collections4.Bag.getCount.

Returns the number of occurrences (cardinality) of the given object currently in the bag. If the object does not exist in the bag, return 0.

Parameters

object:Object

the object to search for

Returns:int

the number of occurrences of the object, zero if not found

Annotations

@Override

Overrides org.apache.commons.collections4.collection.SynchronizedCollection.hashCode.

Implements java.util.Collection.hashCode.

Doc from java.util.Collection.hashCode.

Returns the hash code value for this collection. While the Collection interface adds no stipulations to the general contract for the Object.hashCode method, programmers should take note that any class that overrides the Object.equals method must also override the Object.hashCode method in order to satisfy the general contract for the Object.hashCode method. In particular, c1.equals(c2) implies that c1.hashCode()==c2.hashCode().

Returns:int

the hash code value for this collection

Annotations

@Override

Implements org.apache.commons.collections4.Bag.remove.

Doc from org.apache.commons.collections4.Bag.remove.

Removes nCopies copies of the specified object from the Bag.

If the number of copies to remove is greater than the actual number of copies in the Bag, no error is thrown.

Parameters

object:Object

the object to remove

count:int

the number of copies to remove

Returns:boolean

true if this call changed the collection

Annotations

@Override

Factory method to create a synchronized bag.

Parameters

<E>

the type of the elements in the bag

bag:Bag<E>

the bag to decorate, must not be null

Returns:SynchronizedBag<E>

a new synchronized Bag

Exceptions

NullPointerException:

if bag is null

Since

4.0

Implements org.apache.commons.collections4.Bag.uniqueSet.

Doc from org.apache.commons.collections4.Bag.uniqueSet.

Returns a Set of unique elements in the Bag.

Uniqueness constraints are the same as those in java.util.Set.

Returns:Set<E>

the Set of unique Bag elements

Annotations

@Override