org.apache.commons.collections
Class TreeBag

java.lang.Object
  |
  +--org.apache.commons.collections.DefaultMapBag
        |
        +--org.apache.commons.collections.TreeBag
All Implemented Interfaces:
Bag, java.util.Collection, SortedBag

public class TreeBag
extends DefaultMapBag
implements SortedBag, Bag

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

Since:
2.0
Author:
Chuck Burdick

Constructor Summary
TreeBag()
          Constructs a new empty TreeBag.
TreeBag(java.util.Collection c)
          New Bag containing all the members of the given collection.
TreeBag(java.util.Comparator c)
          New Bag that maintains order on its unique representative members according to the given Comparator.
 
Method Summary
 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.
 
Methods inherited from class org.apache.commons.collections.DefaultMapBag
add, add, addAll, clear, contains, containsAll, containsAll, equals, getCount, hashCode, isEmpty, iterator, remove, remove, removeAll, retainAll, retainAll, size, toArray, toArray, toString, uniqueSet
 
Methods inherited from class java.lang.Object
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, toArray, toArray
 

Constructor Detail

TreeBag

public TreeBag()
Constructs a new empty TreeBag.


TreeBag

public TreeBag(java.util.Comparator c)
New Bag that maintains order on its unique representative members according to the given Comparator.


TreeBag

public TreeBag(java.util.Collection c)
New Bag containing all the members of the given collection.

See Also:
DefaultMapBag.addAll(java.util.Collection)
Method Detail

first

public java.lang.Object first()
Description copied from interface: SortedBag
Returns the first (lowest) member.

Specified by:
first in interface SortedBag

last

public java.lang.Object last()
Description copied from interface: SortedBag
Returns the last (highest) member.

Specified by:
last in interface SortedBag

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 interface SortedBag


Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved.