java.lang.Object

java.util.AbstractMap<K,V>

com.landawn.abacus.util.ImmutableMap<K,V>

com.landawn.abacus.util.ImmutableSortedMap<K,V>

com.landawn.abacus.util.ImmutableNavigableMap<K,V>

Type Parameters:: K - the key type; V - the value type

All Implemented Interfaces:: Immutable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>

public class ImmutableNavigableMap<K,V> extends ImmutableSortedMap<K,V> implements NavigableMap<K,V>

Since:: 1.1.4
Author:: Haiyang Li

Nested Class Summary

Nested classes/interfaces inherited from class com.landawn.abacus.util.ImmutableMap
ImmutableMap.Builder<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K extends Object,V extends Object>
Method Summary

Modifier and Type

Method

Description

ImmutableEntry<K,V>

ceilingEntry(K key)

K

ceilingKey(K key)

static <K, V> ImmutableNavigableMap<K,V>

copyOf(SortedMap<? extends K,? extends V> sortedMap)

ImmutableNavigableSet<K>

descendingKeySet()

Descending key set.

ImmutableNavigableMap<K,V>

descendingMap()

static <K, V> ImmutableNavigableMap<K,V>

empty()

ImmutableEntry<K,V>

firstEntry()

ImmutableEntry<K,V>

floorEntry(K key)

K

floorKey(K key)

ImmutableNavigableMap<K,V>

headMap(K toKey, boolean inclusive)

ImmutableEntry<K,V>

higherEntry(K key)

K

higherKey(K key)

ImmutableEntry<K,V>

lastEntry()

ImmutableEntry<K,V>

lowerEntry(K key)

K

lowerKey(K key)

ImmutableNavigableSet<K>

navigableKeySet()

Navigable key set.

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)

static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V>

of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)

Map.Entry<K,V>

pollFirstEntry()

Deprecated.
throws UnsupportedOperationException

Map.Entry<K,V>

pollLastEntry()

Deprecated.
throws UnsupportedOperationException

ImmutableNavigableMap<K,V>

subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

ImmutableNavigableMap<K,V>

tailMap(K fromKey, boolean inclusive)

static <K, V> ImmutableNavigableMap<K,V>

wrap(NavigableMap<? extends K,? extends V> navigableMap)

Deprecated.
the ImmutableNavigableMap may be modified through the specified navigableMap

static <K, V> ImmutableSortedMap<K,V>

wrap(SortedMap<? extends K,? extends V> sortedMap)

Deprecated.
throws UnsupportedOperationException

Methods inherited from class com.landawn.abacus.util.ImmutableSortedMap
comparator, copyOf, firstKey, headMap, lastKey, subMap, tailMap, wrap

Methods inherited from class com.landawn.abacus.util.ImmutableMap
builder, builder, clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, get, getOrDefault, isEmpty, keySet, merge, of, of, of, of, of, of, of, put, putAll, putIfAbsent, remove, remove, replace, replace, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface java.util.NavigableMap
headMap, subMap, tailMap

Methods inherited from interface java.util.SortedMap
comparator, entrySet, firstKey, keySet, lastKey, values

Method Details
- empty
  
  public static <K, V> ImmutableNavigableMap<K,V> empty()
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  k3 -
  
  v3 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  k3 -
  
  v3 -
  
  k4 -
  
  v4 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  k3 -
  
  v3 -
  
  k4 -
  
  v4 -
  
  k5 -
  
  v5 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  k3 -
  
  v3 -
  
  k4 -
  
  v4 -
  
  k5 -
  
  v5 -
  
  k6 -
  
  v6 -
  
  Returns:
- of
  
  public static <K extends Comparable<? super K>, V> ImmutableNavigableMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  k1 -
  
  v1 -
  
  k2 -
  
  v2 -
  
  k3 -
  
  v3 -
  
  k4 -
  
  v4 -
  
  k5 -
  
  v5 -
  
  k6 -
  
  v6 -
  
  k7 -
  
  v7 -
  
  Returns:
- copyOf
  
  public static <K, V> ImmutableNavigableMap<K,V> copyOf(SortedMap<? extends K,? extends V> sortedMap)
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  sortedMap -
  
  Returns:
- wrap
  
  @Deprecated public static <K, V> ImmutableNavigableMap<K,V> wrap(NavigableMap<? extends K,? extends V> navigableMap)
  
  Deprecated.
  the ImmutableNavigableMap may be modified through the specified navigableMap
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  navigableMap -
  
  Returns:
  
  an ImmutableNavigableMap backed by the specified navigableMap
