org.agrona.collections

Class BiInt2ObjectMap<V>

java.lang.Object

org.agrona.collections.BiInt2ObjectMap<V>

Type Parameters:

V - type of the object stored in the map.

All Implemented Interfaces:

java.io.Serializable

public class BiInt2ObjectMap<V>
extends java.lang.Object
implements java.io.Serializable

Map that takes two part int key and associates with an object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BiInt2ObjectMap.EntryConsumer<V> Handler for a map entry
static interface	BiInt2ObjectMap.EntryFunction<V> Creates new values based upon keys

Constructor Summary

Constructors

Constructor and Description
BiInt2ObjectMap() Construct an empty map
BiInt2ObjectMap(int initialCapacity, float loadFactor) Construct a map that sets it initial capacity and load factor.

Method Summary

Modifier and Type	Method and Description
int	capacity() Get the total capacity for the map to which the load factor with be a fraction of.
void	clear() Clear out the map of all entries.
void	compact() Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
V	computeIfAbsent(int keyPartA, int keyPartB, BiInt2ObjectMap.EntryFunction<? extends V> mappingFunction) If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
void	forEach(BiInt2ObjectMap.EntryConsumer<V> consumer) Iterate over the contents of the map
void	forEach(java.util.function.Consumer<V> consumer) Iterate over the contents of the map
V	get(int keyPartA, int keyPartB) Retrieve a value from the map.
boolean	isEmpty() Is map empty or not.
float	loadFactor() Get the load factor beyond which the map will increase size.
V	put(int keyPartA, int keyPartB, V value) Put a value into the map.
V	remove(int keyPartA, int keyPartB) Remove a value from the map and return the value.
int	resizeThreshold() Get the actual threshold which when reached the map will resize.
int	size() Return the number of unique entries in the map.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BiInt2ObjectMap

public BiInt2ObjectMap()

Construct an empty map

BiInt2ObjectMap

public BiInt2ObjectMap(int initialCapacity,
                       float loadFactor)

Construct a map that sets it initial capacity and load factor.

Parameters:

initialCapacity - for the underlying hash map

loadFactor - for the underlying hash map

Method Detail

capacity

public int capacity()

Get the total capacity for the map to which the load factor with be a fraction of.

Returns:

the total capacity for the map.

loadFactor

public float loadFactor()

Get the load factor beyond which the map will increase size.

Returns:

load factor for when the map should increase size.

resizeThreshold

public int resizeThreshold()

Get the actual threshold which when reached the map will resize. This is a function of the current capacity and load factor.

Returns:

the threshold when the map will resize.

clear

public void clear()

Clear out the map of all entries.

compact

public void compact()

Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.

put

public V put(int keyPartA,
             int keyPartB,
             V value)

Put a value into the map.

Parameters:

keyPartA - for the key

keyPartB - for the key

value - to put into the map

Returns:

the previous value if found otherwise null

get

public V get(int keyPartA,
             int keyPartB)

Retrieve a value from the map.

Parameters:

keyPartA - for the key

keyPartB - for the key

Returns:

value matching the key if found or null if not found.

remove

public V remove(int keyPartA,
                int keyPartB)

Remove a value from the map and return the value.

Parameters:

keyPartA - for the key

keyPartB - for the key

Returns:

the previous value if found otherwise null

computeIfAbsent

public V computeIfAbsent(int keyPartA,
                         int keyPartB,
                         BiInt2ObjectMap.EntryFunction<? extends V> mappingFunction)

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

Parameters:

keyPartA - for the key

keyPartB - for the key

mappingFunction - creates values based upon keys if the key pair is missing

Returns:

the newly created or stored value.

forEach

public void forEach(java.util.function.Consumer<V> consumer)

Iterate over the contents of the map

Parameters:

consumer - to apply to each value in the map

forEach

public void forEach(BiInt2ObjectMap.EntryConsumer<V> consumer)

Iterate over the contents of the map

Parameters:

consumer - to apply to each value in the map

size

public int size()

Return the number of unique entries in the map.

Returns:

number of unique entries in the map.

isEmpty

public boolean isEmpty()

Is map empty or not.

Returns:

boolean indicating empty map or not

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object