| <html devsite="true"> |
| <head> |
| <title>ArrayMap</title> |
| {% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <div itemscope="" itemtype="http://developers.google.com/ReferenceObject"> |
| <meta itemprop="name" content="ArrayMap"> |
| <meta itemprop="path" content="androidx.collection"> |
| <meta itemprop="property" content="containsAll(java.util.Collection<?>)"> |
| <meta itemprop="property" content="containsKey(java.lang.Object)"> |
| <meta itemprop="property" content="containsValue(java.lang.Object)"> |
| <meta itemprop="property" content="entrySet()"> |
| <meta itemprop="property" content="get(java.lang.Object)"> |
| <meta itemprop="property" content="keySet()"> |
| <meta itemprop="property" content="putAll(java.util.Map<? extends K,? extends V>)"> |
| <meta itemprop="property" content="remove(java.lang.Object)"> |
| <meta itemprop="property" content="removeAll(java.util.Collection<?>)"> |
| <meta itemprop="property" content="retainAll(java.util.Collection<?>)"> |
| <meta itemprop="property" content="values()"> |
| <meta itemprop="language" content="JAVA"> |
| </div> |
| <div id="header-block"> |
| <div> |
| <h1>ArrayMap</h1> |
| </div> |
| <div id="metadata-info-block"> |
| <div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/collection/ArrayMap.java+class:androidx.collection.ArrayMap&ss=androidx/platform/frameworks/support" class="external">View Source</a></div> |
| </div> |
| </div> |
| <div id="refdoc-switcher-placeholder"></div> |
| <p> |
| <pre>public class <a href="/reference/androidx/collection/ArrayMap.html">ArrayMap</a><K, V> extends <a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a> implements <a href="https://developer.android.com/reference/java/util/Map.html">Map</a></pre> |
| </p> |
| <div class="devsite-table-wrapper"> |
| <table class="jd-inheritance-table"> |
| <tbody> |
| <tr> |
| <td colspan="3"><a href="https://developer.android.com/reference/java/lang/Object.html">java.lang.Object</a></td> |
| </tr> |
| <tr> |
| <td class="jd-inheritance-space"> ↳</td> |
| <td colspan="2"><a href="/reference/androidx/collection/SimpleArrayMap.html">androidx.collection.SimpleArrayMap</a></td> |
| </tr> |
| <tr> |
| <td> </td> |
| <td class="jd-inheritance-space"> ↳</td> |
| <td colspan="1"><a href="/reference/androidx/collection/ArrayMap.html">androidx.collection.ArrayMap</a></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <hr> |
| <p>ArrayMap is a generic key->value mapping data structure that is designed to be more memory efficient than a traditional <code><a href="https://developer.android.com/reference/java/util/HashMap.html">java.util.HashMap</a></code>, this implementation is a version of the platform's <code>android.util.ArrayMap</code> that can be used on older versions of the platform. It keeps its mappings in an array data structure -- an integer array of hash codes for each item, and an Object array of the key/value pairs. This allows it to avoid having to create an extra object for every entry put in to the map, and it also tries to control the growth of the size of these arrays more aggressively (since growing them only requires copying the entries in the array, not rebuilding a hash map). </p> |
| <p>If you don't need the standard Java container APIs provided here (iterators etc), consider using <code><a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a></code> instead.</p> |
| <p>Note that this implementation is not intended to be appropriate for data structures that may contain large numbers of items. It is generally slower than a traditional HashMap, since lookups require a binary search and adds and removes require inserting and deleting entries in the array. For containers holding up to hundreds of items, the performance difference is not significant, less than 50%.</p> |
| <p>Because this container is intended to better balance memory use, unlike most other standard Java containers it will shrink its array as items are removed from it. Currently you have no control over this shrinking -- if you set a capacity and then remove an item, it may reduce the capacity to better match the current size. In the future an explicit call to set the capacity should turn off this aggressive shrinking behavior.</p> |
| <h2>Summary</h2> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Public constructors</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#ArrayMap()">ArrayMap</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#ArrayMap(int)">ArrayMap</a>(int capacity)</code></div> |
| <p>Create a new ArrayMap with a given initial capacity.</p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#ArrayMap(androidx.collection.SimpleArrayMap)">ArrayMap</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a> map)</code></div> |
| <p>Create a new ArrayMap with the mappings from the given ArrayMap.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Public methods</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#containsAll(java.util.Collection<?>)">containsAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</code></div> |
| <p>Determine if the array map contains all of the keys in the given collection.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#containsKey(java.lang.Object)">containsKey</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</code></div> |
| <p>Check whether a key exists in the array.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#containsValue(java.lang.Object)">containsValue</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> value)</code></div> |
| <p>Check whether a value exists in the array.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Set.html">Set</a><<a href="https://developer.android.com/reference/java/util/Map.Entry.html">Map.Entry</a><K, V>></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#entrySet()">entrySet</a>()</code></div> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Set.html">java.util.Set</a></code> for iterating over and interacting with all mappings in the array map.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#get(java.lang.Object)">get</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</code></div> |
| <p>Retrieve a value from the array.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Set.html">Set</a><K></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#keySet()">keySet</a>()</code></div> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Set.html">java.util.Set</a></code> for iterating over and interacting with all keys in the array map.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#putAll(java.util.Map<? extends K,? extends V>)">putAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V> map)</code></div> |
| <p>Perform a put of all key/value pairs in <var>map</var></p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#remove(java.lang.Object)">remove</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</code></div> |
| <p>Remove an existing key from the array map.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#removeAll(java.util.Collection<?>)">removeAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</code></div> |
| <p>Remove all keys in the array map that exist in the given collection.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#retainAll(java.util.Collection<?>)">retainAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</code></div> |
| <p>Remove all keys in the array map that do <b>not</b> exist in the given collection.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><V></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/ArrayMap.html#values()">values</a>()</code></div> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Collection.html">java.util.Collection</a></code> for iterating over and interacting with all values in the array map.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive" id="inhmethods"> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Inherited methods</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><devsite-expandable><span class="expand-control">From <a href="https://developer.android.com/reference/java/util/Map.html">java.util.Map</a></span> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <tbody class="list"> |
| <tr> |
| <td><code>abstract void</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#clear()">clear</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#compute(K, java.util.function.BiFunction&lt;? super K,? super V,? extends V&gt;)">compute</a>(K key, <a href="https://developer.android.com/reference/java/util/function/BiFunction.html">BiFunction</a><K, V, V> remappingFunction)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#computeIfAbsent(K, java.util.function.Function&lt;? super K,? extends V&gt;)">computeIfAbsent</a>(K key, <a href="https://developer.android.com/reference/java/util/function/Function.html">Function</a><K, V> mappingFunction)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#computeIfPresent(K, java.util.function.BiFunction&lt;? super K,? super V,? extends V&gt;)">computeIfPresent</a>(K key, <a href="https://developer.android.com/reference/java/util/function/BiFunction.html">BiFunction</a><K, V, V> remappingFunction)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>static <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V></code></td> |
| <td> |
| <div><code><K, V> <a href="https://developer.android.com/reference/java/util/Map.html#copyOf(java.util.Map&lt;? extends K,? extends V&gt;)">copyOf</a>(<a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V> map)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>static <a href="https://developer.android.com/reference/java/util/Map.Entry.html">Map.Entry</a><K, V></code></td> |
| <td> |
| <div><code><K, V> <a href="https://developer.android.com/reference/java/util/Map.html#entry(K, V)">entry</a>(K k, V v)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>abstract boolean</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> p)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#forEach(java.util.function.BiConsumer&lt;? super K,? super V&gt;)">forEach</a>(<a href="https://developer.android.com/reference/java/util/function/BiConsumer.html">BiConsumer</a><K, V> action)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#getOrDefault(java.lang.Object, V)">getOrDefault</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key, V defaultValue)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>abstract int</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#hashCode()">hashCode</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>abstract boolean</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#isEmpty()">isEmpty</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#merge(K, V, java.util.function.BiFunction&lt;? super V,? super V,? extends V&gt;)">merge</a>(K key, V value, <a href="https://developer.android.com/reference/java/util/function/BiFunction.html">BiFunction</a><V, V, V> remappingFunction)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>static <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V></code></td> |
| <td> |
| <div><code><K, V> <a href="https://developer.android.com/reference/java/util/Map.html#of()">of</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>static <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V></code></td> |
| <td> |
| <div><code><K, V> <a href="https://developer.android.com/reference/java/util/Map.html#ofEntries(java.util.Map.Entry&lt;? extends K,? extends V&gt;...)">ofEntries</a>(Map.Entry[] entries)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>abstract V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#put(K, V)">put</a>(K p, V p1)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#putIfAbsent(K, V)">putIfAbsent</a>(K key, V value)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#remove(java.lang.Object, java.lang.Object)">remove</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key, <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> value)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#replace(K, V)">replace</a>(K key, V value)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#replace(K, V, V)">replace</a>(K key, V oldValue, V newValue)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#replaceAll(java.util.function.BiFunction&lt;? super K,? super V,? extends V&gt;)">replaceAll</a>(<a href="https://developer.android.com/reference/java/util/function/BiFunction.html">BiFunction</a><K, V, V> function)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>abstract int</code></td> |
| <td> |
| <div><code><a href="https://developer.android.com/reference/java/util/Map.html#size()">size</a>()</code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </devsite-expandable> </td> |
| </tr> |
| <tr> |
| <td><devsite-expandable><span class="expand-control">From <a href="/reference/androidx/collection/SimpleArrayMap.html">androidx.collection.SimpleArrayMap</a></span> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <tbody class="list"> |
| <tr> |
| <td><code>final int</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#__restricted$indexOfValue(V)">__restricted$indexOfValue</a>(V value)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#clear()">clear</a>()</code></div> |
| <p>Make the array map empty.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#ensureCapacity(int)">ensureCapacity</a>(int minimumCapacity)</code></div> |
| <p>Ensure the array map can hold at least <code><a href="/reference/androidx/collection/SimpleArrayMap.html#ensureCapacity(kotlin.Int)">minimumCapacity</a></code> items.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> other)</code></div> |
| <p>This implementation returns <code>false</code> if the object is not a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a></code> or <code><a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a></code>, or if the maps have different sizes.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#getOrDefault(java.lang.Object,V)">getOrDefault</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key, V defaultValue)</code></div> |
| <p>Retrieve a value from the array, or <code><a href="/reference/androidx/collection/SimpleArrayMap.html#getOrDefault(kotlin.Any,kotlin.Any)">defaultValue</a></code> if there is no mapping for the key.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>int</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#hashCode()">hashCode</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>int</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#indexOfKey(K)">indexOfKey</a>(K key)</code></div> |
| <p>Returns the index of a key in the set.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#isEmpty()">isEmpty</a>()</code></div> |
| <p>Return <code>true</code> if the array map contains no items.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>K</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#keyAt(int)">keyAt</a>(int index)</code></div> |
| <p>Return the key at the given index in the array.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#put(K,V)">put</a>(K key, V value)</code></div> |
| <p>Add a new value to the array map.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#putAll(androidx.collection.SimpleArrayMap<? extends K,? extends V>)">putAll</a>(<a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a><K, V> map)</code></div> |
| <p>Perform a <code><a href="/reference/androidx/collection/SimpleArrayMap.html#put(kotlin.Any,kotlin.Any)">put</a></code> of all key/value pairs in <code><a href="/reference/androidx/collection/SimpleArrayMap.html#putAll(androidx.collection.SimpleArrayMap)">map</a></code></p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#putIfAbsent(K,V)">putIfAbsent</a>(K key, V value)</code></div> |
| <p>Add a new value to the array map only if the key does not already have a value or it is mapped to <code>null</code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#remove(K,V)">remove</a>(K key, V value)</code></div> |
| <p>Remove an existing key from the array map only if it is currently mapped to <code><a href="/reference/androidx/collection/SimpleArrayMap.html#remove(kotlin.Any,kotlin.Any)">value</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#removeAt(int)">removeAt</a>(int index)</code></div> |
| <p>Remove the key/value mapping at the given index.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#replace(K,V)">replace</a>(K key, V value)</code></div> |
| <p>Replace the mapping for <code><a href="/reference/androidx/collection/SimpleArrayMap.html#replace(kotlin.Any,kotlin.Any)">key</a></code> only if it is already mapped to a value.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#replace(K,V,V)">replace</a>(K key, V oldValue, V newValue)</code></div> |
| <p>Replace the mapping for <code><a href="/reference/androidx/collection/SimpleArrayMap.html#replace(kotlin.Any,kotlin.Any,kotlin.Any)">key</a></code> only if it is already mapped to <code><a href="/reference/androidx/collection/SimpleArrayMap.html#replace(kotlin.Any,kotlin.Any,kotlin.Any)">oldValue</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#setValueAt(int,V)">setValueAt</a>(int index, V value)</code></div> |
| <p>Set the value at a given index in the array.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>int</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#size()">size</a>()</code></div> |
| <p>Return the number of items in this array map.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code><a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#toString()">toString</a>()</code></div> |
| <p>Returns a string representation of the object.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/collection/SimpleArrayMap.html#valueAt(int)">valueAt</a>(int index)</code></div> |
| <p>Return the value at the given index in the array.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </devsite-expandable> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="list"> |
| <h2>Public constructors</h2> |
| <div class="api-item"><a name="ArrayMap--"></a><a name="arraymap"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="ArrayMap()">ArrayMap</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public <a href="/reference/androidx/collection/ArrayMap.html#ArrayMap()">ArrayMap</a>()</pre> |
| </div> |
| <div class="api-item"><a name="ArrayMap-int-"></a><a name="arraymap"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="ArrayMap(int)">ArrayMap</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public <a href="/reference/androidx/collection/ArrayMap.html#ArrayMap(int)">ArrayMap</a>(int capacity)</pre> |
| <p>Create a new ArrayMap with a given initial capacity.</p> |
| </div> |
| <div class="api-item"><a name="ArrayMap-androidx.collection.SimpleArrayMap-"></a><a name="arraymap"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="ArrayMap(androidx.collection.SimpleArrayMap)">ArrayMap</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public <a href="/reference/androidx/collection/ArrayMap.html#ArrayMap(androidx.collection.SimpleArrayMap)">ArrayMap</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/collection/SimpleArrayMap.html">SimpleArrayMap</a> map)</pre> |
| <p>Create a new ArrayMap with the mappings from the given ArrayMap.</p> |
| </div> |
| </div> |
| <div class="list"> |
| <h2>Public methods</h2> |
| <div class="api-item"><a name="containsAll-java.util.Collection<?>-"></a><a name="containsall"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="containsAll(java.util.Collection<?>)">containsAll</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/collection/ArrayMap.html#containsAll(java.util.Collection<?>)">containsAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</pre> |
| <p>Determine if the array map contains all of the keys in the given collection.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection</code></td> |
| <td> |
| <p>The collection whose contents are to be checked against.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <p>Returns true if this array map contains a key for every entry in <var>collection</var>, else returns false.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="containsKey-java.lang.Object-"></a><a name="containskey"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="containsKey(java.lang.Object)">containsKey</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/collection/ArrayMap.html#containsKey(java.lang.Object)">containsKey</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</pre> |
| <p>Check whether a key exists in the array.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key</code></td> |
| <td> |
| <p>The key to search for. ** This must be the same type as <var>K</var> **</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <p>Returns <code>true</code> if the key exists, else <code>false</code>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="containsValue-java.lang.Object-"></a><a name="containsvalue"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="containsValue(java.lang.Object)">containsValue</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/collection/ArrayMap.html#containsValue(java.lang.Object)">containsValue</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> value)</pre> |
| <p>Check whether a value exists in the array. This requires a linear search through the entire array.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> value</code></td> |
| <td> |
| <p>The value to search for. ** This must be the same type as <var>V</var> **</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <p>Returns <code>true</code> if the value exists, else <code>false</code>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="entrySet--"></a><a name="entryset"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="entrySet()">entrySet</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Set.html">Set</a><<a href="https://developer.android.com/reference/java/util/Map.Entry.html">Map.Entry</a><K, V>> <a href="/reference/androidx/collection/ArrayMap.html#entrySet()">entrySet</a>()</pre> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Set.html">java.util.Set</a></code> for iterating over and interacting with all mappings in the array map. </p> |
| <p><b>Note:</b> this is a very inefficient way to access the array contents, it requires generating a number of temporary objects.</p> |
| <p><b>Note:</b></p> |
| the semantics of this Set are subtly different than that of a <code><a href="https://developer.android.com/reference/java/util/HashMap.html">java.util.HashMap</a></code>: most important, the <code><a href="https://developer.android.com/reference/java/util/Map.Entry.html">Map.Entry</a></code> object returned by its iterator is a single object that exists for the entire iterator, so you can <b>not</b> hold on to it after calling <code><a href="https://developer.android.com/reference/java/util/Iterator.html#next()">Iterator.next</a></code>.</div> |
| <div class="api-item"><a name="get-java.lang.Object-"></a><a name="get"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="get(java.lang.Object)">get</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public V <a href="/reference/androidx/collection/ArrayMap.html#get(java.lang.Object)">get</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</pre> |
| <p>Retrieve a value from the array.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key</code></td> |
| <td> |
| <p>The key of the value to retrieve. ** This must be the same type as <var>K</var> **</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <p>Returns the value associated with the given key, or <code>null</code> if there is no such key.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="keySet--"></a><a name="keyset"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="keySet()">keySet</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Set.html">Set</a><K> <a href="/reference/androidx/collection/ArrayMap.html#keySet()">keySet</a>()</pre> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Set.html">java.util.Set</a></code> for iterating over and interacting with all keys in the array map. </p> |
| <p><b>Note:</b> this is a fairly inefficient way to access the array contents, it requires generating a number of temporary objects.</p> |
| </div> |
| <div class="api-item"><a name="putAll-java.util.Map<? extends K,? extends V>-"></a><a name="putall"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="putAll(java.util.Map<? extends K,? extends V>)">putAll</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/collection/ArrayMap.html#putAll(java.util.Map<? extends K,? extends V>)">putAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V> map)</pre> |
| <p>Perform a put of all key/value pairs in <var>map</var></p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Map.html">Map</a><K, V> map</code></td> |
| <td> |
| <p>The map whose contents are to be retrieved.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="remove-java.lang.Object-"></a><a name="remove"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="remove(java.lang.Object)">remove</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public V <a href="/reference/androidx/collection/ArrayMap.html#remove(java.lang.Object)">remove</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key)</pre> |
| <p>Remove an existing key from the array map.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> key</code></td> |
| <td> |
| <p>The key of the mapping to remove. ** This must be the same type as <var>V</var> **</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>V</code></td> |
| <td> |
| <p>Returns the value that was stored under the key, or <code>null</code> if there was no such key.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="removeAll-java.util.Collection<?>-"></a><a name="removeall"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="removeAll(java.util.Collection<?>)">removeAll</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/collection/ArrayMap.html#removeAll(java.util.Collection<?>)">removeAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</pre> |
| <p>Remove all keys in the array map that exist in the given collection.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection</code></td> |
| <td> |
| <p>The collection whose contents are to be used to remove keys.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <p>Returns true if any keys were removed from the array map, else false.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="retainAll-java.util.Collection<?>-"></a><a name="retainall"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="retainAll(java.util.Collection<?>)">retainAll</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/collection/ArrayMap.html#retainAll(java.util.Collection<?>)">retainAll</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection)</pre> |
| <p>Remove all keys in the array map that do <b>not</b> exist in the given collection.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>> collection</code></td> |
| <td> |
| <p>The collection whose contents are to be used to determine which keys to keep.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Returns</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code>boolean</code></td> |
| <td> |
| <p>Returns true if any keys were removed from the array map, else false.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="api-item"><a name="values--"></a><a name="values"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="values()">values</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a><V> <a href="/reference/androidx/collection/ArrayMap.html#values()">values</a>()</pre> |
| <p>Return a <code><a href="https://developer.android.com/reference/java/util/Collection.html">java.util.Collection</a></code> for iterating over and interacting with all values in the array map. </p> |
| <p><b>Note:</b> this is a fairly inefficient way to access the array contents, it requires generating a number of temporary objects.</p> |
| </div> |
| </div> |
| </body> |
| </html> |
