IntKeyMap (bikey 0.9.0 API)

Type Parameters:

T - the type of mapped values

All Superinterfaces:

java.lang.Iterable<IntObjectEntry<T>>

All Known Implementing Classes:

RadixHamTrie
```
public interface IntKeyMap<T>
extends java.lang.Iterable<IntObjectEntry<T>>
```
An object that maps int keys to values. A map cannot contain duplicate keys; each key can map to at most one value. Has the same behaviour than a Map<Integer,T>, but with an int primitive value.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all of the elements from this map.
`default T`	`compute(int key, java.util.function.BiFunction<java.lang.Integer,? super T,? extends T> remappingFunction)` Attempts to compute a mapping for the specified key and its current mapped value (or `null` if there is no current mapping) (Method `merge()` is often simpler to use for such purposes.)
`default T`	`computeIfAbsent(int key, java.util.function.Function<java.lang.Integer,? extends T> mappingFunction)` If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map unless `null`.
`default T`	`computeIfPresent(int key, java.util.function.BiFunction<java.lang.Integer,? super T,? extends T> remappingFunction)` If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
`default boolean`	`containsKey(int key)` Returns `true` if this map contains the specified element.
`boolean`	`containsValue(java.lang.Object value)` Returns `true` if this map maps one or more keys to the specified value.
`java.util.Set<IntObjectEntry<T>>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`void`	`forEach(IntObjectConsumer<T> action)` Performs the given action for each pair of element of the map until all elements have been processed or the action throws an exception.
`void`	`forEachKey(java.util.function.IntConsumer action)` Performs the given action to each int key element of the map until all elements have been processed or the action throws an exception.
`T`	`get(int key)` Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
`default T`	`getOrDefault(int key, T defaultValue)` Returns the value to which the specified key is mapped, or `defaultValue` if this map contains no mapping for the key.
`default boolean`	`isEmpty()` Returns `true` if this map contains no elements.
`java.util.Set<java.lang.Integer>`	`keySet()` Returns a `Set` view of the keys contained in this map.
`default T`	`merge(int key, T value, java.util.function.BiFunction<? super T,? super T,? extends T> remappingFunction)` If the specified key is not already associated with a value, associates it with the given non-null value.
`T`	`put(int key, T value)` Associates the specified value with the specified key in this int keyed map If the map previously contained a mapping for the key, the old value is replaced by the specified value.
`default void`	`putAll(IntKeyMap<? extends T> m)` Copies all of the mappings from the specified map to this map.
`default T`	`putIfAbsent(int key, T value)` If the specified key is not already associated with a value associates it with the given value and returns `null`, else returns the current value.
`T`	`remove(int key)` Removes the specified element from this map if it is present.
`default boolean`	`remove(int key, java.lang.Object value)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`default T`	`replace(int key, T value)` Replaces the entry for the specified key only if it is currently mapped to some value.
`default boolean`	`replace(int key, T oldValue, T newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`int`	`size()` Returns the number of elements in this map (its cardinality).
`default java.util.Spliterator<IntObjectEntry<T>>`	`spliterator()`
`default java.util.stream.Stream<IntObjectEntry<T>>`	`stream()` Returns a sequential `Stream` with this collection of key and value pairs as its source.
`java.util.Collection<T>`	`values()` Returns a `Collection` view of the values contained in this map.

Methods inherited from interface java.lang.Iterable
forEach, iterator

- Method Detail
  - put
```
T put(int key,
      T value)
```
    Associates the specified value with the specified key in this int keyed map If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
    
    Throws:
    
    java.lang.NullPointerException - if the specified value is null.
  - putAll
```
default void putAll(IntKeyMap<? extends T> m)
```
    Copies all of the mappings from the specified map to this map. The effect of this call is equivalent to that of calling put(key, value) on this map once for each mapping from key key to value value in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
    
    Parameters:
    
    m - mappings to be stored in this map
    
    Throws:
    
    java.lang.NullPointerException - if the specified map is null, or if the specified map contains null keys or values
    
    java.lang.IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map
  - get
```
T get(int key)
```
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this map contains no mapping for the key
  - remove
```
T remove(int key)
```
    Removes the specified element from this map if it is present.
    
    Parameters:
    
    key - the key to remove
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
    
    Throws:
    
    java.lang.NullPointerException - if one of the specified elements are null
  - containsKey
```
default boolean containsKey(int key)
```
    Returns true if this map contains the specified element.
    
    Parameters:
    
    key - key whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains the specified key
  - size
```
int size()
```
    Returns the number of elements in this map (its cardinality).
    
    Returns:
    
    the number of elements in this map
  - clear
```
void clear()
```
    Removes all of the elements from this map. The map will be empty after this call returns.
  - forEach
```
void forEach(IntObjectConsumer<T> action)
```
    Performs the given action for each pair of element of the map until all elements have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.
    
    Parameters:
    
    action - The action to be performed for each pair of elements
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - forEachKey
```
void forEachKey(java.util.function.IntConsumer action)
```
    Performs the given action to each int key element of the map until all elements have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.
    
    Parameters:
    
    action - The action to be performed for each int key element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - containsValue
```
boolean containsValue(java.lang.Object value)
```
    Returns true if this map maps one or more keys to the specified value.
    
    Parameters:
    
    value - value whose presence in this map is to be tested
    
    Returns:
    
    true if this map maps one or more keys to the specified value
  - values
```
java.util.Collection<T> values()
```
    Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined. The collection doesn't support element removal.
    
    Returns:
    
    a collection view of the values contained in this map
  - keySet
```
java.util.Set<java.lang.Integer> keySet()
```
    Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the set is in progress the results of the iteration are undefined. The set doesn't support element removal.
    
    Returns:
    
    a set view of the mappings contained in this map
  - entrySet
```
java.util.Set<IntObjectEntry<T>> entrySet()
```
    Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the set is in progress the results of the iteration are undefined.
    
    Returns:
    
    a set view of the mappings contained in this map
  - isEmpty
```
default boolean isEmpty()
```
    Returns true if this map contains no elements.
    
    Returns:
    
    true if this map contains no elements
  - stream
```
default java.util.stream.Stream<IntObjectEntry<T>> stream()
```
    Returns a sequential Stream with this collection of key and value pairs as its source.
    
    Returns:
    
    a sequential Stream over the pairs of elements in this collection as IntObjectEntry
  - spliterator
```
default java.util.Spliterator<IntObjectEntry<T>> spliterator()
```
    Specified by:
    
    spliterator in interface java.lang.Iterable<IntObjectEntry<T>>
  - getOrDefault
```
default T getOrDefault(int key,
                       T defaultValue)
