Object2ShortNavigableMap (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.Short>, java.util.NavigableMap<T,java.lang.Short>, Object2ShortFunction<T>, Object2ShortMap<T>, Object2ShortSortedMap<T>, java.util.SortedMap<T,java.lang.Short>

All Known Implementing Classes:

Object2ShortAVLTreeMap, Object2ShortMaps.SynchronizedNavigableMap, Object2ShortMaps.UnmodifyableNavigableMap, Object2ShortRBTreeMap
```
public interface Object2ShortNavigableMap<T>
extends Object2ShortSortedMap<T>, java.util.NavigableMap<T,java.lang.Short>
```
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.Object2ShortSortedMap
  Object2ShortSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortMap
  Object2ShortMap.BuilderCache<T>, Object2ShortMap.Entry<T>, Object2ShortMap.FastEntrySet<T>, Object2ShortMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortSortedMap
comparator, firstShortValue, lastShortValue, pollFirstKey, pollLastKey, values

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortMap
addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, object2ShortEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent

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

Interface Object2ShortNavigableMap<T>

Nested Class Summary

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

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

Method Summary

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

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

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