Class TreeBag
- java.lang.Object
-
- org.apache.commons.collections.bag.AbstractMapBag
-
- org.apache.commons.collections.bag.TreeBag
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable
,java.util.Collection
,Bag
,SortedBag
public class TreeBag extends AbstractMapBag implements SortedBag, java.io.Serializable
ImplementsSortedBag
, using aTreeMap
to provide the data storage. This is the standard implementation of a sorted bag.Order will be maintained among the bag members and can be viewed through the iterator.
A
Bag
stores each object in the collection together with a count of occurrences. Extra methods on the interface allow multiple copies of an object to be added or removed at once. It is important to read the interface javadoc carefully as several methods violate theCollection
interface specification.- Since:
- Commons Collections 3.0 (previously in main package v2.0)
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.commons.collections.bag.AbstractMapBag
AbstractMapBag.BagIterator, AbstractMapBag.MutableInteger
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serial version lock
-
Constructor Summary
Constructors Constructor Description TreeBag()
Constructs an emptyTreeBag
.TreeBag(java.util.Collection coll)
Constructs aTreeBag
containing all the members of the specified collection.TreeBag(java.util.Comparator comparator)
Constructs an empty bag that maintains order on its unique representative members according to the givenComparator
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Comparator
comparator()
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.java.lang.Object
first()
Returns the first (lowest) member.java.lang.Object
last()
Returns the last (highest) member.private void
readObject(java.io.ObjectInputStream in)
Read the bag in using a custom routine.private void
writeObject(java.io.ObjectOutputStream out)
Write the bag out using a custom routine.-
Methods inherited from class org.apache.commons.collections.bag.AbstractMapBag
add, add, addAll, clear, contains, containsAll, containsAll, doReadObject, doWriteObject, equals, getCount, getMap, hashCode, isEmpty, iterator, remove, remove, removeAll, retainAll, retainAll, size, toArray, toArray, toString, uniqueSet
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.collections.Bag
add, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSet
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serial version lock- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TreeBag
public TreeBag()
Constructs an emptyTreeBag
.
-
TreeBag
public TreeBag(java.util.Comparator comparator)
Constructs an empty bag that maintains order on its unique representative members according to the givenComparator
.- Parameters:
comparator
- the comparator to use
-
TreeBag
public TreeBag(java.util.Collection coll)
Constructs aTreeBag
containing all the members of the specified collection.- Parameters:
coll
- the collection to copy into the bag
-
-
Method Detail
-
first
public java.lang.Object first()
Description copied from interface:SortedBag
Returns the first (lowest) member.
-
last
public java.lang.Object last()
Description copied from interface:SortedBag
Returns the last (highest) member.
-
comparator
public java.util.Comparator comparator()
Description copied from interface:SortedBag
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.- Specified by:
comparator
in interfaceSortedBag
- Returns:
- the comparator in use, or null if natural ordering
-
writeObject
private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
Write the bag out using a custom routine.- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
Read the bag in using a custom routine.- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-