public abstract class AbstractMapBag<E> extends Object implements Bag<E>
Bag interface to simplify the creation
of subclass implementations.
Subclasses specify a Map implementation to use as the internal storage. 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.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AbstractMapBag.MutableInteger
Mutable integer class for storing the data.
|
| Modifier | Constructor and Description |
|---|---|
protected |
AbstractMapBag()
Constructor needed for subclass serialisation.
|
protected |
AbstractMapBag(Map<E,AbstractMapBag.MutableInteger> map)
Constructor that assigns the specified Map as the backing store.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E object)
Adds a new element to the bag, incrementing its count in the underlying map.
|
boolean |
add(E object,
int nCopies)
Adds a new element to the bag, incrementing its count in the map.
|
boolean |
addAll(Collection<? extends E> coll)
Invokes
add(Object) for each element in the given collection. |
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.
|
protected void |
doReadObject(Map<E,AbstractMapBag.MutableInteger> map,
ObjectInputStream in)
Read the map in using a custom routine.
|
protected void |
doWriteObject(ObjectOutputStream out)
Write the map out using a custom routine.
|
boolean |
equals(Object object)
Compares this Bag to another.
|
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<E,AbstractMapBag.MutableInteger> |
getMap()
Utility method for implementations to access the map that backs this bag.
|
int |
hashCode()
Gets a hash code for the Bag compatible with the definition of equals.
|
boolean |
isEmpty()
Returns true if the underlying map is empty.
|
Iterator<E> |
iterator()
Gets an iterator over the bag elements.
|
boolean |
remove(Object object)
Removes all copies of the specified object from the bag.
|
boolean |
remove(Object object,
int nCopies)
Removes a specified number of copies of an object from the bag.
|
boolean |
removeAll(Collection<?> coll)
Removes objects from the bag according to their count in the specified
collection.
|
boolean |
retainAll(Collection<?> coll)
Remove any members of the bag that are not in the given bag, respecting
cardinality.
|
int |
size()
Returns the number of elements in this bag.
|
Object[] |
toArray()
Returns an array of all of this bag's elements.
|
<T> T[] |
toArray(T[] array)
Returns an array of all of this bag's elements.
|
String |
toString()
Implement a toString() method suitable for debugging.
|
Set<E> |
uniqueSet()
Returns an unmodifiable view of the underlying map's key set.
|
protected AbstractMapBag()
protected AbstractMapBag(Map<E,AbstractMapBag.MutableInteger> map)
map - the map to assignprotected Map<E,AbstractMapBag.MutableInteger> getMap()
public int size()
public boolean isEmpty()
isEmpty in interface Collection<E>public int getCount(Object object)
public boolean contains(Object object)
contains in interface Collection<E>object - the object to search forpublic boolean containsAll(Collection<?> coll)
containsAll in interface Collection<E>containsAll in interface Bag<E>coll - the collection to check againsttrue if the Bag contains all the collectionpublic Iterator<E> iterator()
public boolean add(E object)
public boolean add(E object, int nCopies)
public boolean addAll(Collection<? extends E> coll)
add(Object) for each element in the given collection.addAll in interface Collection<E>coll - the collection to addtrue if this call changed the bagpublic void clear()
clear in interface Collection<E>public boolean remove(Object object)
public boolean remove(Object object, int nCopies)
public boolean removeAll(Collection<?> coll)
public boolean retainAll(Collection<?> coll)
public Object[] toArray()
toArray in interface Collection<E>public <T> T[] toArray(T[] array)
toArray in interface Collection<E>T - the type of the array elementsarray - the array to populateArrayStoreException - if the runtime type of the specified array is not
a supertype of the runtime type of the elements in this listNullPointerException - if the specified array is nullprotected void doWriteObject(ObjectOutputStream out) throws IOException
out - the output streamIOException - any of the usual I/O related exceptionsprotected void doReadObject(Map<E,AbstractMapBag.MutableInteger> map, ObjectInputStream in) throws IOException, ClassNotFoundException
map - the map to usein - the input streamIOException - any of the usual I/O related exceptionsClassNotFoundException - if the stream contains an object which class can not be loadedClassCastException - if the stream does not contain the correct objectspublic boolean equals(Object object)
equals in interface Collection<E>equals in class Objectobject - the Bag to compare topublic int hashCode()
(e==null ? 0 : e.hashCode()) ^ noOccurances). This hash code
is compatible with the Set interface.hashCode in interface Collection<E>hashCode in class ObjectCopyright © 2001–2013 The Apache Software Foundation. All rights reserved.