speiger.src.collections.chars.maps.interfaces

Interface Char2CharSortedMap

All Superinterfaces:

Char2CharFunction, Char2CharMap, java.util.Map<java.lang.Character,java.lang.Character>, java.util.SortedMap<java.lang.Character,java.lang.Character>

All Known Subinterfaces:

Char2CharNavigableMap

All Known Implementing Classes:

Char2CharArrayMap, Char2CharAVLTreeMap, Char2CharLinkedOpenCustomHashMap, Char2CharLinkedOpenHashMap, Char2CharMaps.SynchronizedNavigableMap, Char2CharMaps.SynchronizedSortedMap, Char2CharMaps.UnmodifyableNavigableMap, Char2CharMaps.UnmodifyableSortedMap, Char2CharRBTreeMap

public interface Char2CharSortedMap
extends java.util.SortedMap<java.lang.Character,java.lang.Character>, Char2CharMap

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	Char2CharSortedMap.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.Char2CharMap

Char2CharMap.Entry, Char2CharMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator()
char	firstCharKey() A method to get the first Key of a Map.
char	firstCharValue() A method to get the first Value of a Map.
default java.lang.Character	firstKey() Deprecated.
char	getAndMoveToFirst(char key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(char key) A Specific get method that allows to move teh given key/value int the last index.
Char2CharSortedMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2CharSortedMap	headMap(java.lang.Character toKey) Deprecated.
CharSet	keySet()
char	lastCharKey() A method to get the last Key of a Map.
char	lastCharValue() A method to get the last Value of a Map.
default java.lang.Character	lastKey() Deprecated.
boolean	moveToFirst(char key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(char key) A specific move method to move a given key/value to the last index.
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.
char	putAndMoveToFirst(char key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(char key, char value) A customized put method that allows you to insert into the last index.
default Char2CharSortedMap	subMap(java.lang.Character fromKey, java.lang.Character toKey) Deprecated.
Char2CharSortedMap	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
Char2CharSortedMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2CharSortedMap	tailMap(java.lang.Character fromKey) Deprecated.
CharCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2CharMap

addTo, addToAll, char2CharEntrySet, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remChar, remCharOrDefault, 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(char 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(char 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(char 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(char 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(char 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(char 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

CharComparator comparator()

Specified by:

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

keySet

CharSet keySet()

Specified by:

keySet in interface Char2CharMap

Specified by:

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

Specified by:

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

values

CharCollection values()

Specified by:

values in interface Char2CharMap

Specified by:

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

Specified by:

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

subMap

Char2CharSortedMap 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

Char2CharSortedMap 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

Char2CharSortedMap 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

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Character lastKey()

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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