speiger.src.collections.shorts.maps.interfaces

Interface Short2ObjectMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<java.lang.Short,V>, Short2ObjectFunction<V>

All Known Subinterfaces:

Short2ObjectNavigableMap<V>, Short2ObjectSortedMap<V>

All Known Implementing Classes:

AbstractShort2ObjectMap, Short2ObjectArrayMap, Short2ObjectAVLTreeMap, Short2ObjectLinkedOpenCustomHashMap, Short2ObjectLinkedOpenHashMap, Short2ObjectMaps.EmptyMap, Short2ObjectMaps.SingletonMap, Short2ObjectMaps.SynchronizedMap, Short2ObjectMaps.SynchronizedNavigableMap, Short2ObjectMaps.SynchronizedSortedMap, Short2ObjectMaps.UnmodifyableMap, Short2ObjectMaps.UnmodifyableNavigableMap, Short2ObjectMaps.UnmodifyableSortedMap, Short2ObjectOpenCustomHashMap, Short2ObjectOpenHashMap, Short2ObjectRBTreeMap

public interface Short2ObjectMap<V>
extends java.util.Map<java.lang.Short,V>, Short2ObjectFunction<V>

A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Short2ObjectMap.Entry<V> Type Specific Map Entry that reduces boxing/unboxing
static interface	Short2ObjectMap.FastEntrySet<V> Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Method Summary

