Package com.google.common.collect

Class ForwardingSetMultimap<K,​V>

  • All Implemented Interfaces:
    Multimap<K,​V>, SetMultimap<K,​V>
    Direct Known Subclasses:
    ForwardingSortedSetMultimap
    @GwtCompatible
public abstract class ForwardingSetMultimap<K,​V>
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 .

    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

    • Method Detail

      • delegate

        protected abstract SetMultimap<K,​V> 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 ForwardingMultimap<K,​V>

      • entries

        public <<K,​V>> entries()
        Description copied from interface: Multimap
        Returns a view collection of all key-value pairs contained in this multimap, as instances.

        Changes to the returned collection or the entries it contains will update the underlying multimap, and vice versa. However, adding to the returned collection is not possible.

        Specified by:
        entries in interface Multimap<K,​V>
        Specified by:
        entries in interface SetMultimap<K,​V>
        Overrides:
        entries in class ForwardingMultimap<K,​V>

      • get

        public < K key)
        Description copied from interface: Multimap
        Returns a view collection of the values associated with key in this multimap, if any. Note that when containsKey(key) is false, this returns an empty collection, not null.

        Changes to the returned collection will update the underlying multimap, and vice versa.

        Specified by:
        get in interface Multimap<K,​V>
        Specified by:
        get in interface SetMultimap<K,​V>
        Overrides:
        get in class ForwardingMultimap<K,​V>

      • removeAll

        public <  key)
        Description copied from interface: Multimap
        Removes all values associated with the key key.

        Once this method returns, key will not be mapped to any values, so it will not appear in Multimap.keySet(), Multimap.asMap(), or any other views.

        Specified by:
        removeAll in interface Multimap<K,​V>
        Specified by:
        removeAll in interface SetMultimap<K,​V>
        Overrides:
        removeAll in class ForwardingMultimap<K,​V>
        Returns:
        the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.

      • replaceValues

        public <V> replaceValues​(K key,
                            <? extends V> values)
        Description copied from interface: Multimap
        Stores a collection of values with the same key, replacing any existing values for that key.

        If values is empty, this is equivalent to removeAll(key).

        Specified by:
        replaceValues in interface Multimap<K,​V>
        Specified by:
        replaceValues in interface SetMultimap<K,​V>
        Overrides:
        replaceValues in class ForwardingMultimap<K,​V>
        Returns:
        the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.