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:

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

Note:

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

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

Method Summary

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

Methods inherited from interface java.util.SortedMap

entrySet

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

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, short2CharEntrySet, subFrom, supplyCharIfAbsent

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

comparator

ShortComparator comparator()

Specified by:

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

copy

Short2CharSortedMap copy()

Description copied from interface: Short2CharMap

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 Short2CharMap

Returns:

a Shallow Copy of the Map

keySet

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

synchronize

default Short2CharSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Short2CharMap

Returns:

a new SortedMap that is synchronized

See Also:

Short2CharMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2CharMap)

synchronize

default Short2CharSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Short2CharMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Short2CharMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2CharMap)

unmodifiable

default Short2CharSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Short2CharMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Short2CharMaps.unmodifiable(speiger.src.collections.shorts.maps.interfaces.Short2CharMap)

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>