speiger.src.collections.doubles.maps.interfaces

Interface Double2CharSortedMap

All Superinterfaces:

Double2CharFunction, Double2CharMap, java.util.Map<java.lang.Double,java.lang.Character>, java.util.SortedMap<java.lang.Double,java.lang.Character>

All Known Subinterfaces:

Double2CharNavigableMap

All Known Implementing Classes:

Double2CharArrayMap, Double2CharAVLTreeMap, Double2CharLinkedOpenCustomHashMap, Double2CharLinkedOpenHashMap, Double2CharMaps.SynchronizedNavigableMap, Double2CharMaps.SynchronizedSortedMap, Double2CharMaps.UnmodifyableNavigableMap, Double2CharMaps.UnmodifyableSortedMap, Double2CharRBTreeMap

public interface Double2CharSortedMap
extends java.util.SortedMap<java.lang.Double,java.lang.Character>, Double2CharMap

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Double2CharSortedMap.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.doubles.maps.interfaces.Double2CharMap

Double2CharMap.Entry, Double2CharMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
DoubleComparator	comparator()
char	firstCharValue() A method to get the first Value of a Map.
double	firstDoubleKey() A method to get the first Key of a Map.
default java.lang.Double	firstKey() Deprecated.
char	getAndMoveToFirst(double key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(double key) A Specific get method that allows to move teh given key/value int the last index.
Double2CharSortedMap	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2CharSortedMap	headMap(java.lang.Double toKey) Deprecated.
DoubleSet	keySet()
char	lastCharValue() A method to get the last Value of a Map.
double	lastDoubleKey() A method to get the last Key of a Map.
default java.lang.Double	lastKey() Deprecated.
boolean	moveToFirst(double key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(double key) A specific move method to move a given key/value to the last index.
double	pollFirstDoubleKey() A method to get and remove the first Key of a Map.
double	pollLastDoubleKey() A method to get and remove the last Key of a Map.
char	putAndMoveToFirst(double key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(double key, char value) A customized put method that allows you to insert into the last index.
Double2CharSortedMap	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Double2CharSortedMap	subMap(java.lang.Double fromKey, java.lang.Double toKey) Deprecated.
Double2CharSortedMap	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Double2CharSortedMap	tailMap(java.lang.Double fromKey) Deprecated.
CharCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2CharMap

addTo, addToAll, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, double2CharEntrySet, entrySet, forEach, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remDouble, remDoubleOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

char putAndMoveToFirst(double key,
                       char value)

A customized put method that allows you to insert into the first index.

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

putAndMoveToLast

char putAndMoveToLast(double key,
                      char value)

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(double key)

A specific move method to move a given key/value to the first index.

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(double key)

A specific move method to move a given key/value to the last index.

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

getAndMoveToFirst

char getAndMoveToFirst(double key)

A Specific get method that allows to move teh given key/value int the first index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

getAndMoveToLast

char getAndMoveToLast(double key)

A Specific get method that allows to move teh given key/value int the last index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

comparator

DoubleComparator comparator()

Specified by:

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

keySet

DoubleSet keySet()

Specified by:

keySet in interface Double2CharMap

Specified by:

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

Specified by:

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

values

CharCollection values()

Specified by:

values in interface Double2CharMap

Specified by:

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

Specified by:

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

subMap

Double2CharSortedMap subMap(double fromKey,
                            double 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

Double2CharSortedMap headMap(double 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

Double2CharSortedMap tailMap(double 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.

firstDoubleKey

double firstDoubleKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstDoubleKey

double pollFirstDoubleKey()

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

Returns:

the first key in the map

lastDoubleKey

double lastDoubleKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastDoubleKey

double pollLastDoubleKey()

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Double lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Double2CharSortedMap subMap(java.lang.Double fromKey,
                                                 java.lang.Double toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Double2CharSortedMap headMap(java.lang.Double toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Double2CharSortedMap tailMap(java.lang.Double fromKey)

Deprecated.

Specified by:

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