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:

Long2ShortAVLTreeMap, 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.

Note:

Long2ShortOrderedMap is only extended until 0.6.0 for Compat reasons. The supported classes already implement Long2ShortOrderedMap directly and will remove Long2ShortSortedMap implementations in favor of Long2ShortOrderedMap instead

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.BuilderCache, Long2ShortMap.Entry, Long2ShortMap.FastEntrySet, Long2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
LongComparator	comparator()
Long2ShortSortedMap	copy() A Function that does a shallow clone of the Map itself.
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.
Long2ShortSortedMap	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Long2ShortSortedMap	headMap(java.lang.Long toKey) Deprecated.
LongSortedSet	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.
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.
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.
default Long2ShortSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Long2ShortSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Long2ShortSortedMap	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Long2ShortSortedMap	tailMap(java.lang.Long fromKey) Deprecated.
default Long2ShortSortedMap	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
ShortCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

addTo, addToAll, applyAsShort, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, long2ShortEntrySet, merge, mergeAllShort, mergeShort, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

comparator

LongComparator comparator()

Specified by:

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

copy

Long2ShortSortedMap copy()

Description copied from interface: Long2ShortMap

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface Long2ShortMap

Returns:

a Shallow Copy of the Map

keySet

LongSortedSet 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>

synchronize

default Long2ShortSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Long2ShortMap

Returns:

a new SortedMap that is synchronized

See Also:

Long2ShortMaps.synchronize(speiger.src.collections.longs.maps.interfaces.Long2ShortMap)

synchronize

default Long2ShortSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Long2ShortMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Long2ShortMaps.synchronize(speiger.src.collections.longs.maps.interfaces.Long2ShortMap)

unmodifiable

default Long2ShortSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Long2ShortMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Long2ShortMaps.unmodifiable(speiger.src.collections.longs.maps.interfaces.Long2ShortMap)

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>