speiger.src.collections.bytes.utils.maps

Class Byte2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap<V>

speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

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

Enclosing class:

Byte2ObjectMaps

public static class Byte2ObjectMaps.UnmodifyableNavigableMap<V>
extends Byte2ObjectMaps.UnmodifyableSortedMap<V>
implements Byte2ObjectNavigableMap<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.bytes.maps.abstracts.AbstractByte2ObjectMap

AbstractByte2ObjectMap.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.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.
byte	ceilingKey(byte key) A Type Specific ceilingKey method to reduce boxing/unboxing.
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.
byte	floorKey(byte key) A Type Specific floorKey method to reduce boxing/unboxing.
byte	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
byte	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Byte2ObjectNavigableMap<V>	headMap(byte toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Byte2ObjectNavigableMap<V>	headMap(byte toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Byte2ObjectMap.Entry<V>	higherEntry(byte key) A Type Specific higherEntry method to reduce boxing/unboxing.
byte	higherKey(byte key) A Type Specific higherKey method to reduce boxing/unboxing.
ByteNavigableSet	keySet()
Byte2ObjectMap.Entry<V>	lastEntry()
Byte2ObjectMap.Entry<V>	lowerEntry(byte key) A Type Specific lowerEntry method to reduce boxing/unboxing.
byte	lowerKey(byte key) A Type Specific lowerKey method to reduce boxing/unboxing.
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
Byte2ObjectNavigableMap<V>	subMap(byte fromKey, byte toKey) A Type Specific SubMap method to reduce boxing/unboxing
Byte2ObjectNavigableMap<V>	tailMap(byte fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Byte2ObjectNavigableMap<V>	tailMap(byte fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableSortedMap

comparator, firstByteKey, firstValue, lastByteKey, lastValue, pollFirstByteKey, pollLastByteKey

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap

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

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap

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.bytes.maps.interfaces.Byte2ObjectNavigableMap

ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, synchronize, synchronize, tailMap, tailMap, 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

builder, byte2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, 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

descendingMap

public Byte2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public ByteNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public ByteNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Byte2ObjectMap<V>

Specified by:

keySet in interface Byte2ObjectNavigableMap<V>

Specified by:

keySet in interface Byte2ObjectSortedMap<V>

Overrides:

keySet in class Byte2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public ByteNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Byte2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Byte2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Byte2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Byte2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Byte2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Byte2ObjectNavigableMap<V> subMap(byte fromKey,
                                         boolean fromInclusive,
                                         byte toKey,
                                         boolean toInclusive)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

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

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Byte2ObjectNavigableMap<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 Byte2ObjectNavigableMap<V> tailMap(byte fromKey,
                                          boolean inclusive)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Byte2ObjectNavigableMap<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 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 Byte2ObjectNavigableMap<V>

Specified by:

subMap in interface Byte2ObjectSortedMap<V>

Overrides:

subMap in class Byte2ObjectMaps.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 Byte2ObjectNavigableMap<V> headMap(byte toKey)

Description copied from interface: Byte2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Byte2ObjectNavigableMap<V>

Specified by:

headMap in interface Byte2ObjectSortedMap<V>

Overrides:

headMap in class Byte2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Byte2ObjectNavigableMap<V> tailMap(byte fromKey)

Description copied from interface: Byte2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Byte2ObjectNavigableMap<V>

Specified by:

tailMap in interface Byte2ObjectSortedMap<V>

Overrides:

tailMap in class Byte2ObjectMaps.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(byte e)

Description copied from interface: Byte2ObjectNavigableMap

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

Specified by:

setDefaultMaxValue in interface Byte2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public byte getDefaultMaxValue()

Description copied from interface: Byte2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Byte2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(byte e)

Description copied from interface: Byte2ObjectNavigableMap

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

Specified by:

setDefaultMinValue in interface Byte2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public byte getDefaultMinValue()

Description copied from interface: Byte2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Byte2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public byte lowerKey(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public byte higherKey(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public byte floorKey(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public byte ceilingKey(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Byte2ObjectMap.Entry<V> lowerEntry(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Byte2ObjectMap.Entry<V> higherEntry(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Byte2ObjectMap.Entry<V> floorEntry(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Byte2ObjectMap.Entry<V> ceilingEntry(byte key)

Description copied from interface: Byte2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Byte2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

copy

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

Specified by:

copy in interface Byte2ObjectSortedMap<V>

Overrides:

copy in class Byte2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map