Class TreeBag
java.lang.Object
org.apache.commons.collections.bag.AbstractMapBag
org.apache.commons.collections.bag.TreeBag
- All Implemented Interfaces:
Serializable
,Iterable
,Collection
,Bag
,SortedBag
Implements
SortedBag
, using a TreeMap
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 the
Collection
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.collections.bag.AbstractMapBag
AbstractMapBag.BagIterator, AbstractMapBag.MutableInteger
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionTreeBag()
Constructs an emptyTreeBag
.TreeBag
(Collection coll) Constructs aTreeBag
containing all the members of the specified collection.TreeBag
(Comparator comparator) Constructs an empty bag that maintains order on its unique representative members according to the givenComparator
. -
Method Summary
Modifier and TypeMethodDescriptionReturns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.first()
Returns the first (lowest) member.last()
Returns the last (highest) member.private void
Read the bag in using a custom routine.private void
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
Methods inherited from interface java.util.Collection
addAll, clear, contains, equals, hashCode, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial version lock- See Also:
-
-
Constructor Details
-
TreeBag
public TreeBag()Constructs an emptyTreeBag
. -
TreeBag
Constructs an empty bag that maintains order on its unique representative members according to the givenComparator
.- Parameters:
comparator
- the comparator to use
-
TreeBag
Constructs aTreeBag
containing all the members of the specified collection.- Parameters:
coll
- the collection to copy into the bag
-
-
Method Details
-
first
Description copied from interface:SortedBag
Returns the first (lowest) member. -
last
Description copied from interface:SortedBag
Returns the last (highest) member. -
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
Write the bag out using a custom routine.- Throws:
IOException
-
readObject
Read the bag in using a custom routine.- Throws:
IOException
ClassNotFoundException
-