Int2ObjectMap (Primitive-Collections 0.7.0 API)

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Int2ObjectFunction<V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>

All Known Subinterfaces:

Int2ObjectConcurrentMap<V>, Int2ObjectNavigableMap<V>, Int2ObjectOrderedMap<V>, Int2ObjectSortedMap<V>

All Known Implementing Classes:

AbstractInt2ObjectMap, ImmutableInt2ObjectOpenHashMap, Int2ObjectArrayMap, Int2ObjectAVLTreeMap, Int2ObjectConcurrentOpenHashMap, Int2ObjectLinkedOpenCustomHashMap, Int2ObjectLinkedOpenHashMap, Int2ObjectMaps.EmptyMap, Int2ObjectMaps.SingletonMap, Int2ObjectMaps.SynchronizedMap, Int2ObjectMaps.SynchronizedNavigableMap, Int2ObjectMaps.SynchronizedOrderedMap, Int2ObjectMaps.SynchronizedSortedMap, Int2ObjectMaps.UnmodifyableMap, Int2ObjectMaps.UnmodifyableNavigableMap, Int2ObjectMaps.UnmodifyableOrderedMap, Int2ObjectMaps.UnmodifyableSortedMap, Int2ObjectOpenCustomHashMap, Int2ObjectOpenHashMap, Int2ObjectRBTreeMap
```
public interface Int2ObjectMap<V>
extends java.util.Map<java.lang.Integer,V>, Int2ObjectFunction<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 class`	`Int2ObjectMap.BuilderCache<V>` Builder Cache for allowing to buildMaps
`static interface`	`Int2ObjectMap.Entry<V>` Type Specific Map Entry that reduces boxing/unboxing
`static interface`	`Int2ObjectMap.FastEntrySet<V>` Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value
`static class`	`Int2ObjectMap.MapBuilder` Helper class that reduces the method spam of the Map Class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static Int2ObjectMap.MapBuilder`	`builder()` Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
`default V`	`compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)` Deprecated.
`V`	`compute(int key, IntObjectUnaryOperator<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`default V`	`computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends V> mappingFunction)` Deprecated.
`V`	`computeIfAbsent(int key, Int2ObjectFunction<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`default V`	`computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)` Deprecated.
`V`	`computeIfPresent(int key, IntObjectUnaryOperator<V> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(int key)` Type Specific method to reduce boxing/unboxing of values
`default boolean`	`containsKey(java.lang.Object key)`
`Int2ObjectMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectSet<java.util.Map.Entry<java.lang.Integer,V>>`	`entrySet()` Deprecated.
`default void`	`forEach(java.util.function.BiConsumer<? super java.lang.Integer,? super V> action)` Deprecated.
`void`	`forEach(IntObjectConsumer<V> action)` Type Specific forEach method to reduce boxing/unboxing
`V`	`get(int key)` A Type Specific get 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`	`getOrDefault(int key, V defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`default V`	`getOrDefault(java.lang.Object key, V defaultValue)` Deprecated.
`ObjectSet<Int2ObjectMap.Entry<V>>`	`int2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`IntSet`	`keySet()`
`default V`	`merge(java.lang.Integer key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> mappingFunction)` Deprecated.
`V`	`merge(int key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`void`	`mergeAll(Int2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction)` A Bulk method for merging Maps.
`default V`	`put(java.lang.Integer key, V value)` Deprecated.
`V`	`put(int key, V value)` Type Specific method to reduce boxing/unboxing of values
`default void`	`putAll(int[] keys, V[] values)` Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAll(int[] 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(Int2ObjectMap<V> m)` Type Specific function for the bull putting of values
`default void`	`putAll(java.lang.Integer[] keys, V[] values)` Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAll(java.lang.Integer[] keys, V[] 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`	`putAllIfAbsent(Int2ObjectMap<V> m)` Type-Specific bulk put method put elements into the map if not present.
`default V`	`putIfAbsent(java.lang.Integer key, V value)` Deprecated.
`V`	`putIfAbsent(int key, V value)` Type Specific method to reduce boxing/unboxing of values
`V`	`remove(int key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(int key, V value)` Type Specific remove function to reduce boxing/unboxing
`default V`	`remove(java.lang.Object key)`
`default boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`V`	`removeOrDefault(int key, V defaultValue)` Type-Specific Remove function with a default return value if wanted.
`default V`	`replace(java.lang.Integer key, V value)` Deprecated.
`default boolean`	`replace(java.lang.Integer key, V oldValue, V newValue)` Deprecated.
`V`	`replace(int key, V value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(int key, V oldValue, V newValue)` A Type Specific replace method to replace an existing value
`default void`	`replaceAll(java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)` Deprecated.
`void`	`replaceObjects(Int2ObjectMap<V> m)` Type-Specific bulk replace method.
`void`	`replaceObjects(IntObjectUnaryOperator<V> mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`Int2ObjectMap<V>`	`setDefaultReturnValue(V v)` Method to define the default return value if a requested key isn't present
`V`	`supplyIfAbsent(int key, ObjectSupplier<V> valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`default Int2ObjectMap<V>`	`synchronize()` Creates a Wrapped Map that is Synchronized
`default Int2ObjectMap<V>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped Map that is Synchronized
`default Int2ObjectMap<V>`	`unmodifiable()` Creates a Wrapped Map that is unmodifiable
`ObjectCollection<V>`	`values()`

Methods inherited from interface java.util.Map
clear, containsValue, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction
apply

- Method Detail
  - builder
```
static Int2ObjectMap.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
```
V getDefaultReturnValue()
```
    Method to see what the default return value is.
    
    Returns:
    
    default return value
  - setDefaultReturnValue
```
Int2ObjectMap<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
  - copy
```
Int2ObjectMap<V> 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
```
V put(int 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(int[] 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(int[] 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)
  - putAll
```
default void putAll(java.lang.Integer[] keys,
                    V[] 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.Integer[] keys,
            V[] 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
```
V putIfAbsent(int 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(Int2ObjectMap<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(Int2ObjectMap<V> m)
```
    Type Specific function for the bull putting of values
    
    Parameters:
    
    m - the elements that should be inserted
  - containsKey
```
boolean containsKey(int 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.Integer,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 Integer but just have to support equals with Integer.
  - remove
```
V remove(int 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.Integer,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 Integer but just have to support equals with Integer.
  - remove
```
boolean remove(int 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.Integer,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)
  - removeOrDefault
```
V removeOrDefault(int 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(int 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(int 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(Int2ObjectMap<V> m)
```
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Parameters:
    
    m - elements that should be replaced.
  - replaceObjects
```
void replaceObjects(IntObjectUnaryOperator<V> mappingFunction)
```
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - compute
```
V compute(int key,
          IntObjectUnaryOperator<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(int key,
                  Int2ObjectFunction<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
  - supplyIfAbsent
```
V supplyIfAbsent(int key,
                 ObjectSupplier<V> 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
  - computeIfPresent
```
V computeIfPresent(int key,
                   IntObjectUnaryOperator<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(int 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(Int2ObjectMap<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.Integer key,
                                     V oldValue,
                                     V newValue)
```
    Deprecated.
    
    Specified by:
    
    replace in interface java.util.Map<java.lang.Integer,V>
  - replace
```
@Deprecated
default V replace(java.lang.Integer key,
                               V value)
```
    Deprecated.
    
    Specified by:
    
    replace in interface java.util.Map<java.lang.Integer,V>
  - get
```
V get(int key)
```
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Int2ObjectFunction<V>
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
V getOrDefault(int 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.Integer,V>
  - getOrDefault
```
@Deprecated
default V getOrDefault(java.lang.Object key,
                                    V defaultValue)
```
    Deprecated.
    
    Specified by:
    
    getOrDefault in interface java.util.Map<java.lang.Integer,V>
  - replaceAll
```
@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    replaceAll in interface java.util.Map<java.lang.Integer,V>
  - compute
```
@Deprecated
default V compute(java.lang.Integer key,
                               java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    compute in interface java.util.Map<java.lang.Integer,V>
  - computeIfAbsent
```
@Deprecated
default V computeIfAbsent(java.lang.Integer key,
                                       java.util.function.Function<? super java.lang.Integer,? extends V> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    computeIfAbsent in interface java.util.Map<java.lang.Integer,V>
  - computeIfPresent
```
@Deprecated
default V computeIfPresent(java.lang.Integer key,
                                        java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    computeIfPresent in interface java.util.Map<java.lang.Integer,V>
  - merge
```
@Deprecated
default V merge(java.lang.Integer 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.Integer,V>
  - forEach
```
void forEach(IntObjectConsumer<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.Integer,? super V> action)
```
    Deprecated.
    
    Specified by:
    
    forEach in interface java.util.Map<java.lang.Integer,V>
  - keySet
```
IntSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,V>
  - values
```
ObjectCollection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,V>
  - entrySet
```
@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Integer,V>> entrySet()
```
    Deprecated.
    
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.Integer,V>
  - int2ObjectEntrySet
```
ObjectSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()
```
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Int2ObjectMap<V> synchronize()
```
    Creates a Wrapped Map that is Synchronized
    
    Returns:
    
    a new Map that is synchronized
    
    See Also:
    
    Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)
  - synchronize
```
default Int2ObjectMap<V> 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:
    
    Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)
  - unmodifiable
```
default Int2ObjectMap<V> unmodifiable()
```
    Creates a Wrapped Map that is unmodifiable
    
    Returns:
    
    a new Map Wrapper that is unmodifiable
    
    See Also:
    
    Int2ObjectMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)
  - put
```
@Deprecated
default V put(java.lang.Integer key,
                           V value)
```
    Deprecated.
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Integer,V>
  - putIfAbsent
```
@Deprecated
default V putIfAbsent(java.lang.Integer key,
                                   V value)
```
    Deprecated.
    
    Specified by:
    
    putIfAbsent in interface java.util.Map<java.lang.Integer,V>

Interface Int2ObjectMap<V>

Nested Class Summary

Method Summary

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction

Method Detail

builder

getDefaultReturnValue

setDefaultReturnValue

copy

put

putAll

putAll

putAll

putAll

putIfAbsent

putAllIfAbsent

putAll

containsKey

containsKey

remove

remove

remove

remove

removeOrDefault

replace

replace

replaceObjects

replaceObjects

compute

computeIfAbsent

supplyIfAbsent

computeIfPresent

merge

mergeAll

replace

replace

get

getOrDefault

get

getOrDefault

replaceAll

compute

computeIfAbsent

computeIfPresent

merge

forEach

forEach

keySet

values

entrySet

int2ObjectEntrySet

synchronize

synchronize

unmodifiable

put

putIfAbsent