speiger.src.collections.chars.maps.interfaces

Interface Char2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Char2ObjectFunction<V>, Char2ObjectMap<V>, java.util.Map<java.lang.Character,V>, java.util.SortedMap<java.lang.Character,V>

All Known Subinterfaces:

Char2ObjectNavigableMap<V>

All Known Implementing Classes:

Char2ObjectArrayMap, Char2ObjectAVLTreeMap, Char2ObjectLinkedOpenCustomHashMap, Char2ObjectLinkedOpenHashMap, Char2ObjectMaps.SynchronizedNavigableMap, Char2ObjectMaps.SynchronizedSortedMap, Char2ObjectMaps.UnmodifyableNavigableMap, Char2ObjectMaps.UnmodifyableSortedMap, Char2ObjectRBTreeMap

public interface Char2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Character,V>, Char2ObjectMap<V>

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	Char2ObjectSortedMap.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.chars.maps.interfaces.Char2ObjectMap

Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>

Method Summary

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

Methods inherited from interface java.util.SortedMap

entrySet

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

char2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remChar, remCharOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

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

Method Detail

putAndMoveToFirst

V putAndMoveToFirst(char key,
                    V 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

V putAndMoveToLast(char key,
                   V 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

V 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

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

keySet

CharSet keySet()

Specified by:

keySet in interface Char2ObjectMap<V>

Specified by:

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

Specified by:

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

values

ObjectCollection<V> values()

Specified by:

values in interface Char2ObjectMap<V>

Specified by:

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

Specified by:

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

subMap

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

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

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

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

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Character lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Char2ObjectSortedMap<V> subMap(java.lang.Character fromKey,
                                                    java.lang.Character toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Char2ObjectSortedMap<V> headMap(java.lang.Character toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Char2ObjectSortedMap<V> tailMap(java.lang.Character fromKey)

Deprecated.

Specified by:

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