org.apache.commons.collections.bag

Class TreeBag

Implemented Interfaces:
Bag, Collection, Serializable, Bag, SortedBag

public class TreeBag
extends AbstractMapBag
implements SortedBag, Serializable

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.

Version:
$Revision: 1.9 $ $Date: 2004/02/18 00:56:25 $
Authors:
Chuck Burdick
Stephen Colebourne
Since:
Commons Collections 3.0 (previously in main package v2.0)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections.bag.AbstractMapBag

AbstractMapBag.MutableInteger

Constructor Summary

TreeBag()
Constructs an empty TreeBag.
TreeBag(Collection coll)
Constructs a TreeBag 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 given Comparator.

Method Summary

Comparator
comparator()
Object
first()
Object
last()

Methods inherited from class org.apache.commons.collections.bag.AbstractMapBag

add, add, addAll, clear, contains, containsAll, doReadObject, doWriteObject, equals, getCount, getMap, hashCode, isEmpty, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray, toString, uniqueSet

Constructor Details

TreeBag

public TreeBag()
Constructs an empty TreeBag.

TreeBag

public TreeBag(Collection coll)
Constructs a TreeBag containing all the members of the specified collection.
Parameters:
coll - the collection to copy into the bag

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

Method Details

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedBag

first

public Object first()
Specified by:
first in interface SortedBag

last

public Object last()
Specified by:
last in interface SortedBag

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.