Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.collections.DefaultMapBag
Bag
interface to minimize the effort required for target implementations.
Subclasses need only to call setMap(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.
Constructor Summary | |
| |
|
Method Summary | |
boolean |
|
boolean |
|
boolean |
|
protected int |
|
void |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
int |
|
protected Map |
|
int |
|
boolean |
|
Iterator |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean | |
protected void |
|
int |
|
Object[] |
|
Object[] |
|
String |
|
Set |
|
public DefaultMapBag()
No-argument constructor. Subclasses should invokesetMap(Map)
in their constructors.
protected DefaultMapBag(Map map)
Constructor that assigns the specified Map as the backing store. The map must be empty.
- Parameters:
map
- the map to assign
public boolean add(Object object)
Adds a new element to the bag by incrementing its count in the underlying map.
- Parameters:
object
- the object to add
- Returns:
true
if the object was not already in theuniqueSet
public boolean add(Object object, int nCopies)
Adds a new element to the bag by incrementing its count in the map.
- Parameters:
object
- the object to search fornCopies
- the number of copies to add
- Returns:
true
if the object was not already in theuniqueSet
public boolean addAll(Collection coll)
Invokesadd(Object)
for each element in the given collection.
- Parameters:
coll
- the collection to add
- Returns:
true
if this call changed the bag
protected int calcTotalSize()
Actually walks the bag to make sure the count is correct and resets the running total
- Returns:
- the current total size
public void clear()
Clears the bag by clearing the underlying map.
public boolean contains(Object object)
Determines if the bag contains the given element by checking if the underlying map contains the element as a key.
- Parameters:
object
- the object to search for
- Returns:
- true if the bag contains the given element
public boolean containsAll(Collection coll)
Determines if the bag contains the given elements.
- Specified by:
- containsAll in interface Bag
- Parameters:
coll
- the collection to check against
- Returns:
true
if the Bag contains all the collection
public boolean containsAll(Bag other)
Returnstrue
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
public 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.
- Parameters:
object
- the object to test for equality
- Returns:
- true if that object equals this bag
public 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.
- Parameters:
object
- the object to search for
- Returns:
- the number of occurrences of the object, zero if not found
protected Map getMap()
Utility method for implementations to access the map that backs this bag. Not intended for interactive use outside of subclasses.
public int hashCode()
Returns the hash code of the underlying map.
- Returns:
- the hash code of the underlying map
public boolean isEmpty()
Returns true if the underlying map is empty.
- Returns:
- true if there are no elements in this bag
public boolean retainAll(Collection coll)
Remove any members of the bag that are not in the given bag, respecting cardinality.
- Parameters:
coll
- the collection to retain
- Returns:
- true if this call changed the collection
public boolean retainAll(Bag other)
Remove any members of the bag that are not in the given bag, respecting cardinality.
- Parameters:
other
- the bag to retain
- Returns:
true
if this call changed the collection
- See Also:
retainAll(Collection)
protected void setMap(Map map)
Utility method for implementations to set the map that backs this bag. Not intended for interactive use outside of subclasses.
public int size()
Returns the number of elements in this bag.
- Returns:
- the number of elements in this bag
public Object[] toArray()
Returns an array of all of this bag's elements.
- Returns:
- an array of all of this bag's elements
public Object[] toArray(Object[] array)
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
public String toString()
Implement a toString() method suitable for debugging.
- Returns:
- a debugging toString