org.apache.commons.collections
public abstract class DefaultMapBag extends Object implements Bag
Deprecated: Moved to bag subpackage as AbstractMapBag. Due to be removed in v4.0.
A skeletal implementation of the Bag interface to minimize the effort required for target implementations. Subclasses need only to callsetMap(Map)
in their constructor
(or invoke the Map constructor) specifying a map instance that will be used
to store the contents of the bag.
The map will be used to map bag elements to a number; the number represents the number of occurrences of that element in the bag.
Since: Commons Collections 2.0
Version: $Revision: 357494 $ $Date: 2005-12-18 19:05:31 +0000 (Sun, 18 Dec 2005) $
Constructor Summary | |
---|---|
DefaultMapBag()
No-argument constructor.
| |
protected | DefaultMapBag(Map map)
Constructor that assigns the specified Map as the backing store.
|
Method Summary | |
---|---|
boolean | add(Object object)
Adds a new element to the bag by incrementing its count in the
underlying map.
|
boolean | add(Object object, int nCopies)
Adds a new element to the bag by incrementing its count in the map.
|
boolean | addAll(Collection coll)
Invokes add for each element in the given collection.
|
protected int | calcTotalSize()
Actually walks the bag to make sure the count is correct and
resets the running total
|
void | clear()
Clears the bag by clearing the underlying map. |
boolean | contains(Object object)
Determines if the bag contains the given element by checking if the
underlying map contains the element as a key.
|
boolean | containsAll(Collection coll)
Determines if the bag contains the given elements.
|
boolean | containsAll(Bag other)
Returns true if the bag contains all elements in
the given collection, respecting cardinality.
|
boolean | equals(Object object)
Returns true if the given object is not null, has the precise type
of this bag, and contains the same number of occurrences of all the
same elements.
|
int | getCount(Object object)
Returns the number of occurrence of the given element in this bag
by looking up its count in the underlying map.
|
protected Map | getMap()
Utility method for implementations to access the map that backs
this bag. |
int | hashCode()
Returns the hash code of the underlying map.
|
boolean | isEmpty()
Returns true if the underlying map is empty.
|
Iterator | iterator() |
boolean | remove(Object object) |
boolean | remove(Object object, int nCopies) |
boolean | removeAll(Collection coll) |
boolean | retainAll(Collection coll)
Remove any members of the bag that are not in the given
bag, respecting cardinality.
|
boolean | retainAll(Bag other)
Remove any members of the bag that are not in the given
bag, respecting cardinality. |
protected void | setMap(Map map)
Utility method for implementations to set the map that backs
this bag. |
int | size()
Returns the number of elements in this bag.
|
Object[] | toArray()
Returns an array of all of this bag's elements.
|
Object[] | toArray(Object[] array)
Returns an array of all of this bag's elements.
|
String | toString()
Implement a toString() method suitable for debugging.
|
Set | uniqueSet()
Returns an unmodifiable view of the underlying map's key set.
|
setMap(Map)
in
their constructors.Parameters: map the map to assign
Parameters: object the object to add
Returns: true
if the object was not already in the uniqueSet
Parameters: object the object to search for nCopies the number of copies to add
Returns: true
if the object was not already in the uniqueSet
Parameters: coll the collection to add
Returns: true
if this call changed the bag
Returns: the current total size
Parameters: object the object to search for
Returns: true if the bag contains the given element
Parameters: coll the collection to check against
Returns: true
if the Bag contains all the collection
true
if the bag contains all elements in
the given collection, respecting cardinality.
Parameters: other the bag to check against
Returns: true
if the Bag contains all the collection
Parameters: object the object to test for equality
Returns: true if that object equals this bag
Parameters: object the object to search for
Returns: the number of occurrences of the object, zero if not found
Returns: the hash code of the underlying map
Returns: true if there are no elements in this bag
Parameters: coll the collection to retain
Returns: true if this call changed the collection
Parameters: other the bag to retain
Returns: true
if this call changed the collection
Returns: the number of elements in this bag
Returns: an array of all of this bag's elements
Parameters: array the array to populate
Returns: an array of all of this bag's elements
Returns: a debugging toString
Returns: the set of unique elements in this bag