Int2ObjectMaps.UnmodifyableSortedMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Integer,V>
- - speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>
  - - speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap<V>
    - - speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableSortedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>, Int2ObjectMap<V>, Int2ObjectSortedMap<V>

Direct Known Subclasses:

Int2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Int2ObjectMaps
```
public static class Int2ObjectMaps.UnmodifyableSortedMap<V>
extends Int2ObjectMaps.UnmodifyableMap<V>
implements Int2ObjectSortedMap<V>
```
The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap
  AbstractInt2ObjectMap.BasicEntry<V>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap
  Int2ObjectSortedMap.FastSortedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap
  Int2ObjectMap.BuilderCache<V>, Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>, Int2ObjectMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IntComparator`	`comparator()`
`Int2ObjectSortedMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`int`	`firstIntKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`Int2ObjectSortedMap<V>`	`headMap(int toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`IntSortedSet`	`keySet()`
`int`	`lastIntKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`int`	`pollFirstIntKey()` A method to get and remove the first Key of a Map.
`int`	`pollLastIntKey()` A method to get and remove the last Key of a Map.
`Int2ObjectSortedMap<V>`	`subMap(int fromKey, int toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Int2ObjectSortedMap<V>`	`tailMap(int fromKey)` A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap
clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, int2ObjectEntrySet, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap
containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
containsKey, isEmpty, size, toString

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

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap
firstKey, headMap, lastKey, subMap, synchronize, synchronize, tailMap, unmodifiable, values

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap
apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, int2ObjectEntrySet, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map
clear, containsValue, equals, hashCode, isEmpty, putAll, size

- Method Detail
  - comparator
```
public IntComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Integer,V>
    
    Specified by:
    
    comparator in interface Int2ObjectSortedMap<V>
  - subMap
```
public Int2ObjectSortedMap<V> subMap(int fromKey,
                                     int toKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    fromKey - where the submap should start
    
    toKey - where the subMap should end
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Int2ObjectSortedMap<V> headMap(int toKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    toKey - where the headMap should end
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Int2ObjectSortedMap<V> tailMap(int fromKey)
```
    Description copied from interface: Int2ObjectSortedMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Int2ObjectSortedMap<V>
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - keySet
```
public IntSortedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Integer,V>
    
    Specified by:
    
    keySet in interface Int2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Int2ObjectSortedMap<V>
    
    Overrides:
    
    keySet in class Int2ObjectMaps.UnmodifyableMap<V>
  - firstIntKey
```
public int firstIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
public int pollFirstIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
public int lastIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
public int pollLastIntKey()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastIntKey in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - firstValue
```
public V firstValue()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstValue in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the first key in the map
  - lastValue
```
public V lastValue()
```
    Description copied from interface: Int2ObjectSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastValue in interface Int2ObjectSortedMap<V>
    
    Returns:
    
    the last key in the map
  - copy
```
public Int2ObjectSortedMap<V> copy()
```
    Description copied from interface: Int2ObjectMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Int2ObjectMap<V>
    
    Specified by:
    
    copy in interface Int2ObjectSortedMap<V>
    
    Overrides:
    
    copy in class Int2ObjectMaps.UnmodifyableMap<V>
    
    Returns:
    
    a Shallow Copy of the Map

Class Int2ObjectMaps.UnmodifyableSortedMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

Method Summary

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

Methods inherited from interface java.util.Map

Method Detail

comparator

subMap

headMap

tailMap

keySet

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstValue

lastValue

copy