speiger.src.collections.bytes.maps.interfaces

Interface Byte2ObjectNavigableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Superinterfaces:

Byte2ObjectMap<V>, Byte2ObjectSortedMap<V>, ByteFunction<V>, java.util.Map<java.lang.Byte,V>, java.util.NavigableMap<java.lang.Byte,V>, java.util.SortedMap<java.lang.Byte,V>

All Known Implementing Classes:

Byte2ObjectAVLTreeMap, Byte2ObjectMaps.SynchronizedNavigableMap, Byte2ObjectMaps.UnmodifyableNavigableMap, Byte2ObjectRBTreeMap

public interface Byte2ObjectNavigableMap<V>
extends Byte2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Byte,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectSortedMap

Byte2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

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

Method Summary

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

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectSortedMap

comparator, firstByteKey, firstKey, firstValue, lastByteKey, lastKey, lastValue, pollFirstByteKey, pollLastByteKey, values

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

apply, builder, byte2ObjectEntrySet, 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, 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

Byte2ObjectNavigableMap<V> copy()

Description copied from interface: Byte2ObjectMap

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

Specified by:

copy in interface Byte2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Byte2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

ByteNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

ByteNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Byte2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Byte2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Byte2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Byte2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

ByteNavigableSet keySet()

Specified by:

keySet in interface Byte2ObjectMap<V>

Specified by:

keySet in interface Byte2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Byte2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Byte2ObjectMap<V>

Specified by:

synchronize in interface Byte2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Byte2ObjectMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap<V>)

synchronize

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

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Byte2ObjectMap<V>

Specified by:

synchronize in interface Byte2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Byte2ObjectMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap<V>)

unmodifiable

default Byte2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Byte2ObjectMap<V>

Specified by:

unmodifiable in interface Byte2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Byte2ObjectMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap<V>)

subMap

Byte2ObjectNavigableMap<V> subMap(byte fromKey,
                                  boolean fromInclusive,
                                  byte 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

Byte2ObjectNavigableMap<V> headMap(byte 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

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

Description copied from interface: Byte2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Byte2ObjectSortedMap<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 Byte2ObjectNavigableMap<V> headMap(byte toKey)

Description copied from interface: Byte2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Byte2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Byte2ObjectNavigableMap<V> tailMap(byte fromKey)

Description copied from interface: Byte2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Byte2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(byte e)

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

Parameters:

e - the new max value

getDefaultMaxValue

byte getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(byte e)

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

Parameters:

e - the new min value

getDefaultMinValue

byte getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

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

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

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

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

Byte2ObjectMap.Entry<V> lowerEntry(byte 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

Byte2ObjectMap.Entry<V> higherEntry(byte 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

Byte2ObjectMap.Entry<V> floorEntry(byte 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

Byte2ObjectMap.Entry<V> ceilingEntry(byte 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.Byte lowerKey(java.lang.Byte key)

Deprecated.

Specified by:

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

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Byte2ObjectMap.Entry<V> lowerEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Byte2ObjectMap.Entry<V> floorEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Byte2ObjectMap.Entry<V> ceilingEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Byte2ObjectMap.Entry<V> higherEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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

subMap

@Deprecated
default Byte2ObjectNavigableMap<V> subMap(java.lang.Byte fromKey,
                                                       java.lang.Byte toKey)

Deprecated.

Specified by:

subMap in interface Byte2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Byte2ObjectNavigableMap<V> headMap(java.lang.Byte toKey)

Deprecated.

Specified by:

headMap in interface Byte2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Byte2ObjectNavigableMap<V> tailMap(java.lang.Byte fromKey)

Deprecated.

Specified by:

tailMap in interface Byte2ObjectSortedMap<V>

Specified by:

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

Specified by:

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