RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/NavigableMap.html below:

NavigableMap (Java SE 11 & JDK 11 )

- Nested Class Summary
  - Nested classes/interfaces declared in interface java.util.MapMap.Entry<K,V>
- Method Summary All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map.Entry<K,V> ceilingEntry(K key)
  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.
  K ceilingKey(K key)
  Returns the least key greater than or equal to the given key, or null if there is no such key.
  NavigableSet<K> descendingKeySet()
  Returns a reverse order
  NavigableSet
  view of the keys contained in this map.
  NavigableMap<K,V> descendingMap()
  Returns a reverse order view of the mappings contained in this map.
  Map.Entry<K,V> firstEntry()
  Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
  Map.Entry<K,V> floorEntry(K key)
  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.
  K floorKey(K key)
  Returns the greatest key less than or equal to the given key, or null if there is no such key.
  SortedMap<K,V> headMap(K toKey)
  Returns a view of the portion of this map whose keys are strictly less than toKey.
  NavigableMap<K,V> headMap(K toKey, boolean inclusive)
  Returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey.
  Map.Entry<K,V> higherEntry(K key)
  Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
  K higherKey(K key)
  Returns the least key strictly greater than the given key, or null if there is no such key.
  Map.Entry<K,V> lastEntry()
  Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
  Map.Entry<K,V> lowerEntry(K key)
  Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
  K lowerKey(K key)
  Returns the greatest key strictly less than the given key, or null if there is no such key.
  NavigableSet<K> navigableKeySet()
  Returns a
  NavigableSet
  view of the keys contained in this map.
  Map.Entry<K,V> pollFirstEntry()
  Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
  Map.Entry<K,V> pollLastEntry()
  Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
  NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
  Returns a view of the portion of this map whose keys range from fromKey to toKey.
  SortedMap<K,V> subMap(K fromKey, K toKey)
  Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
  SortedMap<K,V> tailMap(K fromKey)
  Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
  NavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
  Returns a view of the portion of this map whose keys are greater than (or equal to, if inclusive is true) fromKey.
  - Methods declared in interface java.util.Mapclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
  - Methods declared in interface java.util.SortedMapcomparator, entrySet, firstKey, keySet, lastKey, values

- Method Detail
  - lowerEntry
```
Map.Entry<K,V> lowerEntry(K key)
```
    Returns a key-value mapping associated with the greatest key strictly less than the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    an entry with the greatest key less than key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - lowerKey
```
K lowerKey(K key)
```
    Returns the greatest key strictly less than the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the greatest key less than key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - floorEntry
```
Map.Entry<K,V> floorEntry(K key)
```
    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.
    
    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
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - floorKey
```
K floorKey(K key)
```
    Returns the greatest key less than or equal to the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the greatest key less than or equal to key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - ceilingEntry
```
Map.Entry<K,V> ceilingEntry(K key)
```
    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.
    
    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
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - ceilingKey
```
K ceilingKey(K key)
```
    Returns the least key greater than or equal to the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the least key greater than or equal to key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - higherEntry
```
Map.Entry<K,V> higherEntry(K key)
```
    Returns a key-value mapping associated with the least key strictly greater than the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    an entry with the least key greater than key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - higherKey
```
K higherKey(K key)
```
    Returns the least key strictly greater than the given key, or null if there is no such key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the least key greater than key, or null if there is no such key
    
    Throws:
    
    ClassCastException - if the specified key cannot be compared with the keys currently in the map
    
    NullPointerException - if the specified key is null and this map does not permit null keys
  - firstEntry
```
Map.Entry<K,V> firstEntry()
```
    Returns a key-value mapping associated with the least key in this map, or null if the map is empty.
    
    Returns:
    
    an entry with the least key, or null if this map is empty
  - lastEntry
```
Map.Entry<K,V> lastEntry()
```
    Returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
    
    Returns:
    
    an entry with the greatest key, or null if this map is empty
  - pollFirstEntry
```
Map.Entry<K,V> pollFirstEntry()
```
    Removes and returns a key-value mapping associated with the least key in this map, or null if the map is empty.
    
    Returns:
    
    the removed first entry of this map, or null if this map is empty
  - pollLastEntry
```
Map.Entry<K,V> pollLastEntry()
```
    Removes and returns a key-value mapping associated with the greatest key in this map, or null if the map is empty.
    
    Returns:
    
    the removed last entry of this map, or null if this map is empty
  - descendingMap
```
NavigableMap<K,V> descendingMap()
```
    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.
    
    Returns:
    
    a reverse order view of this map
  - navigableKeySet
```
NavigableSet<K> navigableKeySet()
```
    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.
    
    Returns:
    
    a navigable set view of the keys in this map
  - descendingKeySet
```
NavigableSet<K> descendingKeySet()
```
    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.
    
    Returns:
    
    a reverse order navigable set view of the keys in this map
  - subMap
```
NavigableMap<K,V> subMap(K fromKey,
                               boolean fromInclusive,
                               K toKey,
                               boolean toInclusive)
```
    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.
    
    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
    
    Throws:
    
    ClassCastException - if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.
    
    NullPointerException - if fromKey or toKey is null and this map does not permit null keys
    
    IllegalArgumentException - if fromKey is greater than toKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
  - headMap
```
NavigableMap<K,V> headMap(K toKey,
                                boolean inclusive)
```
    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.
    
    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
    
    Throws:
    
    ClassCastException - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
    
    NullPointerException - if toKey is null and this map does not permit null keys
    
    IllegalArgumentException - if this map itself has a restricted range, and toKey lies outside the bounds of the range
  - tailMap
```
NavigableMap<K,V> tailMap(K fromKey,
                                boolean inclusive)
```
    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.
    
    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
    
    Throws:
    
    ClassCastException - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
    
    NullPointerException - if fromKey is null and this map does not permit null keys
    
    IllegalArgumentException - if this map itself has a restricted range, and fromKey lies outside the bounds of the range
  - subMap
```
SortedMap<K,V> subMap(K fromKey,
                            K toKey)
```
    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 SortedMap<K,V>
    
    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
    
    Throws:
    
    ClassCastException - if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.
    
    NullPointerException - if fromKey or toKey is null and this map does not permit null keys
    
    IllegalArgumentException - if fromKey is greater than toKey; or if this map itself has a restricted range, and fromKey or toKey lies outside the bounds of the range
  - headMap
```
SortedMap<K,V> headMap(K toKey)
```
    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 SortedMap<K,V>
    
    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
    
    Throws:
    
    ClassCastException - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
    
    NullPointerException - if toKey is null and this map does not permit null keys
    
    IllegalArgumentException - if this map itself has a restricted range, and toKey lies outside the bounds of the range
  - tailMap
```
SortedMap<K,V> tailMap(K fromKey)
```
    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 SortedMap<K,V>
    
    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
    
    Throws:
    
    ClassCastException - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
    
    NullPointerException - if fromKey is null and this map does not permit null keys
    
    IllegalArgumentException - if this map itself has a restricted range, and fromKey lies outside the bounds of the range

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4