speiger.src.collections.shorts.maps.interfaces

Interface Short2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<java.lang.Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>, java.util.SortedMap<java.lang.Short,V>

All Known Subinterfaces:

Short2ObjectNavigableMap<V>

All Known Implementing Classes:

Short2ObjectAVLTreeMap, Short2ObjectMaps.SynchronizedNavigableMap, Short2ObjectMaps.SynchronizedSortedMap, Short2ObjectMaps.UnmodifyableNavigableMap, Short2ObjectMaps.UnmodifyableSortedMap, Short2ObjectRBTreeMap

public interface Short2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Short,V>, Short2ObjectMap<V>

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Short2ObjectSortedMap.FastSortedSet<V> 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.Short2ObjectMap

Short2ObjectMap.BuilderCache<V>, Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>, Short2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
ShortComparator	comparator()
Short2ObjectSortedMap<V>	copy() A Function that does a shallow clone of the Map itself.
default java.lang.Short	firstKey() Deprecated.
short	firstShortKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
Short2ObjectSortedMap<V>	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Short2ObjectSortedMap<V>	headMap(java.lang.Short toKey) Deprecated.
ShortSortedSet	keySet()
default java.lang.Short	lastKey() Deprecated.
short	lastShortKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
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.
Short2ObjectSortedMap<V>	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Short2ObjectSortedMap<V>	subMap(java.lang.Short fromKey, java.lang.Short toKey) Deprecated.
default Short2ObjectSortedMap<V>	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Short2ObjectSortedMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Short2ObjectSortedMap<V>	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Short2ObjectSortedMap<V>	tailMap(java.lang.Short fromKey) Deprecated.
default Short2ObjectSortedMap<V>	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, short2ObjectEntrySet, supplyIfAbsent

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

comparator

ShortComparator comparator()

Specified by:

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

copy

Short2ObjectSortedMap<V> copy()

Description copied from interface: Short2ObjectMap

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 Short2ObjectMap<V>

Returns:

a Shallow Copy of the Map

keySet

ShortSortedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ObjectMap<V>

Specified by:

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

values

ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Short2ObjectMap<V>

Specified by:

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

synchronize

default Short2ObjectSortedMap<V> synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Short2ObjectMap<V>

Returns:

a new SortedMap that is synchronized

See Also:

Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

synchronize

default Short2ObjectSortedMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Short2ObjectMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

unmodifiable

default Short2ObjectSortedMap<V> unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Short2ObjectMap<V>

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Short2ObjectMaps.unmodifiable(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

subMap

Short2ObjectSortedMap<V> 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

Short2ObjectSortedMap<V> 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

Short2ObjectSortedMap<V> 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

firstValue

V firstValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastValue

V lastValue()

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,V>

lastKey

@Deprecated
default java.lang.Short lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Short2ObjectSortedMap<V> subMap(java.lang.Short fromKey,
                                                     java.lang.Short toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Short2ObjectSortedMap<V> headMap(java.lang.Short toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Short2ObjectSortedMap<V> tailMap(java.lang.Short fromKey)

Deprecated.

Specified by:

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