Package com.google.common.collect

Class ForwardingNavigableMap<K,​V>

  • All Implemented Interfaces:
    java.util.Map<K,​V>, java.util.NavigableMap<K,​V>, java.util.SortedMap<K,​V>
    public abstract class ForwardingNavigableMap<K,​V>
extends ForwardingSortedMap<K,​V>
implements java.util.NavigableMap<K,​V>
    A navigable map which forwards all its method calls to another navigable map. Subclasses should override one or more methods to modify the behavior of the backing map as desired per the decorator pattern.

    Warning: The methods of ForwardingNavigableMap 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.

    Each of the standard methods uses the map's comparator (or the natural ordering of the elements, if there is no comparator) to test element equality. As a result, if the comparator is not consistent with equals, some of the standard implementations may violate the Map contract.

    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:
    12.0

    • Method Detail

      • lowerEntry

        public java.util.Map.Entry<K,​V> lowerEntry​(K key)
        Specified by:
        lowerEntry in interface java.util.NavigableMap<K,​V>

      • lowerKey

        public K lowerKey​(K key)
        Specified by:
        lowerKey in interface java.util.NavigableMap<K,​V>

      • floorEntry

        public java.util.Map.Entry<K,​V> floorEntry​(K key)
        Specified by:
        floorEntry in interface java.util.NavigableMap<K,​V>

      • floorKey

        public K floorKey​(K key)
        Specified by:
        floorKey in interface java.util.NavigableMap<K,​V>

      • ceilingEntry

        public java.util.Map.Entry<K,​V> ceilingEntry​(K key)
        Specified by:
        ceilingEntry in interface java.util.NavigableMap<K,​V>

      • ceilingKey

        public K ceilingKey​(K key)
        Specified by:
        ceilingKey in interface java.util.NavigableMap<K,​V>

      • higherEntry

        public java.util.Map.Entry<K,​V> higherEntry​(K key)
        Specified by:
        higherEntry in interface java.util.NavigableMap<K,​V>

      • higherKey

        public K higherKey​(K key)
        Specified by:
        higherKey in interface java.util.NavigableMap<K,​V>

      • firstEntry

        public java.util.Map.Entry<K,​V> firstEntry()
        Specified by:
        firstEntry in interface java.util.NavigableMap<K,​V>

      • lastEntry

        public java.util.Map.Entry<K,​V> lastEntry()
        Specified by:
        lastEntry in interface java.util.NavigableMap<K,​V>

      • pollFirstEntry

        public java.util.Map.Entry<K,​V> pollFirstEntry()
        Specified by:
        pollFirstEntry in interface java.util.NavigableMap<K,​V>

      • pollLastEntry

        public java.util.Map.Entry<K,​V> pollLastEntry()
        Specified by:
        pollLastEntry in interface java.util.NavigableMap<K,​V>

      • descendingMap

        public java.util.NavigableMap<K,​V> descendingMap()
        Specified by:
        descendingMap in interface java.util.NavigableMap<K,​V>

      • navigableKeySet

        public java.util.NavigableSet<K> navigableKeySet()
        Specified by:
        navigableKeySet in interface java.util.NavigableMap<K,​V>

      • descendingKeySet

        public java.util.NavigableSet<K> descendingKeySet()
        Specified by:
        descendingKeySet in interface java.util.NavigableMap<K,​V>

      • subMap

        public java.util.NavigableMap<K,​V> subMap​(K fromKey,
                                                boolean fromInclusive,
                                                K toKey,
                                                boolean toInclusive)
        Specified by:
        subMap in interface java.util.NavigableMap<K,​V>

      • headMap

        public java.util.NavigableMap<K,​V> headMap​(K toKey,
                                                 boolean inclusive)
        Specified by:
        headMap in interface java.util.NavigableMap<K,​V>

      • tailMap

        public java.util.NavigableMap<K,​V> tailMap​(K fromKey,
                                                 boolean inclusive)
        Specified by:
        tailMap in interface java.util.NavigableMap<K,​V>