speiger.src.collections.chars.maps.interfaces

Interface Char2ShortNavigableMap

All Superinterfaces:

Char2ShortFunction, Char2ShortMap, Char2ShortSortedMap, java.util.Map<java.lang.Character,java.lang.Short>, java.util.NavigableMap<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>

All Known Implementing Classes:

Char2ShortAVLTreeMap, Char2ShortMaps.SynchronizedNavigableMap, Char2ShortMaps.UnmodifyableNavigableMap, Char2ShortRBTreeMap

public interface Char2ShortNavigableMap
extends Char2ShortSortedMap, java.util.NavigableMap<java.lang.Character,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.chars.maps.interfaces.Char2ShortSortedMap

Char2ShortSortedMap.FastSortedSet

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

Char2ShortMap.BuilderCache, Char2ShortMap.Entry, Char2ShortMap.FastEntrySet, Char2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Char2ShortMap.Entry	ceilingEntry(char key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Char2ShortMap.Entry	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.
Char2ShortNavigableMap	copy() A Function that does a shallow clone of the Map itself.
CharNavigableSet	descendingKeySet()
Char2ShortNavigableMap	descendingMap()
Char2ShortMap.Entry	firstEntry()
Char2ShortMap.Entry	floorEntry(char key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Char2ShortMap.Entry	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 Char2ShortNavigableMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2ShortNavigableMap	headMap(java.lang.Character toKey) Deprecated.
default Char2ShortNavigableMap	headMap(java.lang.Character toKey, boolean inclusive) Deprecated.
Char2ShortNavigableMap	headMap(char toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Char2ShortMap.Entry	higherEntry(char key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Char2ShortMap.Entry	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.
CharNavigableSet	keySet()
Char2ShortMap.Entry	lastEntry()
Char2ShortMap.Entry	lowerEntry(char key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Char2ShortMap.Entry	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()
Char2ShortMap.Entry	pollFirstEntry()
Char2ShortMap.Entry	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 Char2ShortNavigableMap	subMap(java.lang.Character fromKey, boolean fromInclusive, java.lang.Character toKey, boolean toInclusive) Deprecated.
default Char2ShortNavigableMap	subMap(java.lang.Character fromKey, java.lang.Character toKey) Deprecated.
Char2ShortNavigableMap	subMap(char fromKey, boolean fromInclusive, char toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Char2ShortNavigableMap	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Char2ShortNavigableMap	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Char2ShortNavigableMap	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Char2ShortNavigableMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ShortNavigableMap	tailMap(java.lang.Character fromKey) Deprecated.
default Char2ShortNavigableMap	tailMap(java.lang.Character fromKey, boolean inclusive) Deprecated.
Char2ShortNavigableMap	tailMap(char fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ShortNavigableMap	unmodifiable() Creates a Wrapped NavigableMap that is unmodifiable

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

comparator, firstCharKey, firstKey, firstShortValue, lastCharKey, lastKey, lastShortValue, pollFirstCharKey, pollLastCharKey, values

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

addTo, addToAll, applyAsShort, builder, char2ShortEntrySet, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

copy

Char2ShortNavigableMap copy()

Description copied from interface: Char2ShortMap

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 Char2ShortMap

Specified by:

copy in interface Char2ShortSortedMap

Returns:

a Shallow Copy of the Map

descendingMap

Char2ShortNavigableMap descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

CharNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

CharNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Char2ShortMap.Entry firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Char2ShortMap.Entry lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Char2ShortMap.Entry pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Char2ShortMap.Entry pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

CharNavigableSet keySet()

Specified by:

keySet in interface Char2ShortMap

Specified by:

keySet in interface Char2ShortSortedMap

Specified by:

keySet in interface java.util.Map<java.lang.Character,java.lang.Short>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Character,java.lang.Short>

Returns:

a Type Specific Navigable Key Set

synchronize

default Char2ShortNavigableMap synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Char2ShortMap

Specified by:

synchronize in interface Char2ShortSortedMap

Returns:

a new NavigableMap that is synchronized

See Also:

Char2ShortMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

synchronize

default Char2ShortNavigableMap synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Char2ShortMap

Specified by:

synchronize in interface Char2ShortSortedMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Char2ShortMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

unmodifiable

default Char2ShortNavigableMap unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Char2ShortMap

Specified by:

unmodifiable in interface Char2ShortSortedMap

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Char2ShortMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

subMap

Char2ShortNavigableMap 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

Char2ShortNavigableMap 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

Char2ShortNavigableMap 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 Char2ShortNavigableMap subMap(char fromKey,
                                      char toKey)

Description copied from interface: Char2ShortSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2ShortSortedMap

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 Char2ShortNavigableMap headMap(char toKey)

Description copied from interface: Char2ShortSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2ShortSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Char2ShortNavigableMap tailMap(char fromKey)

Description copied from interface: Char2ShortSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2ShortSortedMap

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

Char2ShortMap.Entry 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

Char2ShortMap.Entry 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

Char2ShortMap.Entry 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

Char2ShortMap.Entry 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,java.lang.Short>

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Char2ShortMap.Entry lowerEntry(java.lang.Character key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Char2ShortMap.Entry floorEntry(java.lang.Character key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Char2ShortMap.Entry ceilingEntry(java.lang.Character key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Char2ShortMap.Entry higherEntry(java.lang.Character key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Char2ShortNavigableMap 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,java.lang.Short>

headMap

@Deprecated
default Char2ShortNavigableMap headMap(java.lang.Character toKey,
                                                    boolean inclusive)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Char2ShortNavigableMap tailMap(java.lang.Character fromKey,
                                                    boolean inclusive)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Char2ShortNavigableMap subMap(java.lang.Character fromKey,
                                                   java.lang.Character toKey)

Deprecated.

Specified by:

subMap in interface Char2ShortSortedMap

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Char2ShortNavigableMap headMap(java.lang.Character toKey)

Deprecated.

Specified by:

headMap in interface Char2ShortSortedMap

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Char2ShortNavigableMap tailMap(java.lang.Character fromKey)

Deprecated.

Specified by:

tailMap in interface Char2ShortSortedMap

Specified by:

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

Specified by:

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