speiger.src.collections.shorts.utils.maps

Class Short2CharMaps.UnmodifyableNavigableMap

java.lang.Object

java.util.AbstractMap<java.lang.Short,java.lang.Character>

speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableSortedMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableNavigableMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, java.util.NavigableMap<java.lang.Short,java.lang.Character>, java.util.SortedMap<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap, Short2CharNavigableMap, Short2CharSortedMap

Enclosing class:

Short2CharMaps

public static class Short2CharMaps.UnmodifyableNavigableMap
extends Short2CharMaps.UnmodifyableSortedMap
implements Short2CharNavigableMap

The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

AbstractShort2CharMap.BasicEntry

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharSortedMap

Short2CharSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

Short2CharMap.BuilderCache, Short2CharMap.Entry, Short2CharMap.FastEntrySet, Short2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Short2CharMap.Entry	ceilingEntry(short key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
short	ceilingKey(short key) A Type Specific ceilingKey method to reduce boxing/unboxing.
Short2CharNavigableMap	copy() A Function that does a shallow clone of the Map itself.
ShortNavigableSet	descendingKeySet()
Short2CharNavigableMap	descendingMap()
Short2CharMap.Entry	firstEntry()
Short2CharMap.Entry	floorEntry(short key) A Type Specific floorEntry method to reduce boxing/unboxing.
short	floorKey(short key) A Type Specific floorKey method to reduce boxing/unboxing.
short	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
short	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Short2CharNavigableMap	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Short2CharNavigableMap	headMap(short toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Short2CharMap.Entry	higherEntry(short key) A Type Specific higherEntry method to reduce boxing/unboxing.
short	higherKey(short key) A Type Specific higherKey method to reduce boxing/unboxing.
ShortNavigableSet	keySet()
Short2CharMap.Entry	lastEntry()
Short2CharMap.Entry	lowerEntry(short key) A Type Specific lowerEntry method to reduce boxing/unboxing.
short	lowerKey(short key) A Type Specific lowerKey method to reduce boxing/unboxing.
ShortNavigableSet	navigableKeySet()
Short2CharMap.Entry	pollFirstEntry()
Short2CharMap.Entry	pollLastEntry()
void	setDefaultMaxValue(short e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(short e) A Helper method to set the min value for SubMaps.
Short2CharNavigableMap	subMap(short fromKey, boolean fromInclusive, short toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
Short2CharNavigableMap	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
Short2CharNavigableMap	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Short2CharNavigableMap	tailMap(short fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableSortedMap

comparator, firstCharValue, firstShortKey, lastCharValue, lastShortKey, pollFirstShortKey, pollLastShortKey

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableMap

addTo, clear, computeChar, computeCharIfAbsent, computeCharIfPresent, get, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remove, remove, removeOrDefault, replaceChars, replaceChars, short2CharEntrySet, subFrom, supplyCharIfAbsent, values

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

addToAll, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsKey, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharNavigableMap

ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, synchronize, synchronize, tailMap, tailMap, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharSortedMap

comparator, firstCharValue, firstKey, firstShortKey, lastCharValue, lastKey, lastShortKey, pollFirstShortKey, pollLastShortKey, values

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, short2CharEntrySet, subFrom, supplyCharIfAbsent

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

descendingMap

public Short2CharNavigableMap descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Short2CharNavigableMap

Returns:

a Type Specific desendingMap

navigableKeySet

public ShortNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Short2CharNavigableMap

Returns:

a Type Specific Navigable Key Set

keySet

public ShortNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Specified by:

keySet in interface Short2CharNavigableMap

Specified by:

keySet in interface Short2CharSortedMap

Overrides:

keySet in class Short2CharMaps.UnmodifyableSortedMap

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public ShortNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Short2CharNavigableMap

Returns:

a Type Specific Desending Key Set

firstEntry

public Short2CharMap.Entry firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Short2CharNavigableMap

Returns:

a Type Specific firstEntry

lastEntry

public Short2CharMap.Entry lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Short2CharNavigableMap

Returns:

a Type Specific lastEntry

pollFirstEntry

public Short2CharMap.Entry pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Short2CharNavigableMap

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Short2CharMap.Entry pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Short2CharNavigableMap

Returns:

a Type Specific pollLastEntry

subMap

public Short2CharNavigableMap subMap(short fromKey,
                                     boolean fromInclusive,
                                     short toKey,
                                     boolean toInclusive)

Description copied from interface: Short2CharNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2CharNavigableMap

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

public Short2CharNavigableMap headMap(short toKey,
                                      boolean inclusive)

Description copied from interface: Short2CharNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2CharNavigableMap

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

public Short2CharNavigableMap tailMap(short fromKey,
                                      boolean inclusive)

Description copied from interface: Short2CharNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2CharNavigableMap

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

public Short2CharNavigableMap subMap(short fromKey,
                                     short toKey)

Description copied from interface: Short2CharSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2CharNavigableMap

Specified by:

subMap in interface Short2CharSortedMap

Overrides:

subMap in class Short2CharMaps.UnmodifyableSortedMap

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

public Short2CharNavigableMap headMap(short toKey)

Description copied from interface: Short2CharSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2CharNavigableMap

Specified by:

headMap in interface Short2CharSortedMap

Overrides:

headMap in class Short2CharMaps.UnmodifyableSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Short2CharNavigableMap tailMap(short fromKey)

Description copied from interface: Short2CharSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2CharNavigableMap

Specified by:

tailMap in interface Short2CharSortedMap

Overrides:

tailMap in class Short2CharMaps.UnmodifyableSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

public void setDefaultMaxValue(short e)

Description copied from interface: Short2CharNavigableMap

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

Specified by:

setDefaultMaxValue in interface Short2CharNavigableMap

Parameters:

e - the new max value

getDefaultMaxValue

public short getDefaultMaxValue()

Description copied from interface: Short2CharNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Short2CharNavigableMap

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(short e)

Description copied from interface: Short2CharNavigableMap

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

Specified by:

setDefaultMinValue in interface Short2CharNavigableMap

Parameters:

e - the new min value

getDefaultMinValue

public short getDefaultMinValue()

Description copied from interface: Short2CharNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Short2CharNavigableMap

Returns:

the default min value.

lowerKey

public short lowerKey(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public short higherKey(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public short floorKey(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public short ceilingKey(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Short2CharMap.Entry lowerEntry(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Short2CharMap.Entry higherEntry(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Short2CharMap.Entry floorEntry(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Short2CharMap.Entry ceilingEntry(short key)

Description copied from interface: Short2CharNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Short2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

copy

public Short2CharNavigableMap copy()

Description copied from interface: Short2CharMap

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 Short2CharMap

Specified by:

copy in interface Short2CharNavigableMap

Specified by:

copy in interface Short2CharSortedMap

Overrides:

copy in class Short2CharMaps.UnmodifyableSortedMap

Returns:

a Shallow Copy of the Map