EconomicMap (GraalVM SDK Java API Reference)

All Superinterfaces:

UnmodifiableEconomicMap<K,V>
```
public interface EconomicMap<K,V>
extends UnmodifiableEconomicMap<K,V>
```
Memory efficient map data structure.

Since:

19.0

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all of the mappings from this map.
`static <K,V> EconomicMap<K,V>`	`create()` Creates a new map that guarantees insertion order on the key set with the default `Equivalence.DEFAULT` comparison strategy for keys.
`static <K,V> EconomicMap<K,V>`	`create(Equivalence strategy)` Creates a new map that guarantees insertion order on the key set with the given comparison strategy for keys.
`static <K,V> EconomicMap<K,V>`	`create(Equivalence strategy, int initialCapacity)` Creates a new map that guarantees insertion order on the key set and initializes with a specified capacity.
`static <K,V> EconomicMap<K,V>`	`create(Equivalence strategy, UnmodifiableEconomicMap<K,V> m)` Creates a new map that guarantees insertion order on the key set and copies all elements from the specified existing map.
`static <K,V> EconomicMap<K,V>`	`create(int initialCapacity)` Creates a new map that guarantees insertion order on the key set with the default `Equivalence.DEFAULT` comparison strategy for keys and initializes with a specified capacity.
`static <K,V> EconomicMap<K,V>`	`create(UnmodifiableEconomicMap<K,V> m)` Creates a new map that guarantees insertion order on the key set with the default `Equivalence.DEFAULT` comparison strategy for keys and copies all elements from the specified existing map.
`MapCursor<K,V>`	`getEntries()` Returns a `MapCursor` view of the mappings contained in this map.
`V`	`put(K key, V value)` Associates `value` with `key` in this map.
`default void`	`putAll(EconomicMap<K,V> other)` Copies all of the mappings from `other` to this map.
`default void`	`putAll(UnmodifiableEconomicMap<? extends K,? extends V> other)` Copies all of the mappings from `other` to this map.
`V`	`removeKey(K key)` Removes the mapping for `key` from this map if it is present.
`void`	`replaceAll(BiFunction<? super K,? super V,? extends V> function)` Replaces each entry's value with the result of invoking `function` on that entry until all entries have been processed or the function throws an exception.
`static <K,V> EconomicMap<K,V>`	`wrapMap(Map<K,V> map)` Wraps an existing `Map` as an `EconomicMap`.

Methods inherited from interface org.graalvm.collections.UnmodifiableEconomicMap
containsKey, get, get, getKeys, getValues, isEmpty, size

- Method Detail
  - put
```
V put(K key,
      V value)
```
    Associates value with key in this map. If the map previously contained a mapping for key, the old value is replaced by value.
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
    
    Since:
    
    19.0
  - putAll
```
default void putAll(EconomicMap<K,V> other)
```
    Copies all of the mappings from other to this map.
    
    Since:
    
    19.0
  - putAll
```
default void putAll(UnmodifiableEconomicMap<? extends K,? extends V> other)
```
    Copies all of the mappings from other to this map.
    
    Since:
    
    19.0
  - clear
```
void clear()
```
    Removes all of the mappings from this map. The map will be empty after this call returns.
    
    Since:
    
    19.0
  - removeKey
```
V removeKey(K key)
```
    Removes the mapping for key from this map if it is present. The map will not contain a mapping for key once the call returns.
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
    
    Since:
    
    19.0
  - getEntries
```
MapCursor<K,V> getEntries()
```
    Returns a MapCursor view of the mappings contained in this map.
    
    Specified by:
    
    getEntries in interface UnmodifiableEconomicMap<K,V>
    
    Since:
    
    19.0
  - replaceAll
```
void replaceAll(BiFunction<? super K,? super V,? extends V> function)
```
    Replaces each entry's value with the result of invoking function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create()
```
    Creates a new map that guarantees insertion order on the key set with the default Equivalence.DEFAULT comparison strategy for keys.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create(int initialCapacity)
```
    Creates a new map that guarantees insertion order on the key set with the default Equivalence.DEFAULT comparison strategy for keys and initializes with a specified capacity.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create(Equivalence strategy)
```
    Creates a new map that guarantees insertion order on the key set with the given comparison strategy for keys.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create(UnmodifiableEconomicMap<K,V> m)
```
    Creates a new map that guarantees insertion order on the key set with the default Equivalence.DEFAULT comparison strategy for keys and copies all elements from the specified existing map.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create(Equivalence strategy,
                                     UnmodifiableEconomicMap<K,V> m)
```
    Creates a new map that guarantees insertion order on the key set and copies all elements from the specified existing map.
    
    Since:
    
    19.0
  - create
```
static <K,V> EconomicMap<K,V> create(Equivalence strategy,
                                     int initialCapacity)
```
    Creates a new map that guarantees insertion order on the key set and initializes with a specified capacity.
    
    Since:
    
    19.0
  - wrapMap
```
static <K,V> EconomicMap<K,V> wrapMap(Map<K,V> map)
```
    Wraps an existing Map as an EconomicMap.
    
    Since:
    
    19.0

Interface EconomicMap<K,V>

Method Summary

Methods inherited from interface org.graalvm.collections.UnmodifiableEconomicMap

Method Detail

put

putAll

putAll

clear

removeKey

getEntries

replaceAll

create

create

create

create

create

create

wrapMap