ForwardingMultiset (Google Collections Library

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingCollection<E>
          com.google.common.collect.ForwardingMultiset<E>

All Implemented Interfaces:: Multiset<E>, Serializable, Iterable<E>, Collection<E>

Direct Known Subclasses:: LinkedListMultiset

public abstract class ForwardingMultiset<E>
extends ForwardingCollection<E>
implements Multiset<E>
extends ForwardingCollection<E>
implements Multiset<E>

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

Author:: Kevin Bourrillion
See Also:: ForwardingObject, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.collect.Multiset
`Multiset.Entry<E>`

Constructor Summary
`protected`	`ForwardingMultiset(Multiset<E> delegate)`

Method Summary
`boolean`	`add(E element, int occurrences)` Adds a number of occurrences of the specified element to this multiset.
`int`	`count(Object element)` Returns the number of occurrences of the specified element in this multiset.
`protected Multiset<E>`	`delegate()` Returns the backing delegate object.
`Set<E>`	`elementSet()` Returns a view of the elements of this multiset as a set.
`Set<Multiset.Entry<E>>`	`entrySet()` Returns the data of this multiset as a set of `Entry` instances.
`boolean`	`equals(Object obj)` Compares the specified object with this multiset for equality.
`int`	`hashCode()` Returns the hash code for this multiset.
`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.

Methods inherited from class com.google.common.collect.ForwardingCollection
`add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray`

Methods inherited from class com.google.common.collect.ForwardingObject
`toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface java.util.Collection
`add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray`

Constructor Detail

ForwardingMultiset

protected ForwardingMultiset(Multiset<E> delegate)

Method Detail

delegate

protected Multiset<E> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate object. This method should be overridden to specify the correct return type. For example:

  @SuppressWarnings("unchecked")
  @Override protected Foo delegate() {
    return (Foo) super.delegate();
  }

This method should always return the same delegate instance that was passed to the constructor.

Overrides:: delegate in class ForwardingCollection<E>