speiger.src.collections.ints.maps.interfaces

Interface Int2ObjectNavigableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Superinterfaces:

Int2ObjectMap<V>, Int2ObjectSortedMap<V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.NavigableMap<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>

All Known Implementing Classes:

Int2ObjectAVLTreeMap, Int2ObjectMaps.SynchronizedNavigableMap, Int2ObjectMaps.UnmodifyableNavigableMap, Int2ObjectRBTreeMap

public interface Int2ObjectNavigableMap<V>
extends Int2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Integer,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Int2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

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

Method Summary

Modifier and Type	Method and Description
Int2ObjectMap.Entry<V>	ceilingEntry(int key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Int2ObjectMap.Entry<V>	ceilingEntry(java.lang.Integer key) Deprecated.
int	ceilingKey(int key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Integer	ceilingKey(java.lang.Integer key) Deprecated.
Int2ObjectNavigableMap<V>	copy() A Function that does a shallow clone of the Map itself.
IntNavigableSet	descendingKeySet()
Int2ObjectNavigableMap<V>	descendingMap()
Int2ObjectMap.Entry<V>	firstEntry()
Int2ObjectMap.Entry<V>	floorEntry(int key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Int2ObjectMap.Entry<V>	floorEntry(java.lang.Integer key) Deprecated.
int	floorKey(int key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Integer	floorKey(java.lang.Integer key) Deprecated.
int	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
int	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Int2ObjectNavigableMap<V>	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Int2ObjectNavigableMap<V>	headMap(int toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
default Int2ObjectNavigableMap<V>	headMap(java.lang.Integer toKey) Deprecated.
default Int2ObjectNavigableMap<V>	headMap(java.lang.Integer toKey, boolean inclusive) Deprecated.
Int2ObjectMap.Entry<V>	higherEntry(int key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Int2ObjectMap.Entry<V>	higherEntry(java.lang.Integer key) Deprecated.
int	higherKey(int key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Integer	higherKey(java.lang.Integer key) Deprecated.
IntNavigableSet	keySet()
Int2ObjectMap.Entry<V>	lastEntry()
Int2ObjectMap.Entry<V>	lowerEntry(int key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Int2ObjectMap.Entry<V>	lowerEntry(java.lang.Integer key) Deprecated.
int	lowerKey(int key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Integer	lowerKey(java.lang.Integer key) Deprecated.
IntNavigableSet	navigableKeySet()
Int2ObjectMap.Entry<V>	pollFirstEntry()
Int2ObjectMap.Entry<V>	pollLastEntry()
void	setDefaultMaxValue(int e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(int e) A Helper method to set the min value for SubMaps.
Int2ObjectNavigableMap<V>	subMap(int fromKey, boolean fromInclusive, int toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Int2ObjectNavigableMap<V>	subMap(java.lang.Integer fromKey, boolean fromInclusive, java.lang.Integer toKey, boolean toInclusive) Deprecated.
default Int2ObjectNavigableMap<V>	subMap(java.lang.Integer fromKey, java.lang.Integer toKey) Deprecated.
default Int2ObjectNavigableMap<V>	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Int2ObjectNavigableMap<V>	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Int2ObjectNavigableMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Int2ObjectNavigableMap<V>	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Int2ObjectNavigableMap<V>	tailMap(int fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Int2ObjectNavigableMap<V>	tailMap(java.lang.Integer fromKey) Deprecated.
default Int2ObjectNavigableMap<V>	tailMap(java.lang.Integer fromKey, boolean inclusive) Deprecated.
default Int2ObjectNavigableMap<V>	unmodifiable() Creates a Wrapped NavigableMap that is unmodifiable

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

comparator, firstIntKey, firstKey, firstValue, lastIntKey, lastKey, lastValue, pollFirstIntKey, pollLastIntKey, values

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, int2ObjectEntrySet, 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, 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

Int2ObjectNavigableMap<V> copy()

Description copied from interface: Int2ObjectMap

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

Specified by:

copy in interface Int2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Int2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

IntNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

IntNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Int2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Int2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Int2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Int2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

IntNavigableSet keySet()

Specified by:

keySet in interface Int2ObjectMap<V>

Specified by:

keySet in interface Int2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Int2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Int2ObjectMap<V>

Specified by:

synchronize in interface Int2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

synchronize

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

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Int2ObjectMap<V>

Specified by:

synchronize in interface Int2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

unmodifiable

default Int2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Int2ObjectMap<V>

Specified by:

unmodifiable in interface Int2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Int2ObjectMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

subMap

Int2ObjectNavigableMap<V> subMap(int fromKey,
                                 boolean fromInclusive,
                                 int 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

Int2ObjectNavigableMap<V> headMap(int 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

Int2ObjectNavigableMap<V> tailMap(int 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 Int2ObjectNavigableMap<V> subMap(int fromKey,
                                         int toKey)

Description copied from interface: Int2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2ObjectSortedMap<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 Int2ObjectNavigableMap<V> headMap(int toKey)

Description copied from interface: Int2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Int2ObjectNavigableMap<V> tailMap(int fromKey)

Description copied from interface: Int2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(int e)

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

Parameters:

e - the new max value

getDefaultMaxValue

int getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(int e)

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

Parameters:

e - the new min value

getDefaultMinValue

int getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

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

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

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

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

Int2ObjectMap.Entry<V> lowerEntry(int 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

Int2ObjectMap.Entry<V> higherEntry(int 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

Int2ObjectMap.Entry<V> floorEntry(int 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

Int2ObjectMap.Entry<V> ceilingEntry(int 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.Integer lowerKey(java.lang.Integer key)

Deprecated.

Specified by:

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

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Int2ObjectMap.Entry<V> lowerEntry(java.lang.Integer key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Int2ObjectMap.Entry<V> floorEntry(java.lang.Integer key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Int2ObjectMap.Entry<V> ceilingEntry(java.lang.Integer key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Int2ObjectMap.Entry<V> higherEntry(java.lang.Integer key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Int2ObjectNavigableMap<V> subMap(java.lang.Integer fromKey,
                                                      boolean fromInclusive,
                                                      java.lang.Integer toKey,
                                                      boolean toInclusive)

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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

subMap

@Deprecated
default Int2ObjectNavigableMap<V> subMap(java.lang.Integer fromKey,
                                                      java.lang.Integer toKey)

Deprecated.

Specified by:

subMap in interface Int2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Int2ObjectNavigableMap<V> headMap(java.lang.Integer toKey)

Deprecated.

Specified by:

headMap in interface Int2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Int2ObjectNavigableMap<V> tailMap(java.lang.Integer fromKey)

Deprecated.

Specified by:

tailMap in interface Int2ObjectSortedMap<V>

Specified by:

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

Specified by:

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