```
    Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    defaultValue - the default mapping of the key
    
    Returns:
    
    the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key
    
    Throws:
    
    java.lang.NullPointerException - if the specified key is null
  - putIfAbsent
```
default T putIfAbsent(int key,
                      T value)
```
    If the specified key is not already associated with a value associates it with the given value and returns null, else returns the current value.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or null if there was no mapping for the key.
    
    Throws:
    
    java.lang.NullPointerException - if the specified value is null
  - remove
```
default boolean remove(int key,
                       java.lang.Object value)
```
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value expected to be associated with the specified key
    
    Returns:
    
    true if the value was removed
    
    Throws:
    
    java.lang.NullPointerException - if the specified value is null
  - replace
```
default boolean replace(int key,
                        T oldValue,
                        T newValue)
```
    Replaces the entry for the specified key only if currently mapped to the specified value.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    oldValue - value expected to be associated with the specified key
    
    newValue - value to be associated with the specified key
    
    Returns:
    
    true if the value was replaced
    
    Throws:
    
    java.lang.NullPointerException - if a specified newValue is null
    
    java.lang.NullPointerException - if oldValue is null
  - replace
```
default T replace(int key,
                  T value)
```
    Replaces the entry for the specified key only if it is currently mapped to some value.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or null if there was no mapping for the key.
    
    Throws:
    
    java.lang.NullPointerException - if the specified value is null
  - computeIfAbsent
```
default T computeIfAbsent(int key,
                          java.util.function.Function<java.lang.Integer,? extends T> mappingFunction)
```
    If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map unless null.
    If the function returns null no mapping is recorded. If the function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded. The most common usage is to construct a new object serving as an initial mapped value or memoized result.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    mappingFunction - the function to compute a value
    
    Returns:
    
    the current (existing or computed) value associated with the specified key
    
    Throws:
    
    java.lang.NullPointerException - if the mappingFunction is null or cumputed value is null
  - computeIfPresent
```
default T computeIfPresent(int key,
                           java.util.function.BiFunction<java.lang.Integer,? super T,? extends T> remappingFunction)
```
    If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
    If the function returns null, the mapping is removed. If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    remappingFunction - the function to compute a value
    
    Returns:
    
    the new value associated with the specified key, or null if none
    
    Throws:
    
    java.lang.NullPointerException - if the remappingFunction is null
  - compute
```
default T compute(int key,
                  java.util.function.BiFunction<java.lang.Integer,? super T,? extends T> remappingFunction)
```
    Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping) (Method merge() is often simpler to use for such purposes.)
    If the function returns null, the mapping is removed (or remains absent if initially absent). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    remappingFunction - the function to compute a value
    
    Returns:
    
    the new value associated with the specified key, or null if none
    
    Throws:
    
    java.lang.NullPointerException - if the remappingFunction is null
  - merge
```
default T merge(int key,
                T value,
                java.util.function.BiFunction<? super T,? super T,? extends T> remappingFunction)
```
    If the specified key is not already associated with a value, associates it with the given non-null value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null. This method may be of use when combining multiple mapped values for a key.
    If the function returns null the mapping is removed. If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    The implementation makes no guarantees about synchronization or atomicity properties of this method.
    
    Parameters:
    
    key - key with which the resulting value is to be associated
    
    value - the non-null value to be merged with the existing value associated with the key or, if no existing value to be associated with the key
    
    remappingFunction - the function to recompute a value if present
    
    Returns:
    
    the new value associated with the specified key, or null if no value is associated with the key

Interface IntKeyMap<T>

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

put

putAll

get

remove

containsKey

size

clear

forEach

forEachKey

containsValue

values

keySet

entrySet

isEmpty

stream

spliterator

getOrDefault

putIfAbsent

remove

replace

replace

computeIfAbsent

computeIfPresent

compute

merge