speiger.src.collections.chars.maps.interfaces

Interface Char2ObjectNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Char2ObjectFunction<V>, Char2ObjectMap<V>, Char2ObjectSortedMap<V>, java.util.Map<java.lang.Character,V>, java.util.NavigableMap<java.lang.Character,V>, java.util.SortedMap<java.lang.Character,V>

All Known Implementing Classes:

Char2ObjectAVLTreeMap, Char2ObjectMaps.SynchronizedNavigableMap, Char2ObjectMaps.UnmodifyableNavigableMap, Char2ObjectRBTreeMap

public interface Char2ObjectNavigableMap<V>
extends Char2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Character,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectSortedMap

Char2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectMap

Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>

Method Summary

Modifier and Type	Method and Description
Char2ObjectMap.Entry<V>	ceilingEntry(char key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Char2ObjectMap.Entry<V>	ceilingEntry(java.lang.Character key) Deprecated.
char	ceilingKey(char key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Character	ceilingKey(java.lang.Character key) Deprecated.
CharNavigableSet	descendingKeySet()
Char2ObjectNavigableMap<V>	descendingMap()
Char2ObjectMap.Entry<V>	firstEntry()
Char2ObjectMap.Entry<V>	floorEntry(char key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Char2ObjectMap.Entry<V>	floorEntry(java.lang.Character key) Deprecated.
char	floorKey(char key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Character	floorKey(java.lang.Character key) Deprecated.
char	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
char	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Char2ObjectNavigableMap<V>	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2ObjectNavigableMap<V>	headMap(java.lang.Character toKey) Deprecated.
default Char2ObjectNavigableMap<V>	headMap(java.lang.Character toKey, boolean inclusive) Deprecated.
Char2ObjectNavigableMap<V>	headMap(char toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Char2ObjectMap.Entry<V>	higherEntry(char key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Char2ObjectMap.Entry<V>	higherEntry(java.lang.Character key) Deprecated.
char	higherKey(char key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Character	higherKey(java.lang.Character key) Deprecated.
Char2ObjectMap.Entry<V>	lastEntry()
Char2ObjectMap.Entry<V>	lowerEntry(char key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Char2ObjectMap.Entry<V>	lowerEntry(java.lang.Character key) Deprecated.
char	lowerKey(char key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Character	lowerKey(java.lang.Character key) Deprecated.
CharNavigableSet	navigableKeySet()
Char2ObjectMap.Entry<V>	pollFirstEntry()
Char2ObjectMap.Entry<V>	pollLastEntry()
void	setDefaultMaxValue(char e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(char e) A Helper method to set the min value for SubMaps.
default Char2ObjectNavigableMap<V>	subMap(java.lang.Character fromKey, boolean fromInclusive, java.lang.Character toKey, boolean toInclusive) Deprecated.
default Char2ObjectNavigableMap<V>	subMap(java.lang.Character fromKey, java.lang.Character toKey) Deprecated.
Char2ObjectNavigableMap<V>	subMap(char fromKey, boolean fromInclusive, char toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Char2ObjectNavigableMap<V>	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Char2ObjectNavigableMap<V>	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ObjectNavigableMap<V>	tailMap(java.lang.Character fromKey) Deprecated.
default Char2ObjectNavigableMap<V>	tailMap(java.lang.Character fromKey, boolean inclusive) Deprecated.
Char2ObjectNavigableMap<V>	tailMap(char fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectSortedMap

comparator, firstCharKey, firstKey, firstValue, getAndMoveToFirst, getAndMoveToLast, keySet, lastCharKey, lastKey, lastValue, moveToFirst, moveToLast, pollFirstCharKey, pollLastCharKey, putAndMoveToFirst, putAndMoveToLast, values

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectMap

char2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remChar, remCharOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

descendingMap

Char2ObjectNavigableMap<V> descendingMap()

Specified by:

descendingMap in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific desendingMap

navigableKeySet

CharNavigableSet navigableKeySet()

Specified by:

navigableKeySet in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

CharNavigableSet descendingKeySet()

Specified by:

descendingKeySet in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific Desending Key Set

firstEntry

Char2ObjectMap.Entry<V> firstEntry()

Specified by:

firstEntry in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific firstEntry

lastEntry

Char2ObjectMap.Entry<V> lastEntry()

Specified by:

lastEntry in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific lastEntry

pollFirstEntry

Char2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

pollFirstEntry in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Char2ObjectMap.Entry<V> pollLastEntry()

Specified by:

pollLastEntry in interface java.util.NavigableMap<java.lang.Character,V>

Returns:

a Type Specific pollLastEntry

subMap

Char2ObjectNavigableMap<V> subMap(char fromKey,
                                  boolean fromInclusive,
                                  char toKey,
                                  boolean toInclusive)

A Type Specific SubMap method to reduce boxing/unboxing

Parameters:

fromKey - where the submap should start

fromInclusive - if the fromKey is inclusive or not

toKey - where the subMap should end

toInclusive - if the toKey is inclusive or not

Returns:

a SubMap that is within the range of the desired range

headMap

Char2ObjectNavigableMap<V> headMap(char toKey,
                                   boolean inclusive)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the HeadMap should end

inclusive - if the toKey is inclusive or not

Returns:

a HeadMap that is within the range of the desired range

tailMap

Char2ObjectNavigableMap<V> tailMap(char fromKey,
                                   boolean inclusive)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

inclusive - if the fromKey is inclusive or not

Returns:

a TailMap that is within the range of the desired range

subMap

default Char2ObjectNavigableMap<V> subMap(char fromKey,
                                          char toKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2ObjectSortedMap<V>

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

default Char2ObjectNavigableMap<V> headMap(char toKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Char2ObjectNavigableMap<V> tailMap(char fromKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(char e)

A Helper method to set the max value for SubMaps. (Default: char.MIN_VALUE)

Parameters:

e - the new max value

getDefaultMaxValue

char getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(char e)

A Helper method to set the min value for SubMaps. (Default: char.MAX_VALUE)

Parameters:

e - the new min value

getDefaultMinValue

char getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

char lowerKey(char key)

A Type Specific lowerKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

char higherKey(char key)

A Type Specific higherKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

char floorKey(char key)

A Type Specific floorKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

char ceilingKey(char key)

A Type Specific ceilingKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

Char2ObjectMap.Entry<V> lowerEntry(char key)

A Type Specific lowerEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

Char2ObjectMap.Entry<V> higherEntry(char key)

A Type Specific higherEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

Char2ObjectMap.Entry<V> floorEntry(char key)

A Type Specific floorEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal entry that can be found, or null

ceilingEntry

Char2ObjectMap.Entry<V> ceilingEntry(char key)

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal entry that can be found, or null

lowerKey

@Deprecated
default java.lang.Character lowerKey(java.lang.Character key)

Deprecated.

Specified by:

lowerKey in interface java.util.NavigableMap<java.lang.Character,V>

floorKey

@Deprecated
default java.lang.Character floorKey(java.lang.Character key)

Deprecated.

Specified by:

floorKey in interface java.util.NavigableMap<java.lang.Character,V>

ceilingKey

@Deprecated
default java.lang.Character ceilingKey(java.lang.Character key)

Deprecated.

Specified by:

ceilingKey in interface java.util.NavigableMap<java.lang.Character,V>

higherKey

@Deprecated
default java.lang.Character higherKey(java.lang.Character key)

Deprecated.

Specified by:

higherKey in interface java.util.NavigableMap<java.lang.Character,V>

lowerEntry

@Deprecated
default Char2ObjectMap.Entry<V> lowerEntry(java.lang.Character key)

Deprecated.

Specified by:

lowerEntry in interface java.util.NavigableMap<java.lang.Character,V>

floorEntry

@Deprecated
default Char2ObjectMap.Entry<V> floorEntry(java.lang.Character key)

Deprecated.

Specified by:

floorEntry in interface java.util.NavigableMap<java.lang.Character,V>

ceilingEntry

@Deprecated
default Char2ObjectMap.Entry<V> ceilingEntry(java.lang.Character key)

Deprecated.

Specified by:

ceilingEntry in interface java.util.NavigableMap<java.lang.Character,V>

higherEntry

@Deprecated
default Char2ObjectMap.Entry<V> higherEntry(java.lang.Character key)

Deprecated.

Specified by:

higherEntry in interface java.util.NavigableMap<java.lang.Character,V>

subMap

@Deprecated
default Char2ObjectNavigableMap<V> subMap(java.lang.Character fromKey,
                                                       boolean fromInclusive,
                                                       java.lang.Character toKey,
                                                       boolean toInclusive)

Deprecated.

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Character,V>

headMap

@Deprecated
default Char2ObjectNavigableMap<V> headMap(java.lang.Character toKey,
                                                        boolean inclusive)

Deprecated.

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Character,V>

tailMap

@Deprecated
default Char2ObjectNavigableMap<V> tailMap(java.lang.Character fromKey,
                                                        boolean inclusive)

Deprecated.

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Character,V>

subMap

@Deprecated
default Char2ObjectNavigableMap<V> subMap(java.lang.Character fromKey,
                                                       java.lang.Character toKey)

Deprecated.

Specified by:

subMap in interface Char2ObjectSortedMap<V>

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

subMap in interface java.util.SortedMap<java.lang.Character,V>

headMap

@Deprecated
default Char2ObjectNavigableMap<V> headMap(java.lang.Character toKey)

Deprecated.

Specified by:

headMap in interface Char2ObjectSortedMap<V>

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

headMap in interface java.util.SortedMap<java.lang.Character,V>

tailMap

@Deprecated
default Char2ObjectNavigableMap<V> tailMap(java.lang.Character fromKey)

Deprecated.

Specified by:

tailMap in interface Char2ObjectSortedMap<V>

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Character,V>