Class ForwardingSortedMultiset<E extends @Nullable Object>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<E>

com.google.common.collect.ForwardingMultiset<E>

com.google.common.collect.ForwardingSortedMultiset<E>

All Implemented Interfaces:

Multiset<E>, SortedMultiset<E>, Iterable<E>, Collection<E>

@GwtCompatible
public abstract class ForwardingSortedMultiset<E extends @Nullable Object>
extends ForwardingMultiset<E>
implements SortedMultiset<E>

A sorted multiset which forwards all its method calls to another sorted multiset. Subclasses should override one or more methods to modify the behavior of the backing multiset as desired per the decorator pattern.

Warning: The methods of ForwardingSortedMultiset forward indiscriminately to the methods of the delegate. For example, overriding ForwardingMultiset.add(Object, int) alone will not change the behavior of ForwardingCollection.add(Object), which can lead to unexpected behavior. In this case, you should override add(Object) as well, either providing your own implementation, or delegating to the provided standardAdd method.

default method warning: This class does not forward calls to default methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on the ForwardingSortedMultiset.

The standard methods and any collection views they return are not guaranteed to be thread-safe, even when all of the methods that they depend on are thread-safe.

Since:

15.0

Author:

Louis Wasserman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ForwardingSortedMultiset.StandardDescendingMultiset	A skeleton implementation of a descending multiset view.
protected class	ForwardingSortedMultiset.StandardElementSet	A sensible implementation of SortedMultiset.elementSet() in terms of the following methods: Collection.clear(), SortedMultiset.comparator(), Multiset.contains(Object), Multiset.containsAll(Collection), Multiset.count(Object), SortedMultiset.firstEntry() SortedMultiset.headMultiset(E, BoundType), Collection.isEmpty(), SortedMultiset.lastEntry(), SortedMultiset.subMultiset(E, BoundType, E, BoundType), SortedMultiset.tailMultiset(E, BoundType), the size() and iterator() methods of SortedMultiset.entrySet(), and Multiset.remove(Object, int).

Nested classes/interfaces inherited from interface Multiset

Multiset.Entry<E>

Modifier and Type	Interface	Description
static interface	Multiset.Entry<E extends @Nullable Object>	An unmodifiable element-count pair for a multiset.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingSortedMultiset()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
Comparator<? super E>	comparator()	Returns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.
protected abstract SortedMultiset<E>	delegate()	Returns the backing delegate instance that methods are forwarded to.
SortedMultiset<E>	descendingMultiset()	Returns a descending view of this multiset.
NavigableSet<E>	elementSet()	Returns the set of distinct elements contained in this multiset.
@Nullable Multiset.Entry<E>	firstEntry()	Returns the entry of the first element in this multiset, or null if this multiset is empty.
SortedMultiset<E>	headMultiset(E upperBound, BoundType boundType)	Returns a view of this multiset restricted to the elements less than upperBound, optionally including upperBound itself.
@Nullable Multiset.Entry<E>	lastEntry()	Returns the entry of the last element in this multiset, or null if this multiset is empty.
@Nullable Multiset.Entry<E>	pollFirstEntry()	Returns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.
@Nullable Multiset.Entry<E>	pollLastEntry()	Returns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.
protected @Nullable Multiset.Entry<E>	standardFirstEntry()	A sensible definition of firstEntry() in terms of entrySet().iterator().
protected @Nullable Multiset.Entry<E>	standardLastEntry()	A sensible definition of lastEntry() in terms of descendingMultiset().entrySet().iterator().
protected @Nullable Multiset.Entry<E>	standardPollFirstEntry()	A sensible definition of pollFirstEntry() in terms of entrySet().iterator().
protected @Nullable Multiset.Entry<E>	standardPollLastEntry()	A sensible definition of pollLastEntry() in terms of descendingMultiset().entrySet().iterator().
protected SortedMultiset<E>	standardSubMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)	A sensible definition of subMultiset(Object, BoundType, Object, BoundType) in terms of headMultiset and tailMultiset.
SortedMultiset<E>	subMultiset(E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType)	Returns a view of this multiset restricted to the range between lowerBound and upperBound.
SortedMultiset<E>	tailMultiset(E lowerBound, BoundType boundType)	Returns a view of this multiset restricted to the elements greater than lowerBound, optionally including lowerBound itself.

