Object2CharNavigableMap (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.Character>, java.util.NavigableMap<T,java.lang.Character>, Object2CharFunction<T>, Object2CharMap<T>, Object2CharSortedMap<T>, java.util.SortedMap<T,java.lang.Character>

All Known Implementing Classes:

Object2CharAVLTreeMap, Object2CharMaps.SynchronizedNavigableMap, Object2CharMaps.UnmodifyableNavigableMap, Object2CharRBTreeMap
```
public interface Object2CharNavigableMap<T>
extends Object2CharSortedMap<T>, java.util.NavigableMap<T,java.lang.Character>
```
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.Object2CharSortedMap
  Object2CharSortedMap.FastSortedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
  Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharSortedMap
comparator, firstCharValue, lastCharValue, pollFirstKey, pollLastKey, values

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, object2CharEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent

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

Interface Object2CharNavigableMap<T>

Nested Class Summary

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

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

Method Summary

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

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

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