Package com.google.common.collect

Class ForwardingNavigableMap.StandardDescendingMap

    • Method Detail

      • replaceAll

        public void replaceAll​(BiFunction<? super K,​? super V,​? extends V> function)
        Description copied from interface: java.util.Map
        Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.
        Parameters:
        function - the function to apply to each entry

      • delegate

        protected final Map<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 ForwardingMap<K extends @Nullable Object,​V extends @Nullable Object>

      • lowerEntry

        @CheckForNull
public Map.Entry<K,​V> lowerEntry​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
        Specified by:
        lowerEntry in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        an entry with the greatest key less than key, or null if there is no such key

      • floorEntry

        @CheckForNull
public Map.Entry<K,​V> floorEntry​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns a key-value mapping associated with the greatest key less than or equal to the given key, or null if there is no such key.
        Specified by:
        floorEntry in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        an entry with the greatest key less than or equal to key, or null if there is no such key

      • floorKey

        @CheckForNull
public K floorKey​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns the greatest key less than or equal to the given key, or null if there is no such key.
        Specified by:
        floorKey in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        the greatest key less than or equal to key, or null if there is no such key

      • ceilingEntry

        @CheckForNull
public Map.Entry<K,​V> ceilingEntry​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns a key-value mapping associated with the least key greater than or equal to the given key, or null if there is no such key.
        Specified by:
        ceilingEntry in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        an entry with the least key greater than or equal to key, or null if there is no such key

      • ceilingKey

        @CheckForNull
public K ceilingKey​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns the least key greater than or equal to the given key, or null if there is no such key.
        Specified by:
        ceilingKey in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        the least key greater than or equal to key, or null if there is no such key

      • higherEntry

        @CheckForNull
public Map.Entry<K,​V> higherEntry​(K key)
        Description copied from interface: java.util.NavigableMap
        Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
        Specified by:
        higherEntry in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        key - the key
        Returns:
        an entry with the least key greater than key, or null if there is no such key

      • descendingMap

        public NavigableMap<K,​V> descendingMap()
        Description copied from interface: java.util.NavigableMap
        Returns a reverse order view of the mappings contained in this map. The descending map is backed by this map, so changes to the map are reflected in the descending map, and vice-versa. If either map is modified while an iteration over a collection view of either map is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

        The returned map has an ordering equivalent to Collections.reverseOrder(comparator()). The expression m.descendingMap().descendingMap() returns a view of m essentially equivalent to m.

        Specified by:
        descendingMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a reverse order view of this map

      • entrySet

        public Set<Map.Entry<K,​V>> entrySet()
        Description copied from interface: java.util.Map
        Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        entrySet in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        entrySet in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        entrySet in class ForwardingMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a set view of the mappings contained in this map

      • keySet

        public Set<K> keySet()
        Description copied from interface: java.util.Map
        Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
        Specified by:
        keySet in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        keySet in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        keySet in class ForwardingMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a set view of the keys contained in this map

      • navigableKeySet

        public NavigableSet<K> navigableKeySet()
        Description copied from interface: java.util.NavigableMap
        Returns a NavigableSet view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
        Specified by:
        navigableKeySet in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a navigable set view of the keys in this map

      • descendingKeySet

        public NavigableSet<K> descendingKeySet()
        Description copied from interface: java.util.NavigableMap
        Returns a reverse order NavigableSet view of the keys contained in this map. The set's iterator returns the keys in descending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
        Specified by:
        descendingKeySet in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a reverse order navigable set view of the keys in this map

      • subMap

        public NavigableMap<K,​V> subMap​(K fromKey,
                                      boolean fromInclusive,
                                      K toKey,
                                      boolean toInclusive)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys range from fromKey to toKey. If fromKey and toKey are equal, the returned map is empty unless fromInclusive and toInclusive are both true. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside of its range, or to construct a submap either of whose endpoints lie outside its range.

        Specified by:
        subMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        fromKey - low endpoint of the keys in the returned map
        fromInclusive - true if the low endpoint is to be included in the returned view
        toKey - high endpoint of the keys in the returned map
        toInclusive - true if the high endpoint is to be included in the returned view
        Returns:
        a view of the portion of this map whose keys range from fromKey to toKey

      • subMap

        public SortedMap<K,​V> subMap​(K fromKey,
                                   K toKey)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

        Equivalent to subMap(fromKey, true, toKey, false).

        Specified by:
        subMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        subMap in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        fromKey - low endpoint (inclusive) of the keys in the returned map
        toKey - high endpoint (exclusive) of the keys in the returned map
        Returns:
        a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive

      • headMap

        public NavigableMap<K,​V> headMap​(K toKey,
                                       boolean inclusive)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

        Specified by:
        headMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        toKey - high endpoint of the keys in the returned map
        inclusive - true if the high endpoint is to be included in the returned view
        Returns:
        a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey

      • headMap

        public SortedMap<K,​V> headMap​(K toKey)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys are strictly less than toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

        Equivalent to headMap(toKey, false).

        Specified by:
        headMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        headMap in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        toKey - high endpoint (exclusive) of the keys in the returned map
        Returns:
        a view of the portion of this map whose keys are strictly less than toKey

      • tailMap

        public NavigableMap<K,​V> tailMap​(K fromKey,
                                       boolean inclusive)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

        Specified by:
        tailMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        fromKey - low endpoint of the keys in the returned map
        inclusive - true if the low endpoint is to be included in the returned view
        Returns:
        a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey

      • tailMap

        public SortedMap<K,​V> tailMap​(K fromKey)
        Description copied from interface: java.util.NavigableMap
        Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

        The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

        Equivalent to tailMap(fromKey, true).

        Specified by:
        tailMap in interface NavigableMap<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        tailMap in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Parameters:
        fromKey - low endpoint (inclusive) of the keys in the returned map
        Returns:
        a view of the portion of this map whose keys are greater than or equal to fromKey

      • values

        public Collection<V> values()
        Description copied from interface: java.util.Map
        Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        values in interface Map<K extends @Nullable Object,​V extends @Nullable Object>
        Specified by:
        values in interface SortedMap<K extends @Nullable Object,​V extends @Nullable Object>
        Overrides:
        values in class ForwardingMap<K extends @Nullable Object,​V extends @Nullable Object>
        Returns:
        a collection view of the values contained in this map

      • toString

        public String toString()
        Description copied from class: ForwardingObject
        Returns the string representation generated by the delegate's toString method.
        Overrides:
        toString in class ForwardingObject
        Returns:
        a string representation of the object.