Object2ObjectNavigableMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, java.util.NavigableMap<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>, Object2ObjectSortedMap<T,V>, java.util.SortedMap<T,V>

All Known Implementing Classes:

Object2ObjectAVLTreeMap, Object2ObjectMaps.SynchronizedNavigableMap, Object2ObjectMaps.UnmodifyableNavigableMap, Object2ObjectRBTreeMap
```
public interface Object2ObjectNavigableMap<T,V>
extends Object2ObjectSortedMap<T,V>, java.util.NavigableMap<T,V>
```
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.Object2ObjectSortedMap
  Object2ObjectSortedMap.FastSortedSet<T,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap
  Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectSortedMap
comparator, firstValue, lastValue, pollFirstKey, pollLastKey, values

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap
builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, merge, merge, mergeAll, object2ObjectEntrySet, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2ObjectFunction
apply, getObject

Methods inherited from interface java.util.function.Function
andThen, compose, identity

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, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

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

Interface Object2ObjectNavigableMap<T,V>

Nested Class Summary

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

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

Method Summary

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

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

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

Methods inherited from interface java.util.function.Function

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