Methods inherited from class ForwardingMultiset

add, count, entrySet, equals, hashCode, remove, setCount, setCount, standardAdd, standardAddAll, standardClear, standardContains, standardCount, standardEquals, standardHashCode, standardIterator, standardRemove, standardRemoveAll, standardRetainAll, standardSetCount, standardSetCount, standardSize, standardToString

Modifier and Type	Method	Description
int	add(E element, int occurrences)	Adds a number of occurrences of an element to this multiset.
int	count(@Nullable Object element)	Returns the number of occurrences of an element in this multiset (the count of the element).
Set<Multiset.Entry<E>>	entrySet()	Returns a view of the contents of this multiset, grouped into Multiset.Entry instances, each providing an element of the multiset and the count of that element.
boolean	equals(@Nullable Object object)	Compares the specified object with this multiset for equality.
int	hashCode()	Returns the hash code for this multiset.
int	remove(@Nullable Object element, int occurrences)	Removes a number of occurrences of the specified element from this multiset.
int	setCount(E element, int count)	Adds or removes the necessary occurrences of an element such that the element attains the desired count.
boolean	setCount(E element, int oldCount, int newCount)	Conditionally sets the count of an element to a new value, as described in Multiset.setCount(Object, int), provided that the element has the expected current count.
protected boolean	standardAdd(E element)	A sensible definition of ForwardingCollection.add(Object) in terms of ForwardingMultiset.add(Object, int).
protected boolean	standardAddAll(Collection<? extends E> elementsToAdd)	A sensible definition of ForwardingCollection.addAll(Collection) in terms of ForwardingCollection.add(Object) and ForwardingMultiset.add(Object, int).
protected void	standardClear()	A sensible definition of ForwardingCollection.clear() in terms of the iterator method of ForwardingMultiset.entrySet().
protected boolean	standardContains(@Nullable Object object)	A sensible definition of ForwardingCollection.contains(Object) in terms of ForwardingMultiset.count(Object).
protected int	standardCount(@Nullable Object object)	A sensible, albeit inefficient, definition of ForwardingMultiset.count(Object) in terms of ForwardingMultiset.entrySet().
protected boolean	standardEquals(@Nullable Object object)	A sensible, albeit inefficient, definition of ForwardingMultiset.equals(Object) in terms of entrySet().size() and ForwardingMultiset.count(Object).
protected int	standardHashCode()	A sensible definition of ForwardingMultiset.hashCode() as entrySet().hashCode() .
protected Iterator<E>	standardIterator()	A sensible definition of ForwardingCollection.iterator() in terms of ForwardingMultiset.entrySet() and ForwardingCollection.remove(Object).
protected boolean	standardRemove(@Nullable Object element)	A sensible definition of ForwardingCollection.remove(Object) in terms of ForwardingMultiset.remove(Object, int).
protected boolean	standardRemoveAll(Collection<?> elementsToRemove)	A sensible definition of ForwardingCollection.removeAll(Collection) in terms of the removeAll method of ForwardingMultiset.elementSet().
protected boolean	standardRetainAll(Collection<?> elementsToRetain)	A sensible definition of ForwardingCollection.retainAll(Collection) in terms of the retainAll method of ForwardingMultiset.elementSet().
protected int	standardSetCount(E element, int count)	A sensible definition of ForwardingMultiset.setCount(Object, int) in terms of ForwardingMultiset.count(Object), ForwardingMultiset.add(Object, int), and ForwardingMultiset.remove(Object, int).
protected boolean	standardSetCount(E element, int oldCount, int newCount)	A sensible definition of ForwardingMultiset.setCount(Object, int, int) in terms of ForwardingMultiset.count(Object) and ForwardingMultiset.setCount(Object, int).
protected int	standardSize()	A sensible, albeit inefficient, definition of ForwardingCollection.size() in terms of ForwardingMultiset.entrySet().
protected String	standardToString()	A sensible definition of ForwardingObject.toString() as entrySet().toString() .

