speiger.src.collections.bytes.maps.interfaces

Interface Byte2ByteNavigableMap

All Superinterfaces:

Byte2ByteFunction, Byte2ByteMap, Byte2ByteSortedMap, java.util.Map<java.lang.Byte,java.lang.Byte>, java.util.NavigableMap<java.lang.Byte,java.lang.Byte>, java.util.SortedMap<java.lang.Byte,java.lang.Byte>

All Known Implementing Classes:

Byte2ByteAVLTreeMap, Byte2ByteMaps.SynchronizedNavigableMap, Byte2ByteMaps.UnmodifyableNavigableMap, Byte2ByteRBTreeMap

public interface Byte2ByteNavigableMap
extends Byte2ByteSortedMap, java.util.NavigableMap<java.lang.Byte,java.lang.Byte>

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

Byte2ByteSortedMap.FastSortedSet

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

Byte2ByteMap.BuilderCache, Byte2ByteMap.Entry, Byte2ByteMap.FastEntrySet, Byte2ByteMap.MapBuilder

Method Summary

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

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

comparator, firstByteKey, firstByteValue, firstKey, lastByteKey, lastByteValue, lastKey, pollFirstByteKey, pollLastByteKey, values

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

addTo, addToAll, builder, byte2ByteEntrySet, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue, subFrom, supplyByteIfAbsent

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

copy

Byte2ByteNavigableMap copy()

Description copied from interface: Byte2ByteMap

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 Byte2ByteMap

Specified by:

copy in interface Byte2ByteSortedMap

Returns:

a Shallow Copy of the Map

descendingMap

Byte2ByteNavigableMap descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

ByteNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

ByteNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Byte2ByteMap.Entry firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Byte2ByteMap.Entry lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Byte2ByteMap.Entry pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Byte2ByteMap.Entry pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

ByteNavigableSet keySet()

Specified by:

keySet in interface Byte2ByteMap

Specified by:

keySet in interface Byte2ByteSortedMap

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Byte2ByteNavigableMap synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Byte2ByteMap

Specified by:

synchronize in interface Byte2ByteSortedMap

Returns:

a new NavigableMap that is synchronized

See Also:

Byte2ByteMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ByteMap)

synchronize

default Byte2ByteNavigableMap synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Byte2ByteMap

Specified by:

synchronize in interface Byte2ByteSortedMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Byte2ByteMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ByteMap)

unmodifiable

default Byte2ByteNavigableMap unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Byte2ByteMap

Specified by:

unmodifiable in interface Byte2ByteSortedMap

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Byte2ByteMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2ByteMap)

subMap

Byte2ByteNavigableMap 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

Byte2ByteNavigableMap 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

Byte2ByteNavigableMap 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 Byte2ByteNavigableMap subMap(byte fromKey,
                                     byte toKey)

Description copied from interface: Byte2ByteSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Byte2ByteSortedMap

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 Byte2ByteNavigableMap headMap(byte toKey)

Description copied from interface: Byte2ByteSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Byte2ByteSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Byte2ByteNavigableMap tailMap(byte fromKey)

Description copied from interface: Byte2ByteSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Byte2ByteSortedMap

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

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

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

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

Byte2ByteMap.Entry 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,java.lang.Byte>

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Byte2ByteMap.Entry lowerEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Byte2ByteMap.Entry floorEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Byte2ByteMap.Entry ceilingEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Byte2ByteMap.Entry higherEntry(java.lang.Byte key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Byte2ByteNavigableMap 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,java.lang.Byte>

headMap

@Deprecated
default Byte2ByteNavigableMap headMap(java.lang.Byte toKey,
                                                   boolean inclusive)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Byte2ByteNavigableMap tailMap(java.lang.Byte fromKey,
                                                   boolean inclusive)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Byte2ByteNavigableMap subMap(java.lang.Byte fromKey,
                                                  java.lang.Byte toKey)

Deprecated.

Specified by:

subMap in interface Byte2ByteSortedMap

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Byte2ByteNavigableMap headMap(java.lang.Byte toKey)

Deprecated.

Specified by:

headMap in interface Byte2ByteSortedMap

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Byte2ByteNavigableMap tailMap(java.lang.Byte fromKey)

Deprecated.

Specified by:

tailMap in interface Byte2ByteSortedMap

Specified by:

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

Specified by:

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