- wrap
  
  @Deprecated public static <K, V> ImmutableSortedMap<K,V> wrap(SortedMap<? extends K,? extends V> sortedMap) throws UnsupportedOperationException
  
  Deprecated.
  throws UnsupportedOperationException
  
  Type Parameters:
  
  K - the key type
  
  V - the value type
  
  Parameters:
  
  sortedMap -
  
  Returns:
  
  Throws:
  
  UnsupportedOperationException
- lowerEntry
  
  public ImmutableEntry<K,V> lowerEntry(K key)
  
  Specified by:
  
  lowerEntry in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- lowerKey
  
  public K lowerKey(K key)
  
  Specified by:
  
  lowerKey in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- floorEntry
  
  public ImmutableEntry<K,V> floorEntry(K key)
  
  Specified by:
  
  floorEntry in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- floorKey
  
  public K floorKey(K key)
  
  Specified by:
  
  floorKey in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- ceilingEntry
  
  public ImmutableEntry<K,V> ceilingEntry(K key)
  
  Specified by:
  
  ceilingEntry in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- ceilingKey
  
  public K ceilingKey(K key)
  
  Specified by:
  
  ceilingKey in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- higherEntry
  
  public ImmutableEntry<K,V> higherEntry(K key)
  
  Specified by:
  
  higherEntry in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- higherKey
  
  public K higherKey(K key)
  
  Specified by:
  
  higherKey in interface NavigableMap<K,V>
  
  Parameters:
  
  key -
  
  Returns:
- firstEntry
  
  public ImmutableEntry<K,V> firstEntry()
  
  Specified by:
  
  firstEntry in interface NavigableMap<K,V>
  
  Returns:
- lastEntry
  
  public ImmutableEntry<K,V> lastEntry()
  
  Specified by:
  
  lastEntry in interface NavigableMap<K,V>
  
  Returns:
- pollFirstEntry
  
  @Deprecated public Map.Entry<K,V> pollFirstEntry() throws UnsupportedOperationException
  
  Deprecated.
  throws UnsupportedOperationException
  
  Poll first entry.
  
  Specified by:
  
  pollFirstEntry in interface NavigableMap<K,V>
  
  Returns:
  
  Throws:
  
  UnsupportedOperationException
- pollLastEntry
  
  @Deprecated public Map.Entry<K,V> pollLastEntry() throws UnsupportedOperationException
  
  Deprecated.
  throws UnsupportedOperationException
  
  Poll last entry.
  
  Specified by:
  
  pollLastEntry in interface NavigableMap<K,V>
  
  Returns:
  
  Throws:
  
  UnsupportedOperationException
- descendingMap
  
  public ImmutableNavigableMap<K,V> descendingMap()
  
  Specified by:
  
  descendingMap in interface NavigableMap<K,V>
  
  Returns:
- navigableKeySet
  
  public ImmutableNavigableSet<K> navigableKeySet()
  
  Navigable key set.
  
  Specified by:
  
  navigableKeySet in interface NavigableMap<K,V>
  
  Returns:
- descendingKeySet
  
  public ImmutableNavigableSet<K> descendingKeySet()
  
  Descending key set.
  
  Specified by:
  
  descendingKeySet in interface NavigableMap<K,V>
  
  Returns:
- subMap
  
  public ImmutableNavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
  
  Specified by:
  
  subMap in interface NavigableMap<K,V>
  
  Parameters:
  
  fromKey -
  
  fromInclusive -
  
  toKey -
  
  toInclusive -
  
  Returns:
- headMap
  
  public ImmutableNavigableMap<K,V> headMap(K toKey, boolean inclusive)
  
  Specified by:
  
  headMap in interface NavigableMap<K,V>
  
  Parameters:
  
  toKey -
  
  inclusive -
  
  Returns:
- tailMap
  
  public ImmutableNavigableMap<K,V> tailMap(K fromKey, boolean inclusive)
  
  Specified by:
  
  tailMap in interface NavigableMap<K,V>
  
  Parameters:
  
  fromKey -
  
  inclusive -
  
  Returns:

Class ImmutableNavigableMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class com.landawn.abacus.util.ImmutableMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from class com.landawn.abacus.util.ImmutableSortedMap

Methods inherited from class com.landawn.abacus.util.ImmutableMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface java.util.NavigableMap

Methods inherited from interface java.util.SortedMap

Method Details

empty

of

of

of

of

of

of

of

copyOf

wrap

wrap

lowerEntry

lowerKey

floorEntry

floorKey

ceilingEntry

ceilingKey

higherEntry

higherKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

descendingMap

navigableKeySet

descendingKeySet

subMap

headMap

tailMap