Modifier and Type	Method and Description
default V	compute(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction) Deprecated.
V	compute(short key, ShortObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default V	computeIfAbsent(java.lang.Short key, java.util.function.Function<? super java.lang.Short,? extends V> mappingFunction) Deprecated.
V	computeIfAbsent(short key, Short2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default V	computeIfPresent(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction) Deprecated.
V	computeIfPresent(short key, ShortObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default boolean	containsKey(java.lang.Object key)
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
ObjectSet<java.util.Map.Entry<java.lang.Short,V>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Short,? super V> action) Deprecated.
void	forEach(ShortObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
default V	get(java.lang.Object key) Deprecated.
V	getDefaultReturnValue() Method to see what the default return value is.
V	getObject(short key) A Type Specific get method to reduce boxing/unboxing
default V	getOrDefault(java.lang.Object key, V defaultValue) Deprecated.
V	getOrDefault(short key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
default V	merge(java.lang.Short key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> mappingFunction) Deprecated.
V	merge(short key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Short2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(short key, V value) Type Specific method to reduce boxing/unboxing of values
default V	put(java.lang.Short key, V value) Deprecated.
default void	putAll(short[] keys, V[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(short[] keys, V[] 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(Short2ObjectMap<V> m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Short2ObjectMap<V> m) Type-Specific bulk put method put elements into the map if not present.
V	putIfAbsent(short key, V value) Type Specific method to reduce boxing/unboxing of values
default V	putIfAbsent(java.lang.Short key, V value) Deprecated.
default V	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	remove(short key, V value) Type Specific remove function to reduce boxing/unboxing
V	remShort(short key) Type Specific remove function to reduce boxing/unboxing
V	remShortOrDefault(short key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	replace(short key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
default V	replace(java.lang.Short key, V value) Deprecated.
boolean	replace(short key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
default boolean	replace(java.lang.Short key, V oldValue, V newValue) Deprecated.
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction) Deprecated.
void	replaceObjects(Short2ObjectMap<V> m) Type-Specific bulk replace method.
void	replaceObjects(ShortObjectUnaryOperator<V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Short2ObjectMap<V>	setDefaultReturnValue(V v) Method to define the default return value if a requested key isn't present
ObjectSet<Short2ObjectMap.Entry<V>>	short2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
ObjectCollection<V>	values()

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

getDefaultReturnValue

V getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Short2ObjectMap<V> setDefaultReturnValue(V v)

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

Parameters:

v - value that should be the default return value

Returns:

itself

put

V put(short key,
      V value)

Type Specific method to reduce boxing/unboxing of values

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)

putAll

default void putAll(short[] keys,
                    V[] values)

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

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

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

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

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

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putIfAbsent

V putIfAbsent(short key,
              V value)

Type Specific method to reduce boxing/unboxing of values

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)

putAllIfAbsent

void putAllIfAbsent(Short2ObjectMap<V> m)

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

Parameters:

m - elements that should be added if not present.

putAll

void putAll(Short2ObjectMap<V> m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(short key)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

default boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Short,V>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

Note:

in some implementations key does not have to be Short but just have to support equals with Short.

remShort

V remShort(short key)

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remove

default V remove(java.lang.Object key)

Specified by:

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

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

Note:

in some implementations key does not have to be Short but just have to support equals with Short.

remove

boolean remove(short key,
               V value)

Type Specific remove function to reduce boxing/unboxing

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)

remove

default boolean remove(java.lang.Object key,
                       java.lang.Object value)

Specified by:

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

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)

remShortOrDefault

V remShortOrDefault(short key,
                    V defaultValue)

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

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)

replace

boolean replace(short key,
                V oldValue,
                V newValue)

A Type Specific replace method to replace an existing value

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

Note:

this fails if the value is not present even if it matches the oldValue

replace

V replace(short key,
          V value)

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

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

Note:

this fails if the value is not present

replaceObjects

void replaceObjects(Short2ObjectMap<V> m)

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

Parameters:

m - elements that should be replaced.

replaceObjects

void replaceObjects(ShortObjectUnaryOperator<V> mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

compute

V compute(short key,
          ShortObjectUnaryOperator<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

V computeIfAbsent(short key,
                  Short2ObjectFunction<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

computeIfPresent

V computeIfPresent(short key,
                   ShortObjectUnaryOperator<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

Note:

if not present then compute is not executed

merge

V merge(short key,
        V value,
        ObjectObjectUnaryOperator<V,V> mappingFunction)

A Type Specific merge method to reduce boxing/unboxing

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

Note:

if the result matches the default return value then the key is removed from the map

mergeAll

void mergeAll(Short2ObjectMap<V> m,
              ObjectObjectUnaryOperator<V,V> mappingFunction)

A Bulk method for merging Maps.

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

Note:

if the result matches the default return value then the key is removed from the map

replace

@Deprecated
default boolean replace(java.lang.Short key,
                                     V oldValue,
                                     V newValue)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Short,V>

replace

@Deprecated
default V replace(java.lang.Short key,
                               V value)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Short,V>

getObject

V getObject(short key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

getObject in interface Short2ObjectFunction<V>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

V getOrDefault(short key,
               V defaultValue)

A Type Specific getOrDefault method to reduce boxing/unboxing

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

get

@Deprecated
default V get(java.lang.Object key)

Deprecated.

Specified by:

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

getOrDefault

@Deprecated
default V getOrDefault(java.lang.Object key,
                                    V defaultValue)

Deprecated.

Specified by:

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

replaceAll

@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

replaceAll in interface java.util.Map<java.lang.Short,V>

compute

@Deprecated
default V compute(java.lang.Short key,
                               java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

compute in interface java.util.Map<java.lang.Short,V>

computeIfAbsent

@Deprecated
default V computeIfAbsent(java.lang.Short key,
                                       java.util.function.Function<? super java.lang.Short,? extends V> mappingFunction)

Deprecated.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.Short,V>

computeIfPresent

@Deprecated
default V computeIfPresent(java.lang.Short key,
                                        java.util.function.BiFunction<? super java.lang.Short,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.Short,V>

merge

@Deprecated
default V merge(java.lang.Short key,
                             V value,
                             java.util.function.BiFunction<? super V,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

merge in interface java.util.Map<java.lang.Short,V>

forEach

void forEach(ShortObjectConsumer<V> action)

Type Specific forEach method to reduce boxing/unboxing

Parameters:

action - processor of the values that are iterator over

forEach

@Deprecated
default void forEach(java.util.function.BiConsumer<? super java.lang.Short,? super V> action)

Deprecated.

Specified by:

forEach in interface java.util.Map<java.lang.Short,V>

keySet

ShortSet keySet()

Specified by:

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

values

ObjectCollection<V> values()

Specified by:

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

entrySet

@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Short,V>> entrySet()

Deprecated.

Specified by:

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

short2ObjectEntrySet

ObjectSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()

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

Returns:

a EntrySet of the collection

put

@Deprecated
default V put(java.lang.Short key,
                           V value)

Deprecated.

Specified by:

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

putIfAbsent

@Deprecated
default V putIfAbsent(java.lang.Short key,
                                   V value)

Deprecated.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.Short,V>