Methods inherited from class ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardContainsAll, standardIsEmpty, standardToArray, standardToArray, toArray, toArray

Modifier and Type	Method	Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> collection)
void	clear()
boolean	contains(@Nullable Object object)
boolean	containsAll(Collection<?> collection)
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(@Nullable Object object)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
int	size()
protected boolean	standardContainsAll(Collection<?> collection)	A sensible definition of ForwardingCollection.containsAll(Collection) in terms of ForwardingCollection.contains(Object) .
protected boolean	standardIsEmpty()	A sensible definition of ForwardingCollection.isEmpty() as !iterator().hasNext.
protected @Nullable Object[]	standardToArray()	A sensible definition of ForwardingCollection.toArray() in terms of ForwardingCollection.toArray(Object[]).
protected <T extends @Nullable Object> T[]	standardToArray(T[] array)	A sensible definition of ForwardingCollection.toArray(Object[]) in terms of ForwardingCollection.size() and ForwardingCollection.iterator().
@Nullable Object[]	toArray()
<T extends @Nullable Object> T[]	toArray(T[] array)

Methods inherited from class ForwardingObject

toString

Modifier and Type	Method	Description
String	toString()	Returns the string representation generated by the delegate's toString method.

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface Multiset

add, contains, containsAll, remove, removeAll, retainAll, size, toString

Modifier and Type	Method	Description
boolean	add(E element)	Adds a single occurrence of the specified element to this multiset.
boolean	contains(@Nullable Object element)	Determines whether this multiset contains the specified element.
boolean	containsAll(Collection<?> elements)	Returns true if this multiset contains at least one occurrence of each element in the specified collection.
boolean	remove(@Nullable Object element)	Removes a single occurrence of the specified element from this multiset, if present.
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()	Returns the total number of all occurrences of all elements in this multiset.
String	toString()

Methods inherited from interface SortedMultiset

entrySet, iterator

Modifier and Type	Method	Description
Set<Multiset.Entry<E>>	entrySet()	Returns a view of the contents of this multiset, grouped into Multiset.Entry instances, each providing an element of the multiset and the count of that element.
Iterator<E>	iterator()

Constructor Details

ForwardingSortedMultiset

protected ForwardingSortedMultiset()

Constructor for use by subclasses.

Method Details

delegate

protected abstract SortedMultiset<E> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingMultiset<E extends @Nullable Object>

elementSet

public NavigableSet<E> elementSet()

Description copied from interface: Multiset

Returns the set of distinct elements contained in this multiset. The element set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. The order of the elements in the element set is unspecified.

If the element set supports any removal operations, these necessarily cause all occurrences of the removed element(s) to be removed from the multiset. Implementations are not expected to support the add operations, although this is possible.

A common use for the element set is to find the number of distinct elements in the multiset: elementSet().size().

Specified by:

elementSet in interface Multiset<E extends @Nullable Object>

Specified by:

elementSet in interface SortedMultiset<E extends @Nullable Object>

Overrides:

elementSet in class ForwardingMultiset<E extends @Nullable Object>

Returns:

a view of the set of distinct elements in this multiset

comparator

public Comparator<? super E> comparator()

Description copied from interface: SortedMultiset

Returns the comparator that orders this multiset, or Ordering.natural() if the natural ordering of the elements is used.

Specified by:

comparator in interface SortedMultiset<E extends @Nullable Object>

descendingMultiset

public SortedMultiset<E> descendingMultiset()

