speiger.src.collections.shorts.maps.interfaces

Interface Short2ObjectNavigableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Superinterfaces:

java.util.Map<java.lang.Short,V>, java.util.NavigableMap<java.lang.Short,V>, Short2ObjectMap<V>, Short2ObjectSortedMap<V>, ShortFunction<V>, java.util.SortedMap<java.lang.Short,V>

All Known Implementing Classes:

Short2ObjectAVLTreeMap, Short2ObjectMaps.SynchronizedNavigableMap, Short2ObjectMaps.UnmodifyableNavigableMap, Short2ObjectRBTreeMap

public interface Short2ObjectNavigableMap<V>
extends Short2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Short,V>

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.Short2ObjectSortedMap

Short2ObjectSortedMap.FastSortedSet<V>

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

Short2ObjectMap.BuilderCache<V>, Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>, Short2ObjectMap.MapBuilder

Method Summary

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

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

comparator, firstKey, firstShortKey, firstValue, lastKey, lastShortKey, lastValue, pollFirstShortKey, pollLastShortKey, values

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

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, short2ObjectEntrySet, supplyIfAbsent

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

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

Method Detail

copy

Short2ObjectNavigableMap<V> copy()

Description copied from interface: Short2ObjectMap

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 Short2ObjectMap<V>

Specified by:

copy in interface Short2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Short2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

ShortNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

ShortNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Short2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Short2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Short2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Short2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

ShortNavigableSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ObjectMap<V>

Specified by:

keySet in interface Short2ObjectSortedMap<V>

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Short2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Short2ObjectMap<V>

Specified by:

synchronize in interface Short2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

synchronize

default Short2ObjectNavigableMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Short2ObjectMap<V>

Specified by:

synchronize in interface Short2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

unmodifiable

default Short2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Short2ObjectMap<V>

Specified by:

unmodifiable in interface Short2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Short2ObjectMaps.unmodifiable(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

subMap

Short2ObjectNavigableMap<V> 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

Short2ObjectNavigableMap<V> 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

Short2ObjectNavigableMap<V> 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 Short2ObjectNavigableMap<V> subMap(short fromKey,
                                           short toKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2ObjectSortedMap<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 Short2ObjectNavigableMap<V> headMap(short toKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Short2ObjectNavigableMap<V> tailMap(short fromKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2ObjectSortedMap<V>

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

Short2ObjectMap.Entry<V> 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

Short2ObjectMap.Entry<V> 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

Short2ObjectMap.Entry<V> 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

Short2ObjectMap.Entry<V> 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,V>

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Short2ObjectMap.Entry<V> lowerEntry(java.lang.Short key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Short2ObjectMap.Entry<V> floorEntry(java.lang.Short key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Short2ObjectMap.Entry<V> ceilingEntry(java.lang.Short key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Short2ObjectMap.Entry<V> higherEntry(java.lang.Short key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2ObjectNavigableMap<V> 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,V>

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2ObjectNavigableMap<V> subMap(java.lang.Short fromKey,
                                                        java.lang.Short toKey)

Deprecated.

Specified by:

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

Specified by:

subMap in interface Short2ObjectSortedMap<V>

Specified by:

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

headMap

@Deprecated
default Short2ObjectNavigableMap<V> headMap(java.lang.Short toKey)

Deprecated.

Specified by:

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

Specified by:

headMap in interface Short2ObjectSortedMap<V>

Specified by:

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

tailMap

@Deprecated
default Short2ObjectNavigableMap<V> tailMap(java.lang.Short fromKey)

Deprecated.

Specified by:

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

Specified by:

tailMap in interface Short2ObjectSortedMap<V>

Specified by:

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