speiger.src.collections.bytes.maps.interfaces

Interface Byte2IntMap

All Superinterfaces:

Byte2IntFunction, java.util.Map<java.lang.Byte,java.lang.Integer>

All Known Subinterfaces:

Byte2IntConcurrentMap, Byte2IntNavigableMap, Byte2IntOrderedMap, Byte2IntSortedMap

All Known Implementing Classes:

AbstractByte2IntMap, Byte2IntArrayMap, Byte2IntAVLTreeMap, Byte2IntConcurrentOpenHashMap, Byte2IntLinkedOpenCustomHashMap, Byte2IntLinkedOpenHashMap, Byte2IntMaps.EmptyMap, Byte2IntMaps.SingletonMap, Byte2IntMaps.SynchronizedMap, Byte2IntMaps.SynchronizedNavigableMap, Byte2IntMaps.SynchronizedOrderedMap, Byte2IntMaps.SynchronizedSortedMap, Byte2IntMaps.UnmodifyableMap, Byte2IntMaps.UnmodifyableNavigableMap, Byte2IntMaps.UnmodifyableOrderedMap, Byte2IntMaps.UnmodifyableSortedMap, Byte2IntOpenCustomHashMap, Byte2IntOpenHashMap, Byte2IntRBTreeMap, ImmutableByte2IntOpenHashMap

public interface Byte2IntMap
extends java.util.Map<java.lang.Byte,java.lang.Integer>, Byte2IntFunction

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 class	Byte2IntMap.BuilderCache Builder Cache for allowing to buildMaps
static interface	Byte2IntMap.Entry Type Specific Map Entry that reduces boxing/unboxing
static interface	Byte2IntMap.FastEntrySet Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value
static class	Byte2IntMap.MapBuilder Helper class that reduces the method spam of the Map Class.

Method Summary

