speiger.src.collections.shorts.maps.interfaces

Interface Short2CharSortedMap

All Superinterfaces:

java.util.Map<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap, java.util.SortedMap<java.lang.Short,java.lang.Character>

All Known Subinterfaces:

Short2CharNavigableMap

All Known Implementing Classes:

Short2CharArrayMap, Short2CharAVLTreeMap, Short2CharLinkedOpenCustomHashMap, Short2CharLinkedOpenHashMap, Short2CharMaps.SynchronizedNavigableMap, Short2CharMaps.SynchronizedSortedMap, Short2CharMaps.UnmodifyableNavigableMap, Short2CharMaps.UnmodifyableSortedMap, Short2CharRBTreeMap

public interface Short2CharSortedMap
extends java.util.SortedMap<java.lang.Short,java.lang.Character>, Short2CharMap

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	Short2CharSortedMap.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.shorts.maps.interfaces.Short2CharMap

Short2CharMap.Entry, Short2CharMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
ShortComparator	comparator()
char	firstCharValue() A method to get the first Value of a Map.
default java.lang.Short	firstKey() Deprecated.
short	firstShortKey() A method to get the first Key of a Map.
char	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
Short2CharSortedMap	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Short2CharSortedMap	headMap(java.lang.Short toKey) Deprecated.
ShortSet	keySet()
char	lastCharValue() A method to get the last Value of a Map.
default java.lang.Short	lastKey() Deprecated.
short	lastShortKey() A method to get the last Key of a Map.
boolean	moveToFirst(short key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(short key) A specific move method to move a given key/value to the last index.
short	pollFirstShortKey() A method to get and remove the first Key of a Map.
short	pollLastShortKey() A method to get and remove the last Key of a Map.
char	putAndMoveToFirst(short key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(short key, char value) A customized put method that allows you to insert into the last index.
Short2CharSortedMap	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Short2CharSortedMap	subMap(java.lang.Short fromKey, java.lang.Short toKey) Deprecated.
Short2CharSortedMap	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Short2CharSortedMap	tailMap(java.lang.Short fromKey) Deprecated.
CharCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

addTo, addToAll, 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, remove, remove, remove, remShort, remShortOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, short2CharEntrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

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

ShortComparator comparator()

Specified by:

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

keySet

ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Specified by:

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

values

CharCollection values()

Specified by:

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

Specified by:

values in interface Short2CharMap

Specified by:

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

subMap

Short2CharSortedMap subMap(short fromKey,
                           short 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

Short2CharSortedMap headMap(short 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

Short2CharSortedMap tailMap(short 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.

firstShortKey

short firstShortKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstShortKey

short pollFirstShortKey()

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

Returns:

the first key in the map

lastShortKey

short lastShortKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastShortKey

short pollLastShortKey()

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.Short firstKey()

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Short lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2CharSortedMap subMap(java.lang.Short fromKey,
                                                java.lang.Short toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Short2CharSortedMap headMap(java.lang.Short toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Short2CharSortedMap tailMap(java.lang.Short fromKey)

Deprecated.

Specified by:

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