speiger.src.collections.bytes.maps.interfaces

Interface Byte2ShortSortedMap

All Superinterfaces:

Byte2ShortFunction, Byte2ShortMap, java.util.Map<java.lang.Byte,java.lang.Short>, java.util.SortedMap<java.lang.Byte,java.lang.Short>

All Known Subinterfaces:

Byte2ShortNavigableMap

All Known Implementing Classes:

Byte2ShortAVLTreeMap, Byte2ShortMaps.SynchronizedNavigableMap, Byte2ShortMaps.SynchronizedSortedMap, Byte2ShortMaps.UnmodifyableNavigableMap, Byte2ShortMaps.UnmodifyableSortedMap, Byte2ShortRBTreeMap

public interface Byte2ShortSortedMap
extends java.util.SortedMap<java.lang.Byte,java.lang.Short>, Byte2ShortMap

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Byte2ShortSortedMap.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.Byte2ShortMap

Byte2ShortMap.BuilderCache, Byte2ShortMap.Entry, Byte2ShortMap.FastEntrySet, Byte2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
ByteComparator	comparator()
Byte2ShortSortedMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteKey() A method to get the first Key of a Map.
default java.lang.Byte	firstKey() Deprecated.
short	firstShortValue() A method to get the first Value of a Map.
Byte2ShortSortedMap	headMap(byte toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Byte2ShortSortedMap	headMap(java.lang.Byte toKey) Deprecated.
ByteSortedSet	keySet()
byte	lastByteKey() A method to get the last Key of a Map.
default java.lang.Byte	lastKey() Deprecated.
short	lastShortValue() A method to get the last Value of a Map.
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.
Byte2ShortSortedMap	subMap(byte fromKey, byte toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Byte2ShortSortedMap	subMap(java.lang.Byte fromKey, java.lang.Byte toKey) Deprecated.
default Byte2ShortSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Byte2ShortSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Byte2ShortSortedMap	tailMap(byte fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Byte2ShortSortedMap	tailMap(java.lang.Byte fromKey) Deprecated.
default Byte2ShortSortedMap	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.bytes.maps.interfaces.Byte2ShortMap

addTo, addToAll, builder, byte2ShortEntrySet, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, 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

ByteComparator comparator()

Specified by:

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

copy

Byte2ShortSortedMap copy()

Description copied from interface: Byte2ShortMap

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 Byte2ShortMap

Returns:

a Shallow Copy of the Map

keySet

ByteSortedSet keySet()

Specified by:

keySet in interface Byte2ShortMap

Specified by:

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

Specified by:

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

values

ShortCollection values()

Specified by:

values in interface Byte2ShortMap

Specified by:

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

Specified by:

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

synchronize

default Byte2ShortSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2ShortMap

Returns:

a new SortedMap that is synchronized

See Also:

Byte2ShortMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ShortMap)

synchronize

default Byte2ShortSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2ShortMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Byte2ShortMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2ShortMap)

unmodifiable

default Byte2ShortSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Byte2ShortMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Byte2ShortMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2ShortMap)

subMap

Byte2ShortSortedMap 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

Byte2ShortSortedMap 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

Byte2ShortSortedMap 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

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Byte lastKey()

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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