com.google.common.collect

Class RegularImmutableSortedMap<K,V>

java.lang.Object

com.google.common.collect.ImmutableMap<K,V>

com.google.common.collect.ImmutableSortedMapFauxverideShim<K,V>

com.google.common.collect.ImmutableSortedMap<K,V>

com.google.common.collect.RegularImmutableSortedMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>, java.util.NavigableMap<K,V>, java.util.SortedMap<K,V>

@GwtCompatible(emulated=true)
final class RegularImmutableSortedMap<K,V>
extends ImmutableSortedMap<K,V>

An implementation of an immutable sorted map with one or more entries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RegularImmutableSortedMap.EntrySet

Nested classes/interfaces inherited from class com.google.common.collect.ImmutableSortedMap

ImmutableSortedMap.Builder<K,V>

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private RegularImmutableSortedSet<K>	keySet
private ImmutableList<V>	valueList

Constructor Summary

Constructors

Constructor and Description
RegularImmutableSortedMap(RegularImmutableSortedSet<K> keySet, ImmutableList<V> valueList)
RegularImmutableSortedMap(RegularImmutableSortedSet<K> keySet, ImmutableList<V> valueList, ImmutableSortedMap<K,V> descendingMap)

Method Summary

Modifier and Type	Method and Description
(package private) ImmutableSortedMap<K,V>	createDescendingMap()
(package private) ImmutableSet<java.util.Map.Entry<K,V>>	createEntrySet()
V	get(java.lang.Object key)
private ImmutableSortedMap<K,V>	getSubMap(int fromIndex, int toIndex)
ImmutableSortedMap<K,V>	headMap(K toKey, boolean inclusive) This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than (or equal to, if inclusive) toKey.
ImmutableSortedSet<K>	keySet() Returns an immutable sorted set of the keys in this map.
ImmutableSortedMap<K,V>	tailMap(K fromKey, boolean inclusive) This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than (or equal to, if inclusive) fromKey.
ImmutableCollection<V>	values() Returns an immutable collection of the values in this map, sorted by the ordering of the corresponding keys.

Methods inherited from class com.google.common.collect.ImmutableSortedMap

ceilingEntry, ceilingKey, comparator, containsValue, copyOf, copyOf, copyOfSorted, descendingKeySet, descendingMap, emptyMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, from, fromEntries, fromSortedEntries, headMap, higherEntry, higherKey, isPartialView, lastEntry, lastKey, lowerEntry, lowerKey, naturalOrder, navigableKeySet, of, of, of, of, of, of, orderedBy, pollFirstEntry, pollLastEntry, reverseOrder, size, subMap, subMap, tailMap, writeReplace

Methods inherited from class com.google.common.collect.ImmutableSortedMapFauxverideShim

builder

Methods inherited from class com.google.common.collect.ImmutableMap

asMultimap, checkNoConflict, clear, containsKey, createKeySet, entryOf, equals, hashCode, isEmpty, put, putAll, remove, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Field Detail

keySet

private final transient RegularImmutableSortedSet<K> keySet

valueList

private final transient ImmutableList<V> valueList

Constructor Detail

RegularImmutableSortedMap

RegularImmutableSortedMap(RegularImmutableSortedSet<K> keySet,
                          ImmutableList<V> valueList)

RegularImmutableSortedMap

RegularImmutableSortedMap(RegularImmutableSortedSet<K> keySet,
                          ImmutableList<V> valueList,
                          ImmutableSortedMap<K,V> descendingMap)

Method Detail

createEntrySet

ImmutableSet<java.util.Map.Entry<K,V>> createEntrySet()

Specified by:

createEntrySet in class ImmutableMap<K,V>

keySet

public ImmutableSortedSet<K> keySet()

Description copied from class: ImmutableSortedMap

Returns an immutable sorted set of the keys in this map.

Specified by:

keySet in interface java.util.Map<K,V>

Specified by:

keySet in interface java.util.SortedMap<K,V>

Specified by:

keySet in class ImmutableSortedMap<K,V>

values

public ImmutableCollection<V> values()

Description copied from class: ImmutableSortedMap

Returns an immutable collection of the values in this map, sorted by the ordering of the corresponding keys.

Specified by:

values in interface java.util.Map<K,V>

Specified by:

values in interface java.util.SortedMap<K,V>

Specified by:

values in class ImmutableSortedMap<K,V>

get

public V get(@Nullable
             java.lang.Object key)

Specified by:

get in interface java.util.Map<K,V>

Specified by:

get in class ImmutableMap<K,V>

getSubMap

private ImmutableSortedMap<K,V> getSubMap(int fromIndex,
                                          int toIndex)

headMap

public ImmutableSortedMap<K,V> headMap(K toKey,
                                       boolean inclusive)

Description copied from class: ImmutableSortedMap

This method returns a ImmutableSortedMap, consisting of the entries whose keys are less than (or equal to, if inclusive) toKey.

The SortedMap.headMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a toKey greater than an earlier toKey. However, this method doesn't throw an exception in that situation, but instead keeps the original toKey.

Specified by:

headMap in interface java.util.NavigableMap<K,V>

Specified by:

headMap in class ImmutableSortedMap<K,V>

tailMap

public ImmutableSortedMap<K,V> tailMap(K fromKey,
                                       boolean inclusive)

Description copied from class: ImmutableSortedMap

This method returns a ImmutableSortedMap, consisting of the entries whose keys are greater than (or equal to, if inclusive) fromKey.

The SortedMap.tailMap(K) documentation states that a submap of a submap throws an IllegalArgumentException if passed a fromKey less than an earlier fromKey. However, this method doesn't throw an exception in that situation, but instead keeps the original fromKey.

Specified by:

tailMap in interface java.util.NavigableMap<K,V>

Specified by:

tailMap in class ImmutableSortedMap<K,V>

createDescendingMap

ImmutableSortedMap<K,V> createDescendingMap()

Specified by:

createDescendingMap in class ImmutableSortedMap<K,V>