Class ForwardingSortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>

  • All Implemented Interfaces:
    Multimap<K,​V>, SetMultimap<K,​V>, SortedSetMultimap<K,​V>

    @GwtCompatible
    public abstract class ForwardingSortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
    extends ForwardingSetMultimap<K,​V>
    implements SortedSetMultimap<K,​V>
    A sorted set multimap which forwards all its method calls to another sorted 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 ForwardingSortedSetMultimap.

    Since:
    3.0
    Author:
    Kurt Alfred Kluever
    • Method Detail

      • delegate

        protected abstract SortedSetMultimap<K,​Vdelegate()
        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 ForwardingSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • get

        public java.util.SortedSet<Vget​(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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        get in interface SetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        get in interface SortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        get in class ForwardingSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • removeAll

        public java.util.SortedSet<VremoveAll​(@Nullable java.lang.Object 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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        removeAll in interface SetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        removeAll in interface SortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        removeAll in class ForwardingSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        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 java.util.SortedSet<VreplaceValues​(K key,
                                                    java.lang.Iterable<? 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 extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        replaceValues in interface SetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Specified by:
        replaceValues in interface SortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        Overrides:
        replaceValues in class ForwardingSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
        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.
      • valueComparator

        public @Nullable java.util.Comparator<? super VvalueComparator()
        Description copied from interface: SortedSetMultimap
        Returns the comparator that orders the multimap values, with null indicating that natural ordering is used.
        Specified by:
        valueComparator in interface SortedSetMultimap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>