Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

TreeBag

extends DefaultMapBag
implements SortedBag

java.lang.Object
↳	org.apache.commons.collections.DefaultMapBag
	↳	org.apache.commons.collections.TreeBag

This class is deprecated.
Moved to bag subpackage and rewritten internally. Due to be removed in v4.0.

Class Overview

A Bag that is backed by a TreeMap. Order will be maintained among the unique representative members.

Summary

Public Constructors
	TreeBag() Constructs an empty `TreeBag`.
	TreeBag(Comparator comparator) Constructs an empty `Bag` that maintains order on its unique representative members according to the given `Comparator`.
	TreeBag(Collection coll) Constructs a `Bag` containing all the members of the given collection.

Public Methods
Comparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
Object	first() Returns the first (lowest) member.
Object	last() Returns the last (highest) member.

[Expand]

Inherited Methods

From class org.apache.commons.collections.DefaultMapBag

boolean	add(Object object, int nCopies) Adds a new element to the bag by incrementing its count in the map.
boolean	add(Object object) Adds a new element to the bag by incrementing its count in the underlying map.
boolean	addAll(Collection coll) Invokes `add(Object)` for each element in the given collection.
int	calcTotalSize() Actually walks the bag to make sure the count is correct and resets the running total
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.
boolean	containsAll(Bag other) Returns `true` if the bag contains all elements in the given collection, respecting cardinality.
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.
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.
Map	getMap() Utility method for implementations to access the map that backs this bag.
int	hashCode() Returns the hash code of the underlying map.
boolean	isEmpty() Returns true if the underlying map is empty.
Iterator	iterator() Returns an `Iterator` over the entire set of members, including copies due to cardinality.
boolean	remove(Object object, int nCopies) Removes `nCopies` copies of the specified object from the Bag.
boolean	remove(Object object) (Violation) Removes all occurrences of the given object from the bag.
boolean	removeAll(Collection coll) (Violation) Remove all elements represented in the given collection, respecting cardinality.
boolean	retainAll(Collection coll) Remove any members of the bag that are not in the given bag, respecting cardinality.
boolean	retainAll(Bag other) Remove any members of the bag that are not in the given bag, respecting cardinality.
void	setMap(Map map) Utility method for implementations to set the map that backs this bag.
int	size() Returns the number of elements in this bag.
Object[]	toArray(Object[] array) Returns an array of all of this bag's elements.
Object[]	toArray() Returns an array of all of this bag's elements.
String	toString() Implement a toString() method suitable for debugging.
Set	uniqueSet() Returns an unmodifiable view of the underlying map's key set.

From class java.lang.Object

From interface java.lang.Iterable

From interface java.util.Collection

abstract boolean	add(E arg0)
abstract boolean	addAll(Collection<? extends E> arg0)
abstract void	clear()
abstract boolean	contains(Object arg0)
abstract boolean	containsAll(Collection<?> arg0)
abstract boolean	equals(Object arg0)
abstract int	hashCode()
abstract boolean	isEmpty()
abstract Iterator<E>	iterator()
abstract boolean	remove(Object arg0)
abstract boolean	removeAll(Collection<?> arg0)
abstract boolean	retainAll(Collection<?> arg0)
abstract int	size()
abstract <T> T[]	toArray(T[] arg0)
abstract Object[]	toArray()

From interface org.apache.commons.collections.Bag

abstract boolean	add(Object object, int nCopies) Adds `nCopies` copies of the specified object to the Bag.
abstract boolean	add(Object object) (Violation) Adds one copy the specified object to the Bag.
abstract boolean	containsAll(Collection coll) (Violation) Returns `true` if the bag contains all elements in the given collection, respecting cardinality.
abstract int	getCount(Object object) Returns the number of occurrences (cardinality) of the given object currently in the bag.
abstract Iterator	iterator() Returns an `Iterator` over the entire set of members, including copies due to cardinality.
abstract boolean	remove(Object object) (Violation) Removes all occurrences of the given object from the bag.
abstract boolean	remove(Object object, int nCopies) Removes `nCopies` copies of the specified object from the Bag.
abstract boolean	removeAll(Collection coll) (Violation) Remove all elements represented in the given collection, respecting cardinality.
abstract boolean	retainAll(Collection coll) (Violation) Remove any members of the bag that are not in the given collection, respecting cardinality.
abstract int	size() Returns the total number of items in the bag across all types.
abstract Set	uniqueSet() Returns a `Set` of unique elements in the Bag.

From interface org.apache.commons.collections.SortedBag

Public Constructors

public TreeBag ()

Constructs an empty TreeBag.

public TreeBag (Comparator comparator)

Constructs an empty Bag that maintains order on its unique representative members according to the given Comparator.

Parameters

comparator	the comparator to use

public TreeBag (Collection coll)

Constructs a Bag containing all the members of the given collection.

Parameters

coll	the collection to copy into the bag

Public Methods

public Comparator comparator ()

Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Returns

the comparator in use, or null if natural ordering

public Object first ()

Returns the first (lowest) member.

Returns

the first element in the sorted bag

public Object last ()

Returns the last (highest) member.

Returns

the last element in the sorted bag

Interfaces

Classes

Exceptions

TreeBag

Class Overview

Summary

Public Constructors

public TreeBag ()

public TreeBag (Comparator comparator)

Parameters

public TreeBag (Collection coll)

Parameters

Public Methods

public Comparator comparator ()

Returns

public Object first ()

Returns

public Object last ()

Returns