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

  • All Implemented Interfaces:
    java.util.Map<K,​V>, java.util.SortedMap<K,​V>
    Direct Known Subclasses:
    ForwardingNavigableMap

    @GwtCompatible
    public abstract class ForwardingSortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
    extends ForwardingMap<K,​V>
    implements java.util.SortedMap<K,​V>
    A sorted map which forwards all its method calls to another sorted map. Subclasses should override one or more methods to modify the behavior of the backing sorted map as desired per the decorator pattern.

    Warning: The methods of ForwardingSortedMap forward indiscriminately to the methods of the delegate. For example, overriding ForwardingMap.put(K, V) alone will not change the behavior of ForwardingMap.putAll(java.util.Map<? extends K, ? extends V>), which can lead to unexpected behavior. In this case, you should override putAll as well, either providing your own implementation, or delegating to the provided standardPutAll 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 ForwardingSortedMap.

    Each of the standard methods, where appropriate, use the comparator of the map to test equality for both keys and values, unlike ForwardingMap.

    The standard methods and the 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:
    2.0
    Author:
    Mike Bostock, Louis Wasserman
    • Constructor Detail

    • Method Detail

      • delegate

        protected abstract java.util.SortedMap<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 ForwardingMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • comparator

        @CheckForNull
        public java.util.Comparator<? super Kcomparator()
        Specified by:
        comparator in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • firstKey

        public K firstKey()
        Specified by:
        firstKey in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • headMap

        public java.util.SortedMap<K,​VheadMap​(K toKey)
        Specified by:
        headMap in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • lastKey

        public K lastKey()
        Specified by:
        lastKey in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • subMap

        public java.util.SortedMap<K,​VsubMap​(K fromKey,
                                                     K toKey)
        Specified by:
        subMap in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>
      • tailMap

        public java.util.SortedMap<K,​VtailMap​(K fromKey)
        Specified by:
        tailMap in interface java.util.SortedMap<K extends @Nullable java.lang.Object,​V extends @Nullable java.lang.Object>