com.google.common.collect
Class TreeMultiset<E>

java.lang.Object
  java.util.AbstractCollection<E>
      com.google.common.collect.AbstractMultiset<E>
          com.google.common.collect.TreeMultiset<E>

All Implemented Interfaces:

Multiset<E>, Serializable, Iterable<E>, Collection<E>

public final class TreeMultiset<E>
extends AbstractMultiset<E>

Multiset implementation backed by a TreeMap.

Author:

Neal Kanodia

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.collect.Multiset

Multiset.Entry<E>

Constructor Summary

TreeMultiset()
Constructs a new, empty multiset, sorted according to the elements' natural order.

TreeMultiset(Comparator<? super E> comparator)
Constructs a new, empty multiset, sorted according to the specified comparator.

TreeMultiset(Iterable<? extends E> elements)
Constructs an empty multiset containing the given initial elements, sorted according to the elements' natural order.

Method Summary

boolean	add(E element, int occurrences) Adds a number of occurrences of the specified element to this multiset.
protected Map<E,AtomicInteger>	backingMap()
int	count(Object element) Returns the number of occurrences of the specified element in this multiset.
protected Set<E>	createElementSet() Creates a new instance of this multiset's element set, which will be returned by AbstractMultiset.elementSet.
SortedSet<E>	elementSet() Returns a view of the elements of this multiset as a set. All remove operations on the returned set "write through" to the underlying multiset, removing all occurrences of the given elements. No add operations are supported. Note that you can use elementSet().size() to find the number of distinct elements in this multiset.
Set<Multiset.Entry<E>>	entrySet() Returns the data of this multiset as a set of Entry instances.
Iterator<E>	iterator()
int	remove(Object element, int occurrences) Removes a number of occurrences of the specified element from this multiset.
int	removeAllOccurrences(Object element) Removes all occurrences of the specified element from this multiset.
int	size()

Methods inherited from class com.google.common.collect.AbstractMultiset

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toString

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

toArray, toArray

Constructor Detail

TreeMultiset

public TreeMultiset()

Constructs a new, empty multiset, sorted according to the elements' natural order. All elements inserted into the multiset must implement the Comparable interface. Furthermore, all such elements must be mutually comparable: e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the multiset. If the user attempts to add an element to the multiset that violates this constraint (for example, the user attempts to add a string element to a set whose elements are integers), the add(Object) call will throw a ClassCastException.

See Also:

Comparable, TreeSet

TreeMultiset

public TreeMultiset(Comparator<? super E> comparator)

Constructs a new, empty multiset, sorted according to the specified comparator. All elements inserted into the multiset must be mutually comparable by the specified comparator: comparator.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the multiset. If the user attempts to add an element to the multiset that violates this constraint, the add(Object) call will throw a ClassCastException.

Parameters:

comparator - the comparator that will be used to sort this multiset. A null value indicates that the elements' natural ordering should be used.

TreeMultiset

public TreeMultiset(Iterable<? extends E> elements)

Constructs an empty multiset containing the given initial elements, sorted according to the elements' natural order.

Method Detail

elementSet

public SortedSet<E> elementSet()

Returns a view of the elements of this multiset as a set. All remove operations on the returned set "write through" to the underlying multiset, removing all occurrences of the given elements. No add operations are supported. Note that you can use elementSet().size() to find the number of distinct elements in this multiset.

The returned set's methods are implemented by calling Multiset.entrySet() methods.

In TreeMultiset, the return type of this method is narrowed from Set to SortedSet.

Specified by:

elementSet in interface Multiset<E>

Overrides:

elementSet in class AbstractMultiset<E>

Returns:

the distinct elements of this multiset, viewed as a set

createElementSet

protected Set<E> createElementSet()

Description copied from class: AbstractMultiset

Creates a new instance of this multiset's element set, which will be returned by AbstractMultiset.elementSet.

backingMap

protected Map<E,AtomicInteger> backingMap()

entrySet

public Set<Multiset.Entry<E>> entrySet()

Returns the data of this multiset as a set of Entry instances. This set contains precisely one Entry instance for each distinct element of the multiset. The iteration order of this set is implementation-dependent.

Invoking Multiset.Entry.getCount() on an entry in the returned set always returns the current count of that element in the multiset, as opposed to the count at the time the entry was retrieved.

Specified by:

entrySet in interface Multiset<E>

Specified by:

entrySet in class AbstractMultiset<E>

Returns:

the entries of this multiset, viewed as a set

size

public int size()

Description copied from class: AbstractMultiset

This implementation iterates across Multiset.entrySet() and sums the counts of the entries.

Specified by:

size in interface Collection<E>

Overrides:

size in class AbstractMultiset<E>

iterator

public Iterator<E> iterator()

Description copied from class: AbstractMultiset

This implementation usually invokes methods of the Multiset.entrySet() iterator. As the only exception, the iterator's remove method sometimes calls the multiset's remove.

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Overrides:

iterator in class AbstractMultiset<E>

count

public int count(@Nullable
                 Object element)

Description copied from class: AbstractMultiset

Returns the number of occurrences of the specified element in this multiset.

This implementation iterates across Multiset.entrySet() and sums the count of all entries.

Specified by:

count in interface Multiset<E>

Overrides:

count in class AbstractMultiset<E>

Parameters:

element - the element to look for

Returns:

the nonnegative number of occurrences of the element

See Also:

Iterables.frequency(java.lang.Iterable, java.lang.Object)

add

public boolean add(@Nullable
                   E element,
                   int occurrences)

Adds a number of occurrences of the specified element to this multiset.

This implementation always throws an UnsupportedOperationException. To support adding elements, override it.

Specified by:

add in interface Multiset<E>

Overrides:

add in class AbstractMultiset<E>

Parameters:

element - the element to add

occurrences - the number of occurrences to add

Returns:

true if the collection changed as a result (this should always be the case unless occurrences is zero)

Throws:

IllegalArgumentException - if the call would result in more than Integer.MAX_VALUE occurrences of element in this multiset.

remove

public int remove(@Nullable
                  Object element,
                  int occurrences)

Description copied from class: AbstractMultiset

Removes a number of occurrences of the specified element from this multiset. If the multiset contains fewer than this number of occurrences to begin with, all occurrences will be removed.

This implementation always throws an UnsupportedOperationException. To support removing elements, override it.

Specified by:

remove in interface Multiset<E>

Overrides:

remove in class AbstractMultiset<E>

Parameters:

element - the element whose occurrences should be removed

occurrences - the number of occurrences of this element to remove

Returns:

the number of occurrences that were successfully removed (zero if the element was not present)

removeAllOccurrences

public int removeAllOccurrences(@Nullable
                                Object element)

Description copied from class: AbstractMultiset

Removes all occurrences of the specified element from this multiset. This method complements Multiset.remove(java.lang.Object, int), which removes only one occurrence at a time.

This implementation calls AbstractMultiset.remove(Object, int) with Integer.MAX_VALUE occurrences.

Specified by:

removeAllOccurrences in interface Multiset<E>

Overrides:

removeAllOccurrences in class AbstractMultiset<E>

Parameters:

element - the element whose occurrences should all be removed

Returns:

the number of occurrences successfully removed, possibly zero