Class ForwardingSetMultimap<K extends @Nullable Object, V extends @Nullable Object>

java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMultimap<K,V>
com.google.common.collect.ForwardingSetMultimap<K,V>
All Implemented Interfaces:
Multimap<K,V>, SetMultimap<K,V>
Direct Known Subclasses:
ForwardingSortedSetMultimap
@GwtCompatible public abstract class ForwardingSetMultimap<K extends @Nullable Object, V extends @Nullable Object> extends ForwardingMultimap<K,V> implements SetMultimap<K,V>
A set multimap which forwards all its method calls to another set multimap. Subclasses should override one or more methods to modify the behavior of the backing multimap as desired per the decorator pattern.

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 ForwardingSetMultimap.

Since:
3.0
Author:
Kurt Alfred Kluever

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForwardingSetMultimap()
    Constructor for use by subclasses.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract SetMultimap<K,V>
    delegate()
    Returns the backing delegate instance that methods are forwarded to.
    Set<Map.Entry<K,V>>
    entries()
    Returns a view collection of all key-value pairs contained in this multimap, as Map.Entry instances.
    Set<V>
    get(K key)
    Returns a view collection of the values associated with key in this multimap, if any.
    Set<V>
    removeAll(@Nullable Object key)
    Removes all values associated with the key key.
    Set<V>
    replaceValues(K key, Iterable<? extends V> values)
    Stores a collection of values with the same key, replacing any existing values for that key.

    Methods inherited from class ForwardingMultimap

    asMap, clear, containsEntry, containsKey, containsValue, equals, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, values
    Modifier and Type
    Method
    Description
    Map<K, Collection<V>>
    asMap()
    Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values.
    void
    clear()
    Removes all key-value pairs from the multimap, leaving it empty.
    boolean
    containsEntry(@Nullable Object key, @Nullable Object value)
    Returns true if this multimap contains at least one key-value pair with the key key and the value value.
    boolean
    containsKey(@Nullable Object key)
    Returns true if this multimap contains at least one key-value pair with the key key.
    boolean
    containsValue(@Nullable Object value)
    Returns true if this multimap contains at least one key-value pair with the value value.
    boolean
    equals(@Nullable Object object)
    Compares the specified object with this multimap for equality.
    int
    hashCode()
    Returns the hash code for this multimap.
    boolean
    isEmpty()
    Returns true if this multimap contains no key-value pairs.
    Multiset<K>
    keys()
    Returns a view collection containing the key from each key-value pair in this multimap, without collapsing duplicates.
    Set<K>
    keySet()
    Returns a view collection of all distinct keys contained in this multimap.
    boolean
    put(K key, V value)
    Stores a key-value pair in this multimap.
    boolean
    putAll(Multimap<? extends K, ? extends V> multimap)
    Stores all key-value pairs of multimap in this multimap, in the order returned by multimap.entries().
    boolean
    putAll(K key, Iterable<? extends V> values)
    Stores a key-value pair in this multimap for each of values, all using the same key, key.
    boolean
    remove(@Nullable Object key, @Nullable Object value)
    Removes a single key-value pair with the key key and the value value from this multimap, if such exists.
    int
    size()
    Returns the number of key-value pairs in this multimap.
    Collection<V>
    values()
    Returns a view collection containing the value from each key-value pair contained in this multimap, without collapsing duplicates (so values().size() == size()).

    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 Multimap

    forEach
    Modifier and Type
    Method
    Description
    default void
    forEach(BiConsumer<? super K, ? super V> action)
    Performs the given action for all key-value pairs contained in this multimap.

    Methods inherited from interface SetMultimap

    asMap, equals
    Modifier and Type
    Method
    Description
    Map<K, Collection<V>>
    asMap()
    Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values.
    boolean
    equals(@Nullable Object obj)
    Compares the specified object to this multimap for equality.