speiger.src.collections.bytes.utils.maps

Class Byte2ShortMaps.UnmodifyableSortedMap

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2ShortMap

speiger.src.collections.bytes.utils.maps.Byte2ShortMaps.UnmodifyableMap

speiger.src.collections.bytes.utils.maps.Byte2ShortMaps.UnmodifyableSortedMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Short>, java.util.SortedMap<java.lang.Byte,java.lang.Short>, Byte2ShortFunction, Byte2ShortMap, Byte2ShortSortedMap

Direct Known Subclasses:

Byte2ShortMaps.UnmodifyableNavigableMap

Enclosing class:

Byte2ShortMaps

public static class Byte2ShortMaps.UnmodifyableSortedMap
extends Byte2ShortMaps.UnmodifyableMap
implements Byte2ShortSortedMap

The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ShortMap

AbstractByte2ShortMap.BasicEntry

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

Byte2ShortSortedMap.FastSortedSet

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

Byte2ShortMap.Entry, Byte2ShortMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
ByteComparator	comparator()
byte	firstByteKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(byte key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(byte key) A Specific get method that allows to move teh given key/value int the last index.
Byte2ShortSortedMap	headMap(byte toKey) A Type Specific HeadMap method to reduce boxing/unboxing
byte	lastByteKey() A method to get the last Key of a Map.
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(byte key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(byte key) A specific move method to move a given key/value to the last index.
byte	pollFirstByteKey() A method to get and remove the first Key of a Map.
byte	pollLastByteKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(byte key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(byte key, short value) A customized put method that allows you to insert into the last index.
Byte2ShortSortedMap	subMap(byte fromKey, byte toKey) A Type Specific SubMap method to reduce boxing/unboxing
Byte2ShortSortedMap	tailMap(byte fromKey) A Type Specific TailMap method to reduce boxing/unboxing

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

addTo, byte2ShortEntrySet, getOrDefault, getShort, keySet, put, putIfAbsent, remByte, remByteOrDefault, remove, values

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

addToAll, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllShort, mergeShort, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, put, remove, 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.Byte2ShortSortedMap

firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.SortedMap

entrySet

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

addTo, addToAll, byte2ShortEntrySet, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remByte, remByteOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public short putAndMoveToFirst(byte key,
                               short value)

Description copied from interface: Byte2ShortSortedMap

A customized put method that allows you to insert into the first index.

Specified by:

putAndMoveToFirst in interface Byte2ShortSortedMap

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

putAndMoveToLast

public short putAndMoveToLast(byte key,
                              short value)

Description copied from interface: Byte2ShortSortedMap

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Specified by:

putAndMoveToLast in interface Byte2ShortSortedMap

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

moveToFirst

public boolean moveToFirst(byte key)

Description copied from interface: Byte2ShortSortedMap

A specific move method to move a given key/value to the first index.

Specified by:

moveToFirst in interface Byte2ShortSortedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(byte key)

Description copied from interface: Byte2ShortSortedMap

A specific move method to move a given key/value to the last index.

Specified by:

moveToLast in interface Byte2ShortSortedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(byte key)

Description copied from interface: Byte2ShortSortedMap

A Specific get method that allows to move teh given key/value int the first index.

Specified by:

getAndMoveToFirst in interface Byte2ShortSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(byte key)

Description copied from interface: Byte2ShortSortedMap

A Specific get method that allows to move teh given key/value int the last index.

Specified by:

getAndMoveToLast in interface Byte2ShortSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public ByteComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Byte,java.lang.Short>

Specified by:

comparator in interface Byte2ShortSortedMap

subMap

public Byte2ShortSortedMap subMap(byte fromKey,
                                  byte toKey)

Description copied from interface: Byte2ShortSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Byte2ShortSortedMap

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

Description copied from interface: Byte2ShortSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Byte2ShortSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Byte2ShortSortedMap tailMap(byte fromKey)

Description copied from interface: Byte2ShortSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Byte2ShortSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstByteKey

public byte firstByteKey()

Description copied from interface: Byte2ShortSortedMap

A method to get the first Key of a Map.

Specified by:

firstByteKey in interface Byte2ShortSortedMap

Returns:

the first key in the map

pollFirstByteKey

public byte pollFirstByteKey()

Description copied from interface: Byte2ShortSortedMap

A method to get and remove the first Key of a Map.

Specified by:

pollFirstByteKey in interface Byte2ShortSortedMap

Returns:

the first key in the map

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2ShortSortedMap

A method to get the last Key of a Map.

Specified by:

lastByteKey in interface Byte2ShortSortedMap

Returns:

the last key in the map

pollLastByteKey

public byte pollLastByteKey()

Description copied from interface: Byte2ShortSortedMap

A method to get and remove the last Key of a Map.

Specified by:

pollLastByteKey in interface Byte2ShortSortedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Byte2ShortSortedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Byte2ShortSortedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Byte2ShortSortedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Byte2ShortSortedMap

Returns:

the last key in the map