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:

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

Note:

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

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

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator()
Char2ObjectSortedMap<V>	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.
V	firstValue() A method to get the first Value of a Map.
Char2ObjectSortedMap<V>	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Char2ObjectSortedMap<V>	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.
V	lastValue() 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 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
default Char2ObjectSortedMap<V>	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Char2ObjectSortedMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Char2ObjectSortedMap<V>	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Char2ObjectSortedMap<V>	tailMap(java.lang.Character fromKey) Deprecated.
default Char2ObjectSortedMap<V>	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

builder, char2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

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

Method Detail

comparator

CharComparator comparator()

Specified by:

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

copy

Char2ObjectSortedMap<V> copy()

Description copied from interface: Char2ObjectMap

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

Returns:

a Shallow Copy of the Map

keySet

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

synchronize

default Char2ObjectSortedMap<V> synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2ObjectMap<V>

Returns:

a new SortedMap that is synchronized

See Also:

Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

synchronize

default Char2ObjectSortedMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Char2ObjectMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

unmodifiable

default Char2ObjectSortedMap<V> unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Char2ObjectMap<V>

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Char2ObjectMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<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>