speiger.src.collections.bytes.maps.interfaces

Interface Byte2CharSortedMap

All Superinterfaces:

Byte2CharFunction, Byte2CharMap, java.util.Map<java.lang.Byte,java.lang.Character>, java.util.SortedMap<java.lang.Byte,java.lang.Character>

All Known Subinterfaces:

Byte2CharNavigableMap

All Known Implementing Classes:

Byte2CharArrayMap, Byte2CharAVLTreeMap, Byte2CharLinkedOpenCustomHashMap, Byte2CharLinkedOpenHashMap, Byte2CharMaps.SynchronizedNavigableMap, Byte2CharMaps.SynchronizedSortedMap, Byte2CharMaps.UnmodifyableNavigableMap, Byte2CharMaps.UnmodifyableSortedMap, Byte2CharRBTreeMap

public interface Byte2CharSortedMap
extends java.util.SortedMap<java.lang.Byte,java.lang.Character>, Byte2CharMap

A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Byte2CharSortedMap.FastSortedSet Fast Sorted Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

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

Byte2CharMap.Entry, Byte2CharMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
ByteComparator	comparator()
byte	firstByteKey() A method to get the first Key of a Map.
char	firstCharValue() A method to get the first Value of a Map.
default java.lang.Byte	firstKey() Deprecated.
char	getAndMoveToFirst(byte key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(byte key) A Specific get method that allows to move teh given key/value int the last index.
Byte2CharSortedMap	headMap(byte toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Byte2CharSortedMap	headMap(java.lang.Byte toKey) Deprecated.
ByteSet	keySet()
byte	lastByteKey() A method to get the last Key of a Map.
char	lastCharValue() A method to get the last Value of a Map.
default java.lang.Byte	lastKey() Deprecated.
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.
char	putAndMoveToFirst(byte key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(byte key, char value) A customized put method that allows you to insert into the last index.
Byte2CharSortedMap	subMap(byte fromKey, byte toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Byte2CharSortedMap	subMap(java.lang.Byte fromKey, java.lang.Byte toKey) Deprecated.
Byte2CharSortedMap	tailMap(byte fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Byte2CharSortedMap	tailMap(java.lang.Byte fromKey) Deprecated.
CharCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

addTo, addToAll, byte2CharEntrySet, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remByte, remByteOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

char putAndMoveToFirst(byte key,
                       char value)

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

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)

Note:

some implementations do not support this method

putAndMoveToLast

char putAndMoveToLast(byte key,
                      char value)

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

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)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(byte key)

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

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(byte key)

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

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

getAndMoveToFirst

char getAndMoveToFirst(byte key)

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

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

getAndMoveToLast

char getAndMoveToLast(byte key)

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

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

comparator

ByteComparator comparator()

Specified by:

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

keySet

ByteSet keySet()

Specified by:

keySet in interface Byte2CharMap

Specified by:

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

Specified by:

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

values

CharCollection values()

Specified by:

values in interface Byte2CharMap

Specified by:

values in interface java.util.Map<java.lang.Byte,java.lang.Character>

Specified by:

values in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

subMap

Byte2CharSortedMap subMap(byte fromKey,
                          byte toKey)

A Type Specific SubMap method to reduce boxing/unboxing

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

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headMap

Byte2CharSortedMap headMap(byte toKey)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailMap

Byte2CharSortedMap tailMap(byte fromKey)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

firstByteKey

byte firstByteKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstByteKey

byte pollFirstByteKey()

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

Returns:

the first key in the map

lastByteKey

byte lastByteKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastByteKey

byte pollLastByteKey()

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

Returns:

the last key in the map

firstCharValue

char firstCharValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastCharValue

char lastCharValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

firstKey

@Deprecated
default java.lang.Byte firstKey()

Deprecated.

Specified by:

firstKey in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

lastKey

@Deprecated
default java.lang.Byte lastKey()

Deprecated.

Specified by:

lastKey in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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