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
@Deprecated(since="2021-04-30") public class TreeBag extends AbstractMapBag implements SortedBag, Serializable
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.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)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TreeBag()
Deprecated.Constructs an emptyTreeBag
.TreeBag(Collection coll)
Deprecated.Constructs aTreeBag
containing all the members of the specified collection.TreeBag(Comparator comparator)
Deprecated.Constructs an empty bag that maintains order on its unique representative members according to the givenComparator
.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Comparator
comparator()
Deprecated.Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.Object
first()
Deprecated.Returns the first (lowest) member.Object
last()
Deprecated.Returns the last (highest) member.-
Methods inherited from class org.apache.commons.collections.bag.AbstractMapBag
add, add, addAll, clear, contains, containsAll, equals, getCount, hashCode, isEmpty, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray, toString, uniqueSet
-
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, toArray
-
-
-
-
Constructor Detail
-
TreeBag
public TreeBag()
Deprecated.Constructs an emptyTreeBag
.
-
TreeBag
public TreeBag(Comparator comparator)
Deprecated.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(Collection coll)
Deprecated.Constructs aTreeBag
containing all the members of the specified collection.- Parameters:
coll
- the collection to copy into the bag
-
-
Method Detail
-
first
public Object first()
Deprecated.Description copied from interface:SortedBag
Returns the first (lowest) member.
-
last
public Object last()
Deprecated.Description copied from interface:SortedBag
Returns the last (highest) member.
-
comparator
public Comparator comparator()
Deprecated.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
-
-