speiger.src.collections.shorts.maps.interfaces

Interface Short2IntNavigableMap

All Superinterfaces:

java.util.Map<java.lang.Short,java.lang.Integer>, java.util.NavigableMap<java.lang.Short,java.lang.Integer>, Short2IntFunction, Short2IntMap, Short2IntSortedMap, java.util.SortedMap<java.lang.Short,java.lang.Integer>

All Known Implementing Classes:

Short2IntAVLTreeMap, Short2IntMaps.SynchronizedNavigableMap, Short2IntMaps.UnmodifyableNavigableMap, Short2IntRBTreeMap

public interface Short2IntNavigableMap
extends Short2IntSortedMap, java.util.NavigableMap<java.lang.Short,java.lang.Integer>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

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

Short2IntSortedMap.FastSortedSet

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

Short2IntMap.BuilderCache, Short2IntMap.Entry, Short2IntMap.FastEntrySet, Short2IntMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Short2IntMap.Entry	ceilingEntry(short key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Short2IntMap.Entry	ceilingEntry(java.lang.Short key) Deprecated.
short	ceilingKey(short key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Short	ceilingKey(java.lang.Short key) Deprecated.
Short2IntNavigableMap	copy() A Function that does a shallow clone of the Map itself.
ShortNavigableSet	descendingKeySet()
Short2IntNavigableMap	descendingMap()
Short2IntMap.Entry	firstEntry()
Short2IntMap.Entry	floorEntry(short key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Short2IntMap.Entry	floorEntry(java.lang.Short key) Deprecated.
short	floorKey(short key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Short	floorKey(java.lang.Short key) Deprecated.
short	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
short	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Short2IntNavigableMap	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Short2IntNavigableMap	headMap(java.lang.Short toKey) Deprecated.
Short2IntNavigableMap	headMap(short toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
default Short2IntNavigableMap	headMap(java.lang.Short toKey, boolean inclusive) Deprecated.
Short2IntMap.Entry	higherEntry(short key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Short2IntMap.Entry	higherEntry(java.lang.Short key) Deprecated.
short	higherKey(short key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Short	higherKey(java.lang.Short key) Deprecated.
ShortNavigableSet	keySet()
Short2IntMap.Entry	lastEntry()
Short2IntMap.Entry	lowerEntry(short key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Short2IntMap.Entry	lowerEntry(java.lang.Short key) Deprecated.
short	lowerKey(short key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Short	lowerKey(java.lang.Short key) Deprecated.
ShortNavigableSet	navigableKeySet()
Short2IntMap.Entry	pollFirstEntry()
Short2IntMap.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.
Short2IntNavigableMap	subMap(short fromKey, boolean fromInclusive, short toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Short2IntNavigableMap	subMap(java.lang.Short fromKey, boolean fromInclusive, java.lang.Short toKey, boolean toInclusive) Deprecated.
default Short2IntNavigableMap	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Short2IntNavigableMap	subMap(java.lang.Short fromKey, java.lang.Short toKey) Deprecated.
default Short2IntNavigableMap	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Short2IntNavigableMap	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Short2IntNavigableMap	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Short2IntNavigableMap	tailMap(java.lang.Short fromKey) Deprecated.
Short2IntNavigableMap	tailMap(short fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Short2IntNavigableMap	tailMap(java.lang.Short fromKey, boolean inclusive) Deprecated.
default Short2IntNavigableMap	unmodifiable() Creates a Wrapped NavigableMap that is unmodifiable

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

comparator, firstIntValue, firstKey, firstShortKey, lastIntValue, lastKey, lastShortKey, pollFirstShortKey, pollLastShortKey, values

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

addTo, addToAll, applyAsInt, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, short2IntEntrySet, subFrom, supplyIntIfAbsent

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

copy

Short2IntNavigableMap copy()

Description copied from interface: Short2IntMap

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 Short2IntMap

Specified by:

copy in interface Short2IntSortedMap

Returns:

a Shallow Copy of the Map

descendingMap

Short2IntNavigableMap descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

ShortNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

ShortNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Short2IntMap.Entry firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Short2IntMap.Entry lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Short2IntMap.Entry pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Short2IntMap.Entry pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

ShortNavigableSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2IntMap

Specified by:

keySet in interface Short2IntSortedMap

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Short2IntNavigableMap synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Short2IntMap

Specified by:

synchronize in interface Short2IntSortedMap

Returns:

a new NavigableMap that is synchronized

See Also:

Short2IntMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2IntMap)

synchronize

default Short2IntNavigableMap synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Short2IntMap

Specified by:

synchronize in interface Short2IntSortedMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Short2IntMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2IntMap)

unmodifiable

default Short2IntNavigableMap unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Short2IntMap

Specified by:

unmodifiable in interface Short2IntSortedMap

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Short2IntMaps.unmodifiable(speiger.src.collections.shorts.maps.interfaces.Short2IntMap)

subMap

Short2IntNavigableMap subMap(short fromKey,
                             boolean fromInclusive,
                             short 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

Short2IntNavigableMap headMap(short 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

Short2IntNavigableMap tailMap(short 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 Short2IntNavigableMap subMap(short fromKey,
                                     short toKey)

Description copied from interface: Short2IntSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2IntSortedMap

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 Short2IntNavigableMap headMap(short toKey)

Description copied from interface: Short2IntSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2IntSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Short2IntNavigableMap tailMap(short fromKey)

Description copied from interface: Short2IntSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2IntSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(short e)

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

Parameters:

e - the new max value

getDefaultMaxValue

short getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(short e)

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

Parameters:

e - the new min value

getDefaultMinValue

short getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

short lowerKey(short 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

short higherKey(short 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

short floorKey(short 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

short ceilingKey(short 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

Short2IntMap.Entry lowerEntry(short 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

Short2IntMap.Entry higherEntry(short 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

Short2IntMap.Entry floorEntry(short 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

Short2IntMap.Entry ceilingEntry(short 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.Short lowerKey(java.lang.Short key)

Deprecated.

Specified by:

lowerKey in interface java.util.NavigableMap<java.lang.Short,java.lang.Integer>

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Short2IntMap.Entry lowerEntry(java.lang.Short key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Short2IntMap.Entry floorEntry(java.lang.Short key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Short2IntMap.Entry ceilingEntry(java.lang.Short key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Short2IntMap.Entry higherEntry(java.lang.Short key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2IntNavigableMap subMap(java.lang.Short fromKey,
                                                  boolean fromInclusive,
                                                  java.lang.Short toKey,
                                                  boolean toInclusive)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Short2IntNavigableMap headMap(java.lang.Short toKey,
                                                   boolean inclusive)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Short2IntNavigableMap tailMap(java.lang.Short fromKey,
                                                   boolean inclusive)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2IntNavigableMap subMap(java.lang.Short fromKey,
                                                  java.lang.Short toKey)

Deprecated.

Specified by:

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

Specified by:

subMap in interface Short2IntSortedMap

Specified by:

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

headMap

@Deprecated
default Short2IntNavigableMap headMap(java.lang.Short toKey)

Deprecated.

Specified by:

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

Specified by:

headMap in interface Short2IntSortedMap

Specified by:

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

tailMap

@Deprecated
default Short2IntNavigableMap tailMap(java.lang.Short fromKey)

Deprecated.

Specified by:

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

Specified by:

tailMap in interface Short2IntSortedMap

Specified by:

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