Description copied from interface: SortedMultiset

Returns a descending view of this multiset. Modifications made to either map will be reflected in the other.

Specified by:

descendingMultiset in interface SortedMultiset<E extends @Nullable Object>

firstEntry

public @Nullable Multiset.Entry<E> firstEntry()

Description copied from interface: SortedMultiset

Returns the entry of the first element in this multiset, or null if this multiset is empty.

Specified by:

firstEntry in interface SortedMultiset<E extends @Nullable Object>

standardFirstEntry

protected @Nullable Multiset.Entry<E> standardFirstEntry()

A sensible definition of firstEntry() in terms of entrySet().iterator().

If you override ForwardingMultiset.entrySet(), you may wish to override firstEntry() to forward to this implementation.

lastEntry

public @Nullable Multiset.Entry<E> lastEntry()

Description copied from interface: SortedMultiset

Returns the entry of the last element in this multiset, or null if this multiset is empty.

Specified by:

lastEntry in interface SortedMultiset<E extends @Nullable Object>

standardLastEntry

protected @Nullable Multiset.Entry<E> standardLastEntry()

A sensible definition of lastEntry() in terms of descendingMultiset().entrySet().iterator().

If you override descendingMultiset() or ForwardingMultiset.entrySet(), you may wish to override firstEntry() to forward to this implementation.

pollFirstEntry

public @Nullable Multiset.Entry<E> pollFirstEntry()

Description copied from interface: SortedMultiset

Returns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.

Specified by:

pollFirstEntry in interface SortedMultiset<E extends @Nullable Object>

standardPollFirstEntry

protected @Nullable Multiset.Entry<E> standardPollFirstEntry()

A sensible definition of pollFirstEntry() in terms of entrySet().iterator().

If you override ForwardingMultiset.entrySet(), you may wish to override pollFirstEntry() to forward to this implementation.

pollLastEntry

public @Nullable Multiset.Entry<E> pollLastEntry()

Description copied from interface: SortedMultiset

Returns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.

Specified by:

pollLastEntry in interface SortedMultiset<E extends @Nullable Object>

standardPollLastEntry

protected @Nullable Multiset.Entry<E> standardPollLastEntry()

A sensible definition of pollLastEntry() in terms of descendingMultiset().entrySet().iterator().

If you override descendingMultiset() or ForwardingMultiset.entrySet(), you may wish to override pollLastEntry() to forward to this implementation.

headMultiset

public SortedMultiset<E> headMultiset(E upperBound,
 BoundType boundType)

Description copied from interface: SortedMultiset

Returns a view of this multiset restricted to the elements less than upperBound, optionally including upperBound itself. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

Specified by:

headMultiset in interface SortedMultiset<E extends @Nullable Object>

subMultiset

public SortedMultiset<E> subMultiset(E lowerBound,
 BoundType lowerBoundType,
 E upperBound,
 BoundType upperBoundType)

Description copied from interface: SortedMultiset

Returns a view of this multiset restricted to the range between lowerBound and upperBound. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

This method is equivalent to tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType).

Specified by:

subMultiset in interface SortedMultiset<E extends @Nullable Object>

standardSubMultiset

protected SortedMultiset<E> standardSubMultiset(E lowerBound,
 BoundType lowerBoundType,
 E upperBound,
 BoundType upperBoundType)

A sensible definition of subMultiset(Object, BoundType, Object, BoundType) in terms of headMultiset and tailMultiset.

If you override either of these methods, you may wish to override subMultiset(Object, BoundType, Object, BoundType) to forward to this implementation.

tailMultiset

public SortedMultiset<E> tailMultiset(E lowerBound,
 BoundType boundType)

Description copied from interface: SortedMultiset

Returns a view of this multiset restricted to the elements greater than lowerBound, optionally including lowerBound itself. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

Specified by:

tailMultiset in interface SortedMultiset<E extends @Nullable Object>