speiger.src.collections.shorts.utils.maps

Class Short2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

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

Enclosing class:

Short2ObjectMaps

public static class Short2ObjectMaps.UnmodifyableNavigableMap<V>
extends Short2ObjectMaps.UnmodifyableSortedMap<V>
implements Short2ObjectNavigableMap<V>

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

AbstractShort2ObjectMap.BasicEntry<V>

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.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.
short	ceilingKey(short key) A Type Specific ceilingKey method to reduce boxing/unboxing.
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.
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.
Short2ObjectNavigableMap<V>	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Short2ObjectNavigableMap<V>	headMap(short toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Short2ObjectMap.Entry<V>	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()
Short2ObjectMap.Entry<V>	lastEntry()
Short2ObjectMap.Entry<V>	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()
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
Short2ObjectNavigableMap<V>	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
Short2ObjectNavigableMap<V>	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Short2ObjectNavigableMap<V>	tailMap(short fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

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

comparator, firstShortKey, firstValue, lastShortKey, lastValue, pollFirstShortKey, pollLastShortKey

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

clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, short2ObjectEntrySet, supplyIfAbsent, values

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

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, 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.Short2ObjectNavigableMap

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

descendingMap

public Short2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public ShortNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public ShortNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Short2ObjectMap<V>

Specified by:

keySet in interface Short2ObjectNavigableMap<V>

Specified by:

keySet in interface Short2ObjectSortedMap<V>

Overrides:

keySet in class Short2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public ShortNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Short2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Short2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Short2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Short2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Short2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Short2ObjectNavigableMap<V> subMap(short fromKey,
                                          boolean fromInclusive,
                                          short toKey,
                                          boolean toInclusive)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2ObjectNavigableMap<V>

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 Short2ObjectNavigableMap<V> headMap(short toKey,
                                           boolean inclusive)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2ObjectNavigableMap<V>

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 Short2ObjectNavigableMap<V> tailMap(short fromKey,
                                           boolean inclusive)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2ObjectNavigableMap<V>

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

Specified by:

subMap in interface Short2ObjectSortedMap<V>

Overrides:

subMap in class Short2ObjectMaps.UnmodifyableSortedMap<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

public Short2ObjectNavigableMap<V> headMap(short toKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2ObjectNavigableMap<V>

Specified by:

headMap in interface Short2ObjectSortedMap<V>

Overrides:

headMap in class Short2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Short2ObjectNavigableMap<V> tailMap(short fromKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2ObjectNavigableMap<V>

Specified by:

tailMap in interface Short2ObjectSortedMap<V>

Overrides:

tailMap in class Short2ObjectMaps.UnmodifyableSortedMap<V>

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

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

Specified by:

setDefaultMaxValue in interface Short2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public short getDefaultMaxValue()

Description copied from interface: Short2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Short2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(short e)

Description copied from interface: Short2ObjectNavigableMap

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

Specified by:

setDefaultMinValue in interface Short2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public short getDefaultMinValue()

Description copied from interface: Short2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Short2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public short lowerKey(short key)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Short2ObjectNavigableMap<V>

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

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Short2ObjectNavigableMap<V>

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

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Short2ObjectNavigableMap<V>

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

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Short2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Short2ObjectMap.Entry<V> lowerEntry(short key)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Short2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Short2ObjectMap.Entry<V> higherEntry(short key)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Short2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Short2ObjectMap.Entry<V> floorEntry(short key)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Short2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Short2ObjectMap.Entry<V> ceilingEntry(short key)

Description copied from interface: Short2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Short2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

copy

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

Specified by:

copy in interface Short2ObjectSortedMap<V>

Overrides:

copy in class Short2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map