speiger.src.collections.shorts.maps.abstracts

Class AbstractShort2ByteMap

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ImmutableShort2ByteOpenHashMap, Short2ByteArrayMap, Short2ByteAVLTreeMap, Short2ByteConcurrentOpenHashMap, Short2ByteMaps.EmptyMap, Short2ByteMaps.SingletonMap, Short2ByteMaps.SynchronizedMap, Short2ByteMaps.UnmodifyableMap, Short2ByteOpenCustomHashMap, Short2ByteOpenHashMap, Short2ByteRBTreeMap

public abstract class AbstractShort2ByteMap
extends java.util.AbstractMap<java.lang.Short,java.lang.Byte>
implements Short2ByteMap

A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractShort2ByteMap.BasicEntry A Simple Type Specific Entry class to reduce boxing/unboxing

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.BuilderCache, Short2ByteMap.Entry, Short2ByteMap.FastEntrySet, Short2ByteMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractShort2ByteMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Short2ByteMap m) A Helper method to bulk add primitives together.
byte	computeByte(short key, ShortByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfAbsent(short key, Short2ByteFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfPresent(short key, ShortByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(byte value) Type Specific method to reduce boxing/unboxing of values
Short2ByteMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Short,java.lang.Byte>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ShortByteConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Byte	get(java.lang.Object key)
byte	getDefaultReturnValue() Method to see what the default return value is.
java.lang.Byte	getOrDefault(java.lang.Object key, java.lang.Byte defaultValue)
byte	getOrDefault(short key, byte defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
int	hashCode()
ShortSet	keySet()
void	mergeAllByte(Short2ByteMap m, ByteByteUnaryOperator mappingFunction) A Bulk method for merging Maps.
byte	mergeByte(short key, byte value, ByteByteUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Byte	put(java.lang.Short key, java.lang.Byte value) Deprecated.
void	putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m)
void	putAll(short[] keys, byte[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.lang.Short[] keys, java.lang.Byte[] values, int offset, int size) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(Short2ByteMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Short2ByteMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Byte	remove(java.lang.Object key)
byte	replace(short key, byte value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, byte oldValue, byte newValue) A Type Specific replace method to replace an existing value
void	replaceBytes(Short2ByteMap m) Type-Specific bulk replace method.
void	replaceBytes(ShortByteUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractShort2ByteMap	setDefaultReturnValue(byte v) Method to define the default return value if a requested key isn't present
byte	supplyByteIfAbsent(short key, ByteSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ByteCollection	values()

Methods inherited from class java.util.AbstractMap

clear, 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.shorts.maps.interfaces.Short2ByteMap

addTo, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, merge, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, short2ByteEntrySet, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractShort2ByteMap

public AbstractShort2ByteMap()

Method Detail

getDefaultReturnValue

public byte getDefaultReturnValue()

Description copied from interface: Short2ByteMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Short2ByteMap

Returns:

default return value

setDefaultReturnValue

public AbstractShort2ByteMap setDefaultReturnValue(byte v)

Description copied from interface: Short2ByteMap

Method to define the default return value if a requested key isn't present

Specified by:

setDefaultReturnValue in interface Short2ByteMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Short2ByteMap copy()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Returns:

a Shallow Copy of the Map

put

@Deprecated
public java.lang.Byte put(java.lang.Short key,
                                       java.lang.Byte value)

Deprecated.

Specified by:

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

Specified by:

put in interface Short2ByteMap

Overrides:

put in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

addToAll

public void addToAll(Short2ByteMap m)

Description copied from interface: Short2ByteMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Short2ByteMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Short2ByteMap m)

Description copied from interface: Short2ByteMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Short2ByteMap

Parameters:

m - the elements that should be inserted

putAll

public void putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m)

Specified by:

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

Overrides:

putAll in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

putAll

public void putAll(short[] keys,
                   byte[] values,
                   int offset,
                   int size)

Description copied from interface: Short2ByteMap

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Short2ByteMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAll

public void putAll(java.lang.Short[] keys,
                   java.lang.Byte[] values,
                   int offset,
                   int size)

Description copied from interface: Short2ByteMap

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Short2ByteMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAllIfAbsent

public void putAllIfAbsent(Short2ByteMap m)

Description copied from interface: Short2ByteMap

Type-Specific bulk put method put elements into the map if not present.

Specified by:

putAllIfAbsent in interface Short2ByteMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2ByteMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(byte value)

Description copied from interface: Short2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2ByteMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

public boolean replace(short key,
                       byte oldValue,
                       byte newValue)

Description copied from interface: Short2ByteMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2ByteMap

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public byte replace(short key,
                    byte value)

Description copied from interface: Short2ByteMap

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Specified by:

replace in interface Short2ByteMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceBytes

public void replaceBytes(Short2ByteMap m)

Description copied from interface: Short2ByteMap

Type-Specific bulk replace method. Could be seen as putAllIfPresent

Specified by:

replaceBytes in interface Short2ByteMap

Parameters:

m - elements that should be replaced.

replaceBytes

public void replaceBytes(ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceBytes in interface Short2ByteMap

Parameters:

mappingFunction - operation to replace all values

computeByte

public byte computeByte(short key,
                        ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByte in interface Short2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeByteIfAbsent

public byte computeByteIfAbsent(short key,
                                Short2ByteFunction mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfAbsent in interface Short2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

supplyByteIfAbsent

public byte supplyByteIfAbsent(short key,
                               ByteSupplier valueProvider)

Description copied from interface: Short2ByteMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function

Specified by:

supplyByteIfAbsent in interface Short2ByteMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeByteIfPresent

public byte computeByteIfPresent(short key,
                                 ShortByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfPresent in interface Short2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

mergeByte

public byte mergeByte(short key,
                      byte value,
                      ByteByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeByte in interface Short2ByteMap

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAllByte

public void mergeAllByte(Short2ByteMap m,
                         ByteByteUnaryOperator mappingFunction)

Description copied from interface: Short2ByteMap

A Bulk method for merging Maps.

Specified by:

mergeAllByte in interface Short2ByteMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

public java.lang.Byte get(java.lang.Object key)

Specified by:

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

Specified by:

get in interface Short2ByteMap

Overrides:

get in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

getOrDefault

public java.lang.Byte getOrDefault(java.lang.Object key,
                                   java.lang.Byte defaultValue)

Specified by:

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

Specified by:

getOrDefault in interface Short2ByteMap

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

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

remove

public java.lang.Byte remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Short2ByteMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

forEach

public void forEach(ShortByteConsumer action)

Description copied from interface: Short2ByteMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2ByteMap

Parameters:

action - processor of the values that are iterator over

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 java.util.AbstractMap<java.lang.Short,java.lang.Byte>

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 java.util.AbstractMap<java.lang.Short,java.lang.Byte>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Short,java.lang.Byte>> entrySet()

Specified by:

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

Specified by:

entrySet in interface Short2ByteMap

Specified by:

entrySet in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

equals in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>

hashCode

public int hashCode()

Specified by:

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

Overrides:

hashCode in class java.util.AbstractMap<java.lang.Short,java.lang.Byte>