speiger.src.collections.chars.utils.maps

Class Char2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Character,V>

speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap<V>

speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Character,V>, java.util.NavigableMap<java.lang.Character,V>, java.util.SortedMap<java.lang.Character,V>, CharFunction<V>, Char2ObjectMap<V>, Char2ObjectNavigableMap<V>, Char2ObjectSortedMap<V>

Enclosing class:

Char2ObjectMaps

public static class Char2ObjectMaps.UnmodifyableNavigableMap<V>
extends Char2ObjectMaps.UnmodifyableSortedMap<V>
implements Char2ObjectNavigableMap<V>

The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap

AbstractChar2ObjectMap.BasicEntry<V>

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectSortedMap

Char2ObjectSortedMap.FastSortedSet<V>

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
Char2ObjectMap.Entry<V>	ceilingEntry(char key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
char	ceilingKey(char key) A Type Specific ceilingKey method to reduce boxing/unboxing.
Char2ObjectNavigableMap<V>	copy() A Function that does a shallow clone of the Map itself.
CharNavigableSet	descendingKeySet()
Char2ObjectNavigableMap<V>	descendingMap()
Char2ObjectMap.Entry<V>	firstEntry()
Char2ObjectMap.Entry<V>	floorEntry(char key) A Type Specific floorEntry method to reduce boxing/unboxing.
char	floorKey(char key) A Type Specific floorKey method to reduce boxing/unboxing.
char	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
char	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Char2ObjectNavigableMap<V>	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Char2ObjectNavigableMap<V>	headMap(char toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Char2ObjectMap.Entry<V>	higherEntry(char key) A Type Specific higherEntry method to reduce boxing/unboxing.
char	higherKey(char key) A Type Specific higherKey method to reduce boxing/unboxing.
CharNavigableSet	keySet()
Char2ObjectMap.Entry<V>	lastEntry()
Char2ObjectMap.Entry<V>	lowerEntry(char key) A Type Specific lowerEntry method to reduce boxing/unboxing.
char	lowerKey(char key) A Type Specific lowerKey method to reduce boxing/unboxing.
CharNavigableSet	navigableKeySet()
Char2ObjectMap.Entry<V>	pollFirstEntry()
Char2ObjectMap.Entry<V>	pollLastEntry()
void	setDefaultMaxValue(char e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(char e) A Helper method to set the min value for SubMaps.
Char2ObjectNavigableMap<V>	subMap(char fromKey, boolean fromInclusive, char toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
Char2ObjectNavigableMap<V>	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
Char2ObjectNavigableMap<V>	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Char2ObjectNavigableMap<V>	tailMap(char fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableSortedMap

comparator, firstCharKey, firstValue, lastCharKey, lastValue, pollFirstCharKey, pollLastCharKey

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableMap

char2ObjectEntrySet, clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap

containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsKey, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, synchronize, synchronize, tailMap, tailMap, unmodifiable

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

comparator, firstCharKey, firstKey, firstValue, lastCharKey, lastKey, lastValue, pollFirstCharKey, pollLastCharKey, values

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

apply, builder, char2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, 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.SortedMap

entrySet

Methods inherited from interface java.util.Map

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

Method Detail

descendingMap

public Char2ObjectNavigableMap<V> descendingMap()

Specified by:

descendingMap in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

descendingMap in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public CharNavigableSet navigableKeySet()

Specified by:

navigableKeySet in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

navigableKeySet in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public CharNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Char2ObjectMap<V>

Specified by:

keySet in interface Char2ObjectNavigableMap<V>

Specified by:

keySet in interface Char2ObjectSortedMap<V>

Overrides:

keySet in class Char2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public CharNavigableSet descendingKeySet()

Specified by:

descendingKeySet in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

descendingKeySet in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Char2ObjectMap.Entry<V> firstEntry()

Specified by:

firstEntry in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

firstEntry in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Char2ObjectMap.Entry<V> lastEntry()

Specified by:

lastEntry in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

lastEntry in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Char2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

pollFirstEntry in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

pollFirstEntry in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Char2ObjectMap.Entry<V> pollLastEntry()

Specified by:

pollLastEntry in interface java.util.NavigableMap<java.lang.Character,V>

Specified by:

pollLastEntry in interface Char2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Char2ObjectNavigableMap<V> subMap(char fromKey,
                                         boolean fromInclusive,
                                         char toKey,
                                         boolean toInclusive)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2ObjectNavigableMap<V>

Parameters:

fromKey - where the submap should start

fromInclusive - if the fromKey is inclusive or not

toKey - where the subMap should end

toInclusive - if the toKey is inclusive or not

Returns:

a SubMap that is within the range of the desired range

headMap

public Char2ObjectNavigableMap<V> headMap(char toKey,
                                          boolean inclusive)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2ObjectNavigableMap<V>

Parameters:

toKey - where the HeadMap should end

inclusive - if the toKey is inclusive or not

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Char2ObjectNavigableMap<V> tailMap(char fromKey,
                                          boolean inclusive)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2ObjectNavigableMap<V>

Parameters:

fromKey - where the TailMap should start

inclusive - if the fromKey is inclusive or not

Returns:

a TailMap that is within the range of the desired range

subMap

public Char2ObjectNavigableMap<V> subMap(char fromKey,
                                         char toKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2ObjectNavigableMap<V>

Specified by:

subMap in interface Char2ObjectSortedMap<V>

Overrides:

subMap in class Char2ObjectMaps.UnmodifyableSortedMap<V>

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

headMap

public Char2ObjectNavigableMap<V> headMap(char toKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2ObjectNavigableMap<V>

Specified by:

headMap in interface Char2ObjectSortedMap<V>

Overrides:

headMap in class Char2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Char2ObjectNavigableMap<V> tailMap(char fromKey)

Description copied from interface: Char2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2ObjectNavigableMap<V>

Specified by:

tailMap in interface Char2ObjectSortedMap<V>

Overrides:

tailMap in class Char2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

public void setDefaultMaxValue(char e)

Description copied from interface: Char2ObjectNavigableMap

A Helper method to set the max value for SubMaps. (Default: char.MIN_VALUE)

Specified by:

setDefaultMaxValue in interface Char2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public char getDefaultMaxValue()

Description copied from interface: Char2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Char2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(char e)

Description copied from interface: Char2ObjectNavigableMap

A Helper method to set the min value for SubMaps. (Default: char.MAX_VALUE)

Specified by:

setDefaultMinValue in interface Char2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public char getDefaultMinValue()

Description copied from interface: Char2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Char2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public char lowerKey(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public char higherKey(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public char floorKey(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public char ceilingKey(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Char2ObjectMap.Entry<V> lowerEntry(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Char2ObjectMap.Entry<V> higherEntry(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Char2ObjectMap.Entry<V> floorEntry(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal entry that can be found, or null

ceilingEntry

public Char2ObjectMap.Entry<V> ceilingEntry(char key)

Description copied from interface: Char2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Char2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal entry that can be found, or null

copy

public Char2ObjectNavigableMap<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>

Specified by:

copy in interface Char2ObjectNavigableMap<V>

Specified by:

copy in interface Char2ObjectSortedMap<V>

Overrides:

copy in class Char2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map