speiger.src.collections.chars.maps.interfaces

Interface Char2ShortSortedMap

All Superinterfaces:

Char2ShortFunction, Char2ShortMap, java.util.Map<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>

All Known Subinterfaces:

Char2ShortNavigableMap

All Known Implementing Classes:

Char2ShortArrayMap, Char2ShortAVLTreeMap, Char2ShortLinkedOpenCustomHashMap, Char2ShortLinkedOpenHashMap, Char2ShortMaps.SynchronizedNavigableMap, Char2ShortMaps.SynchronizedSortedMap, Char2ShortMaps.UnmodifyableNavigableMap, Char2ShortMaps.UnmodifyableSortedMap, Char2ShortRBTreeMap

public interface Char2ShortSortedMap
extends java.util.SortedMap<java.lang.Character,java.lang.Short>, Char2ShortMap

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	Char2ShortSortedMap.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.chars.maps.interfaces.Char2ShortMap

Char2ShortMap.Entry, Char2ShortMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator()
char	firstCharKey() A method to get the first Key of a Map.
default java.lang.Character	firstKey() Deprecated.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(char key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(char key) A Specific get method that allows to move teh given key/value int the last index.
Char2ShortSortedMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2ShortSortedMap	headMap(java.lang.Character toKey) Deprecated.
CharSet	keySet()
char	lastCharKey() A method to get the last Key of a Map.
default java.lang.Character	lastKey() Deprecated.
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(char key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(char key) A specific move method to move a given key/value to the last index.
char	pollFirstCharKey() A method to get and remove the first Key of a Map.
char	pollLastCharKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(char key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(char key, short value) A customized put method that allows you to insert into the last index.
default Char2ShortSortedMap	subMap(java.lang.Character fromKey, java.lang.Character toKey) Deprecated.
Char2ShortSortedMap	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
Char2ShortSortedMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ShortSortedMap	tailMap(java.lang.Character fromKey) Deprecated.
ShortCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

addTo, addToAll, char2ShortEntrySet, 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, remChar, remCharOrDefault, 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

short putAndMoveToFirst(char key,
                        short 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

short putAndMoveToLast(char key,
                       short 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(char 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(char 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

short getAndMoveToFirst(char 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

short getAndMoveToLast(char 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

CharComparator comparator()

Specified by:

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

keySet

CharSet keySet()

Specified by:

keySet in interface Char2ShortMap

Specified by:

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

Specified by:

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

values

ShortCollection values()

Specified by:

values in interface Char2ShortMap

Specified by:

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

Specified by:

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

subMap

Char2ShortSortedMap subMap(char fromKey,
                           char 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

Char2ShortSortedMap headMap(char 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

Char2ShortSortedMap tailMap(char 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.

firstCharKey

char firstCharKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstCharKey

char pollFirstCharKey()

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

Returns:

the first key in the map

lastCharKey

char lastCharKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastCharKey

char pollLastCharKey()

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

Returns:

the last key in the map

firstShortValue

short firstShortValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastShortValue

short lastShortValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

firstKey

@Deprecated
default java.lang.Character firstKey()

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Character lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Char2ShortSortedMap subMap(java.lang.Character fromKey,
                                                java.lang.Character toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Char2ShortSortedMap headMap(java.lang.Character toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Char2ShortSortedMap tailMap(java.lang.Character fromKey)

Deprecated.

Specified by:

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