speiger.src.collections.longs.maps.interfaces

Interface Long2ShortSortedMap

All Superinterfaces:

Long2ShortFunction, Long2ShortMap, java.util.Map<java.lang.Long,java.lang.Short>, java.util.SortedMap<java.lang.Long,java.lang.Short>

All Known Subinterfaces:

Long2ShortNavigableMap

All Known Implementing Classes:

Long2ShortArrayMap, Long2ShortAVLTreeMap, Long2ShortLinkedOpenCustomHashMap, Long2ShortLinkedOpenHashMap, Long2ShortMaps.SynchronizedNavigableMap, Long2ShortMaps.SynchronizedSortedMap, Long2ShortMaps.UnmodifyableNavigableMap, Long2ShortMaps.UnmodifyableSortedMap, Long2ShortRBTreeMap

public interface Long2ShortSortedMap
extends java.util.SortedMap<java.lang.Long,java.lang.Short>, Long2ShortMap

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	Long2ShortSortedMap.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.longs.maps.interfaces.Long2ShortMap

Long2ShortMap.Entry, Long2ShortMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
LongComparator	comparator()
default java.lang.Long	firstKey() Deprecated.
long	firstLongKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(long key) A Specific get method that allows to move teh given key/value int the last index.
Long2ShortSortedMap	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Long2ShortSortedMap	headMap(java.lang.Long toKey) Deprecated.
LongSet	keySet()
default java.lang.Long	lastKey() Deprecated.
long	lastLongKey() A method to get the last Key of a Map.
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(long key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(long key) A specific move method to move a given key/value to the last index.
long	pollFirstLongKey() A method to get and remove the first Key of a Map.
long	pollLastLongKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(long key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(long key, short value) A customized put method that allows you to insert into the last index.
Long2ShortSortedMap	subMap(long fromKey, long toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Long2ShortSortedMap	subMap(java.lang.Long fromKey, java.lang.Long toKey) Deprecated.
Long2ShortSortedMap	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Long2ShortSortedMap	tailMap(java.lang.Long fromKey) Deprecated.
ShortCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ShortMap

addTo, addToAll, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, long2ShortEntrySet, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remLong, remLongOrDefault, 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(long 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(long 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(long 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(long 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(long 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(long 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

LongComparator comparator()

Specified by:

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

keySet

LongSet keySet()

Specified by:

keySet in interface Long2ShortMap

Specified by:

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

Specified by:

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

values

ShortCollection values()

Specified by:

values in interface Long2ShortMap

Specified by:

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

Specified by:

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

subMap

Long2ShortSortedMap subMap(long fromKey,
                           long 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

Long2ShortSortedMap headMap(long 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

Long2ShortSortedMap tailMap(long 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.

firstLongKey

long firstLongKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstLongKey

long pollFirstLongKey()

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

Returns:

the first key in the map

lastLongKey

long lastLongKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastLongKey

long pollLastLongKey()

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Long lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Long2ShortSortedMap subMap(java.lang.Long fromKey,
                                                java.lang.Long toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Long2ShortSortedMap headMap(java.lang.Long toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Long2ShortSortedMap tailMap(java.lang.Long fromKey)

Deprecated.

Specified by:

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