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:

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

Note:

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

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

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator()
Char2CharSortedMap	copy() A Function that does a shallow clone of the Map itself.
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.
Char2CharSortedMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2CharSortedMap	headMap(java.lang.Character toKey) Deprecated.
CharSortedSet	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.
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 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
default Char2CharSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Char2CharSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Char2CharSortedMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2CharSortedMap	tailMap(java.lang.Character fromKey) Deprecated.
default Char2CharSortedMap	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.chars.maps.interfaces.Char2CharMap

addTo, addToAll, builder, char2CharEntrySet, 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, subFrom, supplyCharIfAbsent

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.Character>

copy

Char2CharSortedMap copy()

Description copied from interface: Char2CharMap

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 Char2CharMap

Returns:

a Shallow Copy of the Map

keySet

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

synchronize

default Char2CharSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2CharMap

Returns:

a new SortedMap that is synchronized

See Also:

Char2CharMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2CharMap)

synchronize

default Char2CharSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2CharMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Char2CharMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2CharMap)

unmodifiable

default Char2CharSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Char2CharMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Char2CharMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2CharMap)

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>