speiger.src.collections.chars.maps.interfaces

Interface Char2ShortSortedMap

All Superinterfaces:

Char2ShortFunction, Char2ShortMap, java.util.Map<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>

All Known Subinterfaces:

Char2ShortNavigableMap

All Known Implementing Classes:

Char2ShortAVLTreeMap, Char2ShortMaps.SynchronizedNavigableMap, Char2ShortMaps.SynchronizedSortedMap, Char2ShortMaps.UnmodifyableNavigableMap, Char2ShortMaps.UnmodifyableSortedMap, Char2ShortRBTreeMap

public interface Char2ShortSortedMap
extends java.util.SortedMap<java.lang.Character,java.lang.Short>, Char2ShortMap

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Char2ShortSortedMap.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.chars.maps.interfaces.Char2ShortMap

Char2ShortMap.BuilderCache, Char2ShortMap.Entry, Char2ShortMap.FastEntrySet, Char2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator()
Char2ShortSortedMap	copy() A Function that does a shallow clone of the Map itself.
char	firstCharKey() A method to get the first Key of a Map.
default java.lang.Character	firstKey() Deprecated.
short	firstShortValue() A method to get the first Value of a Map.
Char2ShortSortedMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2ShortSortedMap	headMap(java.lang.Character toKey) Deprecated.
CharSortedSet	keySet()
char	lastCharKey() A method to get the last Key of a Map.
default java.lang.Character	lastKey() Deprecated.
short	lastShortValue() A method to get the last Value of a Map.
char	pollFirstCharKey() A method to get and remove the first Key of a Map.
char	pollLastCharKey() A method to get and remove the last Key of a Map.
default Char2ShortSortedMap	subMap(java.lang.Character fromKey, java.lang.Character toKey) Deprecated.
Char2ShortSortedMap	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Char2ShortSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Char2ShortSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Char2ShortSortedMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ShortSortedMap	tailMap(java.lang.Character fromKey) Deprecated.
default Char2ShortSortedMap	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.chars.maps.interfaces.Char2ShortMap

addTo, addToAll, builder, char2ShortEntrySet, 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

CharComparator comparator()

Specified by:

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

copy

Char2ShortSortedMap copy()

Description copied from interface: Char2ShortMap

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 Char2ShortMap

Returns:

a Shallow Copy of the Map

keySet

CharSortedSet keySet()

Specified by:

keySet in interface Char2ShortMap

Specified by:

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

Specified by:

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

values

ShortCollection values()

Specified by:

values in interface Char2ShortMap

Specified by:

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

Specified by:

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

synchronize

default Char2ShortSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2ShortMap

Returns:

a new SortedMap that is synchronized

See Also:

Char2ShortMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

synchronize

default Char2ShortSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2ShortMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Char2ShortMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

unmodifiable

default Char2ShortSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Char2ShortMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Char2ShortMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2ShortMap)

subMap

Char2ShortSortedMap subMap(char fromKey,
                           char 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

Char2ShortSortedMap headMap(char 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

Char2ShortSortedMap tailMap(char 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.

firstCharKey

char firstCharKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstCharKey

char pollFirstCharKey()

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

Returns:

the first key in the map

lastCharKey

char lastCharKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastCharKey

char pollLastCharKey()

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Character lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Char2ShortSortedMap subMap(java.lang.Character fromKey,
                                                java.lang.Character toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Char2ShortSortedMap headMap(java.lang.Character toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Char2ShortSortedMap tailMap(java.lang.Character fromKey)

Deprecated.

Specified by:

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