Object2LongNavigableMap (Primitive-Collections 0.8.0 API)

Type Parameters:

T - the keyType of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Long>, java.util.NavigableMap<T,java.lang.Long>, Object2LongMap<T>, Object2LongSortedMap<T>, java.util.SortedMap<T,java.lang.Long>, java.util.function.ToLongFunction<T>

All Known Implementing Classes:

Object2LongAVLTreeMap, Object2LongMaps.SynchronizedNavigableMap, Object2LongMaps.UnmodifyableNavigableMap, Object2LongRBTreeMap
```
public interface Object2LongNavigableMap<T>
extends Object2LongSortedMap<T>, java.util.NavigableMap<T,java.lang.Long>
```
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.Object2LongSortedMap
  Object2LongSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap
  Object2LongMap.BuilderCache<T>, Object2LongMap.Entry<T>, Object2LongMap.FastEntrySet<T>, Object2LongMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongSortedMap
comparator, firstLongValue, lastLongValue, pollFirstKey, pollLastKey, values

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2LongMap
addTo, addToAll, applyAsLong, builder, compute, computeIfAbsent, computeIfPresent, computeLong, computeLongIfAbsent, computeLongIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getLong, getOrDefault, getOrDefault, merge, mergeAllLong, mergeLong, object2LongEntrySet, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceLongs, replaceLongs, setDefaultReturnValue, subFrom, supplyLongIfAbsent

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

Interface Object2LongNavigableMap<T>

Nested Class Summary

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

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

Method Summary

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

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

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