SortedBag

implements Bag

org.apache.commons.collections.SortedBag

Known Indirect Subclasses

AbstractSortedBagDecorator, PredicatedSortedBag, SynchronizedSortedBag, TransformedSortedBag, TreeBag, UnmodifiableSortedBag

Class Overview

Defines a type of Bag that maintains a sorted order among its unique representative members.

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

Inherited Methods

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()

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.

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

Returns the first (lowest) member.

Returns the last (highest) member.