speiger.src.collections.ints.utils.maps

Class Int2CharMaps.UnmodifyableNavigableMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableMap

speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableSortedMap

speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableNavigableMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Character>, java.util.NavigableMap<java.lang.Integer,java.lang.Character>, java.util.SortedMap<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, Int2CharNavigableMap, Int2CharSortedMap

Enclosing class:

Int2CharMaps

public static class Int2CharMaps.UnmodifyableNavigableMap
extends Int2CharMaps.UnmodifyableSortedMap
implements Int2CharNavigableMap

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

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

AbstractInt2CharMap.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.ints.maps.interfaces.Int2CharSortedMap

Int2CharSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

Int2CharMap.BuilderCache, Int2CharMap.Entry, Int2CharMap.FastEntrySet, Int2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Int2CharMap.Entry	ceilingEntry(int key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
int	ceilingKey(int key) A Type Specific ceilingKey method to reduce boxing/unboxing.
Int2CharNavigableMap	copy() A Function that does a shallow clone of the Map itself.
IntNavigableSet	descendingKeySet()
Int2CharNavigableMap	descendingMap()
Int2CharMap.Entry	firstEntry()
Int2CharMap.Entry	floorEntry(int key) A Type Specific floorEntry method to reduce boxing/unboxing.
int	floorKey(int key) A Type Specific floorKey method to reduce boxing/unboxing.
int	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
int	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Int2CharNavigableMap	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Int2CharNavigableMap	headMap(int toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Int2CharMap.Entry	higherEntry(int key) A Type Specific higherEntry method to reduce boxing/unboxing.
int	higherKey(int key) A Type Specific higherKey method to reduce boxing/unboxing.
IntNavigableSet	keySet()
Int2CharMap.Entry	lastEntry()
Int2CharMap.Entry	lowerEntry(int key) A Type Specific lowerEntry method to reduce boxing/unboxing.
int	lowerKey(int key) A Type Specific lowerKey method to reduce boxing/unboxing.
IntNavigableSet	navigableKeySet()
Int2CharMap.Entry	pollFirstEntry()
Int2CharMap.Entry	pollLastEntry()
void	setDefaultMaxValue(int e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(int e) A Helper method to set the min value for SubMaps.
Int2CharNavigableMap	subMap(int fromKey, boolean fromInclusive, int toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
Int2CharNavigableMap	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
Int2CharNavigableMap	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Int2CharNavigableMap	tailMap(int fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableSortedMap

comparator, firstCharValue, firstIntKey, lastCharValue, lastIntKey, pollFirstIntKey, pollLastIntKey

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableMap

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

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

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.ints.maps.interfaces.Int2CharNavigableMap

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

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap

comparator, firstCharValue, firstIntKey, firstKey, lastCharValue, lastIntKey, lastKey, pollFirstIntKey, pollLastIntKey, values

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

addTo, addToAll, applyAsChar, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, int2CharEntrySet, merge, mergeAllChar, mergeChar, put, put, 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 Int2CharNavigableMap descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Int2CharNavigableMap

Returns:

a Type Specific desendingMap

navigableKeySet

public IntNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Int2CharNavigableMap

Returns:

a Type Specific Navigable Key Set

keySet

public IntNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Int2CharMap

Specified by:

keySet in interface Int2CharNavigableMap

Specified by:

keySet in interface Int2CharSortedMap

Overrides:

keySet in class Int2CharMaps.UnmodifyableSortedMap

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public IntNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Int2CharNavigableMap

Returns:

a Type Specific Desending Key Set

firstEntry

public Int2CharMap.Entry firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Int2CharNavigableMap

Returns:

a Type Specific firstEntry

lastEntry

public Int2CharMap.Entry lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Int2CharNavigableMap

Returns:

a Type Specific lastEntry

pollFirstEntry

public Int2CharMap.Entry pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Int2CharNavigableMap

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Int2CharMap.Entry pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Int2CharNavigableMap

Returns:

a Type Specific pollLastEntry

subMap

public Int2CharNavigableMap subMap(int fromKey,
                                   boolean fromInclusive,
                                   int toKey,
                                   boolean toInclusive)

Description copied from interface: Int2CharNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2CharNavigableMap

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 Int2CharNavigableMap headMap(int toKey,
                                    boolean inclusive)

Description copied from interface: Int2CharNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2CharNavigableMap

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 Int2CharNavigableMap tailMap(int fromKey,
                                    boolean inclusive)

Description copied from interface: Int2CharNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2CharNavigableMap

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 Int2CharNavigableMap subMap(int fromKey,
                                   int toKey)

Description copied from interface: Int2CharSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2CharNavigableMap

Specified by:

subMap in interface Int2CharSortedMap

Overrides:

subMap in class Int2CharMaps.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 Int2CharNavigableMap headMap(int toKey)

Description copied from interface: Int2CharSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2CharNavigableMap

Specified by:

headMap in interface Int2CharSortedMap

Overrides:

headMap in class Int2CharMaps.UnmodifyableSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Int2CharNavigableMap tailMap(int fromKey)

Description copied from interface: Int2CharSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2CharNavigableMap

Specified by:

tailMap in interface Int2CharSortedMap

Overrides:

tailMap in class Int2CharMaps.UnmodifyableSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

public void setDefaultMaxValue(int e)

Description copied from interface: Int2CharNavigableMap

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

Specified by:

setDefaultMaxValue in interface Int2CharNavigableMap

Parameters:

e - the new max value

getDefaultMaxValue

public int getDefaultMaxValue()

Description copied from interface: Int2CharNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Int2CharNavigableMap

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(int e)

Description copied from interface: Int2CharNavigableMap

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

Specified by:

setDefaultMinValue in interface Int2CharNavigableMap

Parameters:

e - the new min value

getDefaultMinValue

public int getDefaultMinValue()

Description copied from interface: Int2CharNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Int2CharNavigableMap

Returns:

the default min value.

lowerKey

public int lowerKey(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public int higherKey(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public int floorKey(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public int ceilingKey(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Int2CharMap.Entry lowerEntry(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Int2CharMap.Entry higherEntry(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Int2CharMap.Entry floorEntry(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Int2CharMap.Entry ceilingEntry(int key)

Description copied from interface: Int2CharNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Int2CharNavigableMap

Parameters:

key - that should be compared with.

Returns:

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

copy

public Int2CharNavigableMap copy()

Description copied from interface: Int2CharMap

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 Int2CharMap

Specified by:

copy in interface Int2CharNavigableMap

Specified by:

copy in interface Int2CharSortedMap

Overrides:

copy in class Int2CharMaps.UnmodifyableSortedMap

Returns:

a Shallow Copy of the Map