speiger.src.collections.shorts.utils.maps

Class Short2ByteMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Byte>, Short2ByteFunction, Short2ByteMap

Direct Known Subclasses:

Short2ByteMaps.UnmodifyableSortedMap

Enclosing class:

Short2ByteMaps

public static class Short2ByteMaps.UnmodifyableMap
extends AbstractShort2ByteMap
implements Short2ByteMap

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

AbstractShort2ByteMap.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.Short2ByteMap

Short2ByteMap.Entry, Short2ByteMap.FastEntrySet

Method Summary

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

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

addToAll, computeByte, computeByteIfAbsent, computeByteIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllByte, mergeByte, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceBytes, replaceBytes, 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.Short2ByteMap

addToAll, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, mergeAllByte, mergeByte, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

put

public byte put(short key,
                byte value)

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2ByteMap

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 byte putIfAbsent(short key,
                        byte value)

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2ByteMap

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 byte addTo(short key,
                  byte value)

Description copied from interface: Short2ByteMap

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

Specified by:

addTo in interface Short2ByteMap

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 byte remShort(short key)

Description copied from interface: Short2ByteMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remShort in interface Short2ByteMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remShortOrDefault

public byte remShortOrDefault(short key,
                              byte defaultValue)

Description copied from interface: Short2ByteMap

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

Specified by:

remShortOrDefault in interface Short2ByteMap

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,
                      byte value)

Description copied from interface: Short2ByteMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2ByteMap

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)

getByte

public byte getByte(short key)

Description copied from interface: Short2ByteMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getByte in interface Short2ByteFunction

Specified by:

getByte in interface Short2ByteMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public byte getOrDefault(short key,
                         byte defaultValue)

Description copied from interface: Short2ByteMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2ByteMap

Overrides:

getOrDefault in class AbstractShort2ByteMap

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

Specified by:

keySet in interface Short2ByteMap

Overrides:

keySet in class AbstractShort2ByteMap

values

public ByteCollection values()

Specified by:

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

Specified by:

values in interface Short2ByteMap

Overrides:

values in class AbstractShort2ByteMap

short2ByteEntrySet

public ObjectSet<Short2ByteMap.Entry> short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Returns:

a EntrySet of the collection