speiger.src.collections.chars.utils.maps

Class Char2CharMaps.UnmodifyableNavigableMap

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2CharMap

speiger.src.collections.chars.utils.maps.Char2CharMaps.UnmodifyableMap

speiger.src.collections.chars.utils.maps.Char2CharMaps.UnmodifyableSortedMap

speiger.src.collections.chars.utils.maps.Char2CharMaps.UnmodifyableNavigableMap

All Implemented Interfaces:

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

Enclosing class:

Char2CharMaps

public static class Char2CharMaps.UnmodifyableNavigableMap
extends Char2CharMaps.UnmodifyableSortedMap
implements Char2CharNavigableMap

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

AbstractChar2CharMap.BasicEntry

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

Char2CharSortedMap.FastSortedSet

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
Char2CharMap.Entry	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.
Char2CharNavigableMap	copy() A Function that does a shallow clone of the Map itself.
CharNavigableSet	descendingKeySet()
Char2CharNavigableMap	descendingMap()
Char2CharMap.Entry	firstEntry()
Char2CharMap.Entry	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.
Char2CharNavigableMap	headMap(char toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Char2CharNavigableMap	headMap(char toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Char2CharMap.Entry	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()
Char2CharMap.Entry	lastEntry()
Char2CharMap.Entry	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()
Char2CharMap.Entry	pollFirstEntry()
Char2CharMap.Entry	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.
Char2CharNavigableMap	subMap(char fromKey, boolean fromInclusive, char toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
Char2CharNavigableMap	subMap(char fromKey, char toKey) A Type Specific SubMap method to reduce boxing/unboxing
Char2CharNavigableMap	tailMap(char fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Char2CharNavigableMap	tailMap(char fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

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

comparator, firstCharKey, firstCharValue, lastCharKey, lastCharValue, pollFirstCharKey, pollLastCharKey

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

addTo, char2CharEntrySet, clear, computeChar, computeCharIfAbsent, computeCharIfPresent, get, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remove, remove, removeOrDefault, replaceChars, replaceChars, subFrom, supplyCharIfAbsent, values

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

addToAll, 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, containsValue, 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.Char2CharNavigableMap

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

comparator, firstCharKey, firstCharValue, firstKey, lastCharKey, lastCharValue, lastKey, pollFirstCharKey, pollLastCharKey, values

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

entrySet

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

descendingMap

public Char2CharNavigableMap descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Char2CharNavigableMap

Returns:

a Type Specific desendingMap

navigableKeySet

public CharNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Char2CharNavigableMap

Returns:

a Type Specific Navigable Key Set

keySet

public CharNavigableSet keySet()

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>

Specified by:

keySet in interface Char2CharMap

Specified by:

keySet in interface Char2CharNavigableMap

Specified by:

keySet in interface Char2CharSortedMap

Overrides:

keySet in class Char2CharMaps.UnmodifyableSortedMap

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public CharNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Char2CharNavigableMap

Returns:

a Type Specific Desending Key Set

firstEntry

public Char2CharMap.Entry firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Char2CharNavigableMap

Returns:

a Type Specific firstEntry

lastEntry

public Char2CharMap.Entry lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Char2CharNavigableMap

Returns:

a Type Specific lastEntry

pollFirstEntry

public Char2CharMap.Entry pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Char2CharNavigableMap

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Char2CharMap.Entry pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Char2CharNavigableMap

Returns:

a Type Specific pollLastEntry

subMap

public Char2CharNavigableMap subMap(char fromKey,
                                    boolean fromInclusive,
                                    char toKey,
                                    boolean toInclusive)

Description copied from interface: Char2CharNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2CharNavigableMap

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 Char2CharNavigableMap headMap(char toKey,
                                     boolean inclusive)

Description copied from interface: Char2CharNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2CharNavigableMap

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 Char2CharNavigableMap tailMap(char fromKey,
                                     boolean inclusive)

Description copied from interface: Char2CharNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2CharNavigableMap

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 Char2CharNavigableMap subMap(char fromKey,
                                    char toKey)

Description copied from interface: Char2CharSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Char2CharNavigableMap

Specified by:

subMap in interface Char2CharSortedMap

Overrides:

subMap in class Char2CharMaps.UnmodifyableSortedMap

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 Char2CharNavigableMap headMap(char toKey)

Description copied from interface: Char2CharSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Char2CharNavigableMap

Specified by:

headMap in interface Char2CharSortedMap

Overrides:

headMap in class Char2CharMaps.UnmodifyableSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Char2CharNavigableMap tailMap(char fromKey)

Description copied from interface: Char2CharSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Char2CharNavigableMap

Specified by:

tailMap in interface Char2CharSortedMap

Overrides:

tailMap in class Char2CharMaps.UnmodifyableSortedMap

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: Char2CharNavigableMap

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

Specified by:

setDefaultMaxValue in interface Char2CharNavigableMap

Parameters:

e - the new max value

getDefaultMaxValue

public char getDefaultMaxValue()

Description copied from interface: Char2CharNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Char2CharNavigableMap

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(char e)

Description copied from interface: Char2CharNavigableMap

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

Specified by:

setDefaultMinValue in interface Char2CharNavigableMap

Parameters:

e - the new min value

getDefaultMinValue

public char getDefaultMinValue()

Description copied from interface: Char2CharNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Char2CharNavigableMap

Returns:

the default min value.

lowerKey

public char lowerKey(char key)

Description copied from interface: Char2CharNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Char2CharNavigableMap

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: Char2CharNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Char2CharNavigableMap

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: Char2CharNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Char2CharNavigableMap

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: Char2CharNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Char2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Char2CharMap.Entry lowerEntry(char key)

Description copied from interface: Char2CharNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Char2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Char2CharMap.Entry higherEntry(char key)

Description copied from interface: Char2CharNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Char2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Char2CharMap.Entry floorEntry(char key)

Description copied from interface: Char2CharNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Char2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Char2CharMap.Entry ceilingEntry(char key)

Description copied from interface: Char2CharNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Char2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

copy

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

Specified by:

copy in interface Char2CharNavigableMap

Specified by:

copy in interface Char2CharSortedMap

Overrides:

copy in class Char2CharMaps.UnmodifyableSortedMap

Returns:

a Shallow Copy of the Map