speiger.src.collections.shorts.utils.maps

Class Short2CharMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap

Direct Known Subclasses:

Short2CharMaps.UnmodifyableSortedMap

Enclosing class:

Short2CharMaps

public static class Short2CharMaps.UnmodifyableMap
extends AbstractShort2CharMap
implements Short2CharMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

AbstractShort2CharMap.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.shorts.maps.interfaces.Short2CharMap

Short2CharMap.Entry, Short2CharMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
char	addTo(short key, char value) A Helper method to add a primitives together.
char	getChar(short key) A Type Specific get method to reduce boxing/unboxing
char	getOrDefault(short key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
char	put(short key, char value) Type Specific method to reduce boxing/unboxing of values
char	putIfAbsent(short key, char value) Type Specific method to reduce boxing/unboxing of values
boolean	remove(short key, char value) Type Specific remove function to reduce boxing/unboxing
char	remShort(short key) Type Specific remove function to reduce boxing/unboxing
char	remShortOrDefault(short key, char defaultValue) Type-Specific Remove function with a default return value if wanted.
ObjectSet<Short2CharMap.Entry>	short2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
CharCollection	values()

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

addToAll, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllChar, mergeChar, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

addToAll, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, mergeAllChar, mergeChar, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

put

public char put(short key,
                char value)

Description copied from interface: Short2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2CharMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public char putIfAbsent(short key,
                        char value)

Description copied from interface: Short2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2CharMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

addTo

public char addTo(short key,
                  char value)

Description copied from interface: Short2CharMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Specified by:

addTo in interface Short2CharMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

remShort

public char remShort(short key)

Description copied from interface: Short2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remShort in interface Short2CharMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remShortOrDefault

public char remShortOrDefault(short key,
                              char defaultValue)

Description copied from interface: Short2CharMap

Type-Specific Remove function with a default return value if wanted.

Specified by:

remShortOrDefault in interface Short2CharMap

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

public boolean remove(short key,
                      char value)

Description copied from interface: Short2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2CharMap

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

getChar

public char getChar(short key)

Description copied from interface: Short2CharMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getChar in interface Short2CharFunction

Specified by:

getChar in interface Short2CharMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public char getOrDefault(short key,
                         char defaultValue)

Description copied from interface: Short2CharMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2CharMap

Overrides:

getOrDefault in class AbstractShort2CharMap

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Overrides:

keySet in class AbstractShort2CharMap

values

public CharCollection values()

Specified by:

values in interface java.util.Map<java.lang.Short,java.lang.Character>

Specified by:

values in interface Short2CharMap

Overrides:

values in class AbstractShort2CharMap

short2CharEntrySet

public ObjectSet<Short2CharMap.Entry> short2CharEntrySet()

Description copied from interface: Short2CharMap

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Specified by:

short2CharEntrySet in interface Short2CharMap

Returns:

a EntrySet of the collection