Object2IntNavigableMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Integer>, java.util.NavigableMap<T,java.lang.Integer>, Object2IntFunction<T>, Object2IntMap<T>, Object2IntSortedMap<T>, java.util.SortedMap<T,java.lang.Integer>, java.util.function.ToIntFunction<T>

All Known Implementing Classes:

Object2IntAVLTreeMap, Object2IntMaps.SynchronizedNavigableMap, Object2IntMaps.UnmodifyableNavigableMap, Object2IntRBTreeMap
```
public interface Object2IntNavigableMap<T>
extends Object2IntSortedMap<T>, java.util.NavigableMap<T,java.lang.Integer>
```
A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntSortedMap
  Object2IntSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap
  Object2IntMap.BuilderCache<T>, Object2IntMap.Entry<T>, Object2IntMap.FastEntrySet<T>, Object2IntMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Object2IntMap.Entry<T>`	`ceilingEntry(T key)`
`Object2IntNavigableMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectNavigableSet<T>`	`descendingKeySet()`
`Object2IntNavigableMap<T>`	`descendingMap()`
`Object2IntMap.Entry<T>`	`firstEntry()`
`Object2IntMap.Entry<T>`	`floorEntry(T key)`
`default Object2IntNavigableMap<T>`	`headMap(T toKey)`
`Object2IntNavigableMap<T>`	`headMap(T toKey, boolean inclusive)`
`Object2IntMap.Entry<T>`	`higherEntry(T key)`
`ObjectNavigableSet<T>`	`keySet()`
`Object2IntMap.Entry<T>`	`lastEntry()`
`Object2IntMap.Entry<T>`	`lowerEntry(T key)`
`ObjectNavigableSet<T>`	`navigableKeySet()`
`Object2IntMap.Entry<T>`	`pollFirstEntry()`
`Object2IntMap.Entry<T>`	`pollLastEntry()`
`Object2IntNavigableMap<T>`	`subMap(T fromKey, boolean fromInclusive, T toKey, boolean toInclusive)`
`default Object2IntNavigableMap<T>`	`subMap(T fromKey, T toKey)`
`default Object2IntNavigableMap<T>`	`synchronize()` Creates a Wrapped NavigableMap that is Synchronized
`default Object2IntNavigableMap<T>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped NavigableMap that is Synchronized
`default Object2IntNavigableMap<T>`	`tailMap(T fromKey)`
`Object2IntNavigableMap<T>`	`tailMap(T fromKey, boolean inclusive)`
`default Object2IntNavigableMap<T>`	`unmodifiable()` Creates a Wrapped NavigableMap that is unmodifiable

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntSortedMap
comparator, firstIntValue, lastIntValue, pollFirstKey, pollLastKey, values

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap
addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getInt, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, object2IntEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, subFrom, supplyIntIfAbsent

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2IntFunction
applyAsInt

Methods inherited from interface java.util.NavigableMap
ceilingKey, floorKey, higherKey, lowerKey

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

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

- Method Detail
  - copy
```
Object2IntNavigableMap<T> copy()
```
    Description copied from interface: Object2IntMap
    
    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 Object2IntMap<T>
    
    Specified by:
    
    copy in interface Object2IntSortedMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - descendingMap
```
Object2IntNavigableMap<T> descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific desendingMap
  - navigableKeySet
```
ObjectNavigableSet<T> navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingKeySet
```
ObjectNavigableSet<T> descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific Desending Key Set
  - firstEntry
```
Object2IntMap.Entry<T> firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
Object2IntMap.Entry<T> lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
Object2IntMap.Entry<T> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
Object2IntMap.Entry<T> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific pollLastEntry
  - keySet
```
ObjectNavigableSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    keySet in interface Object2IntMap<T>
    
    Specified by:
    
    keySet in interface Object2IntSortedMap<T>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Integer>
    
    Returns:
    
    a Type Specific Navigable Key Set
  - synchronize
```
default Object2IntNavigableMap<T> synchronize()
```
    Creates a Wrapped NavigableMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2IntMap<T>
    
    Specified by:
    
    synchronize in interface Object2IntSortedMap<T>
    
    Returns:
    
    a new NavigableMap that is synchronized
    
    See Also:
    
    Object2IntMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2IntMap<T>)
  - synchronize
```
default Object2IntNavigableMap<T> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped NavigableMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2IntMap<T>
    
    Specified by:
    
    synchronize in interface Object2IntSortedMap<T>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new NavigableMap Wrapper that is synchronized
    
    See Also:
    
    Object2IntMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2IntMap<T>)
  - unmodifiable
```
default Object2IntNavigableMap<T> unmodifiable()
```
    Creates a Wrapped NavigableMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2IntMap<T>
    
    Specified by:
    
    unmodifiable in interface Object2IntSortedMap<T>
    
    Returns:
    
    a new NavigableMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2IntMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2IntMap<T>)
  - lowerEntry
```
Object2IntMap.Entry<T> lowerEntry(T key)
```
    Specified by:
    
    lowerEntry in interface java.util.NavigableMap<T,java.lang.Integer>
  - floorEntry
```
Object2IntMap.Entry<T> floorEntry(T key)
```
    Specified by:
    
    floorEntry in interface java.util.NavigableMap<T,java.lang.Integer>
  - ceilingEntry
```
Object2IntMap.Entry<T> ceilingEntry(T key)
```
    Specified by:
    
    ceilingEntry in interface java.util.NavigableMap<T,java.lang.Integer>
  - higherEntry
```
Object2IntMap.Entry<T> higherEntry(T key)
```
    Specified by:
    
    higherEntry in interface java.util.NavigableMap<T,java.lang.Integer>
  - subMap
```
Object2IntNavigableMap<T> subMap(T fromKey,
                                 boolean fromInclusive,
                                 T toKey,
                                 boolean toInclusive)
```
    Specified by:
    
    subMap in interface java.util.NavigableMap<T,java.lang.Integer>
  - headMap
```
Object2IntNavigableMap<T> headMap(T toKey,
                                  boolean inclusive)
```
    Specified by:
    
    headMap in interface java.util.NavigableMap<T,java.lang.Integer>
  - tailMap
```
Object2IntNavigableMap<T> tailMap(T fromKey,
                                  boolean inclusive)
```
    Specified by:
    
    tailMap in interface java.util.NavigableMap<T,java.lang.Integer>
  - subMap
```
default Object2IntNavigableMap<T> subMap(T fromKey,
                                         T toKey)
```
    Specified by:
    
    subMap in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Specified by:
    
    subMap in interface Object2IntSortedMap<T>
    
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Integer>
  - headMap
```
default Object2IntNavigableMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Specified by:
    
    headMap in interface Object2IntSortedMap<T>
    
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Integer>
  - tailMap
```
default Object2IntNavigableMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.NavigableMap<T,java.lang.Integer>
    
    Specified by:
    
    tailMap in interface Object2IntSortedMap<T>
    
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Integer>

Interface Object2IntNavigableMap<T>

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap

Method Summary

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntSortedMap

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2IntFunction

Methods inherited from interface java.util.NavigableMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Method Detail

copy

descendingMap

navigableKeySet

descendingKeySet

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

keySet

synchronize

synchronize

unmodifiable

lowerEntry

floorEntry

ceilingEntry

higherEntry

subMap

headMap

tailMap

subMap

headMap

tailMap