Modifier and Type	Method and Description
int	addTo(byte key, int value) A Helper method to add a primitives together.
void	addToAll(Byte2IntMap m) A Helper method to bulk add primitives together.
default int	applyAsInt(byte key) Type Specific get function to reduce boxing/unboxing
static Byte2IntMap.MapBuilder	builder() Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
ObjectSet<Byte2IntMap.Entry>	byte2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
default java.lang.Integer	compute(java.lang.Byte key, java.util.function.BiFunction<? super java.lang.Byte,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
default java.lang.Integer	computeIfAbsent(java.lang.Byte key, java.util.function.Function<? super java.lang.Byte,? extends java.lang.Integer> mappingFunction) Deprecated.
default java.lang.Integer	computeIfPresent(java.lang.Byte key, java.util.function.BiFunction<? super java.lang.Byte,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
int	computeInt(byte key, ByteIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(byte key, Byte2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(byte key, ByteIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(byte key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
default boolean	containsValue(java.lang.Object value)
Byte2IntMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Byte,java.lang.Integer>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Byte,? super java.lang.Integer> action) Deprecated.
void	forEach(ByteIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
int	get(byte key) A Type Specific get method to reduce boxing/unboxing
default java.lang.Integer	get(java.lang.Object key) Deprecated.
int	getDefaultReturnValue() Method to see what the default return value is.
int	getOrDefault(byte key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default java.lang.Integer	getOrDefault(java.lang.Object key, java.lang.Integer defaultValue) Deprecated.
ByteSet	keySet()
default java.lang.Integer	merge(java.lang.Byte key, java.lang.Integer value, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
void	mergeAllInt(Byte2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(byte key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
default int	put(Byte2IntMap.Entry entry) A Helper method that allows to put int a Byte2IntMap.Entry into a map.
int	put(byte key, int value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Integer	put(java.lang.Byte key, java.lang.Integer value) Deprecated.
default java.lang.Integer	put(java.util.Map.Entry<java.lang.Byte,java.lang.Integer> entry) A Helper method that allows to put int a Map.Entry into a map.
default void	putAll(byte[] keys, int[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(byte[] keys, int[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
default void	putAll(java.lang.Byte[] keys, java.lang.Integer[] values) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.lang.Byte[] keys, java.lang.Integer[] 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(Byte2IntMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Byte2IntMap m) Type-Specific bulk put method put elements into the map if not present.
int	putIfAbsent(byte key, int value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Integer	putIfAbsent(java.lang.Byte key, java.lang.Integer value) Deprecated.
int	remove(byte key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(byte key, int value) Type Specific remove function to reduce boxing/unboxing
default java.lang.Integer	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
int	removeOrDefault(byte key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
int	replace(byte key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
default java.lang.Integer	replace(java.lang.Byte key, java.lang.Integer value) Deprecated.
default boolean	replace(java.lang.Byte key, java.lang.Integer oldValue, java.lang.Integer newValue) Deprecated.
boolean	replace(byte key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Byte,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
void	replaceInts(Byte2IntMap m) Type-Specific bulk replace method.
void	replaceInts(ByteIntUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Byte2IntMap	setDefaultReturnValue(int v) Method to define the default return value if a requested key isn't present
int	subFrom(byte key, int value) A Helper method to subtract from primitive from each other.
int	supplyIntIfAbsent(byte key, IntSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
default Byte2IntMap	synchronize() Creates a Wrapped Map that is Synchronized
default Byte2IntMap	synchronize(java.lang.Object mutex) Creates a Wrapped Map that is Synchronized
default Byte2IntMap	unmodifiable() Creates a Wrapped Map that is unmodifiable
IntCollection	values()

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

builder

static Byte2IntMap.MapBuilder builder()

Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.

Returns:

a MapBuilder

getDefaultReturnValue

int getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Byte2IntMap setDefaultReturnValue(int 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

copy

Byte2IntMap copy()

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

Returns:

a Shallow Copy of the Map

Note:

Wrappers and view Maps will not support this feature

put

int put(byte key,
        int 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)

put

default int put(Byte2IntMap.Entry entry)

A Helper method that allows to put int a Byte2IntMap.Entry into a map.

Parameters:

entry - then Entry that should be inserted.

Returns:

the last present value or default return value.

put

default java.lang.Integer put(java.util.Map.Entry<java.lang.Byte,java.lang.Integer> entry)

A Helper method that allows to put int a Map.Entry into a map.

Parameters:

entry - then Entry that should be inserted.

Returns:

the last present value or default return value.

putAll

default void putAll(byte[] keys,
                    int[] 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(byte[] keys,
            int[] 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)

putAll

default void putAll(java.lang.Byte[] keys,
                    java.lang.Integer[] values)

Type Specific Object 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(java.lang.Byte[] keys,
            java.lang.Integer[] values,
            int offset,
            int size)

Type Specific Object 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

int putIfAbsent(byte key,
                int 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(Byte2IntMap m)

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

Parameters:

m - elements that should be added if not present.

addTo

int addTo(byte key,
          int value)

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

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.

addToAll

void addToAll(Byte2IntMap m)

A Helper method to bulk add primitives together.

Parameters:

m - the values that should be added/inserted

subFrom

int subFrom(byte key,
            int value)

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

putAll

void putAll(Byte2IntMap m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(byte 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.Byte,java.lang.Integer>

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 Byte but just have to support equals with Byte.

containsValue

boolean containsValue(int value)

Type Specific method to reduce boxing/unboxing of values

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

default boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Byte,java.lang.Integer>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

Note:

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

remove

int remove(byte 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 java.lang.Integer remove(java.lang.Object key)

Specified by:

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

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 Byte but just have to support equals with Byte.

remove

boolean remove(byte key,
               int 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.Byte,java.lang.Integer>

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)

removeOrDefault

int removeOrDefault(byte key,
                    int 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(byte key,
                int oldValue,
                int 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

int replace(byte key,
            int 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

replaceInts

void replaceInts(Byte2IntMap m)

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

Parameters:

m - elements that should be replaced.

replaceInts

void replaceInts(ByteIntUnaryOperator mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

computeInt

int computeInt(byte key,
               ByteIntUnaryOperator 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

computeIntIfAbsent

int computeIntIfAbsent(byte key,
                       Byte2IntFunction 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

supplyIntIfAbsent

int supplyIntIfAbsent(byte key,
                      IntSupplier valueProvider)

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

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeIntIfPresent

int computeIntIfPresent(byte key,
                        ByteIntUnaryOperator 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

mergeInt

int mergeInt(byte key,
             int value,
             IntIntUnaryOperator 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

mergeAllInt

void mergeAllInt(Byte2IntMap m,
                 IntIntUnaryOperator 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.Byte key,
                                     java.lang.Integer oldValue,
                                     java.lang.Integer newValue)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Byte,java.lang.Integer>

replace

@Deprecated
default java.lang.Integer replace(java.lang.Byte key,
                                               java.lang.Integer value)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Byte,java.lang.Integer>

applyAsInt

default int applyAsInt(byte key)

Description copied from interface: Byte2IntFunction

Type Specific get function to reduce boxing/unboxing

Specified by:

applyAsInt in interface Byte2IntFunction

Parameters:

key - the value that should be processed

Returns:

the result of the function

get

int get(byte key)

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

int getOrDefault(byte key,
                 int 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 java.lang.Integer get(java.lang.Object key)

Deprecated.

Specified by:

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

getOrDefault

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

Deprecated.

Specified by:

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

replaceAll

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

Deprecated.

Specified by:

replaceAll in interface java.util.Map<java.lang.Byte,java.lang.Integer>

compute

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

Deprecated.

Specified by:

compute in interface java.util.Map<java.lang.Byte,java.lang.Integer>

computeIfAbsent

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

Deprecated.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.Byte,java.lang.Integer>

computeIfPresent

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

Deprecated.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.Byte,java.lang.Integer>

merge

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

Deprecated.

Specified by:

merge in interface java.util.Map<java.lang.Byte,java.lang.Integer>

forEach

void forEach(ByteIntConsumer 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.Byte,? super java.lang.Integer> action)

Deprecated.

Specified by:

forEach in interface java.util.Map<java.lang.Byte,java.lang.Integer>

keySet

ByteSet keySet()

Specified by:

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

values

IntCollection values()

Specified by:

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

entrySet

@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Byte,java.lang.Integer>> entrySet()

Deprecated.

Specified by:

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

byte2IntEntrySet

ObjectSet<Byte2IntMap.Entry> byte2IntEntrySet()

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

Returns:

a EntrySet of the collection

synchronize

default Byte2IntMap synchronize()

Creates a Wrapped Map that is Synchronized

Returns:

a new Map that is synchronized

See Also:

Byte2IntMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)

synchronize

default Byte2IntMap synchronize(java.lang.Object mutex)

Creates a Wrapped Map that is Synchronized

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new Map Wrapper that is synchronized

See Also:

Byte2IntMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)

unmodifiable

default Byte2IntMap unmodifiable()

Creates a Wrapped Map that is unmodifiable

Returns:

a new Map Wrapper that is unmodifiable

See Also:

Byte2IntMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)

put

@Deprecated
default java.lang.Integer put(java.lang.Byte key,
                                           java.lang.Integer value)

Deprecated.

Specified by:

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

putIfAbsent

@Deprecated
default java.lang.Integer putIfAbsent(java.lang.Byte key,
                                                   java.lang.Integer value)

Deprecated.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.Byte,java.lang.Integer>