# SparseArrayCompat

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArrayCompat.+class:androidx.collection.SparseArrayCompat) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

*** ** * ** ***


```
public class SparseArrayCompat<E extends Object>
```

<br />

*** ** * ** ***

SparseArrays map integers to Objects. Unlike a normal array of Objects, there can be gaps in the indices. It is intended to be more memory efficient than using a HashMap to map Integers to Objects, both because it avoids auto-boxing keys and its data structure doesn't rely on an extra entry object for each mapping.

Note that this container keeps its mappings in an array data structure, using a binary search to find keys. The 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%.

To help with performance, the container includes an optimization when removing keys: instead of compacting its array immediately, it leaves the removed entry marked as deleted. The entry can then be re-used for the same key, or compacted later in a single garbage collection step of all removed entries. This garbage collection will need to be performed at any time the array needs to be grown or the map size or entry values are retrieved.

It is possible to iterate over the items in this container using `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)` and `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)`. Iterating over the keys using `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)` with ascending values of the index will return the keys in ascending order, or the values corresponding to the keys in ascending order in the case of `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)`.

## Summary

| ### Public constructors |
|---|
| `<E extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayCompat#SparseArrayCompat(kotlin.Int)(int initialCapacity)` Creates a new SparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#append(kotlin.Int,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#clear()()` Removes all key-value mappings from this SparseArray. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull E>` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#clone()()` |
| `boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#containsKey(kotlin.Int)(int key)` Returns true if the specified key is mapped. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#containsValue(kotlin.Any)(@https://developer.android.com/reference/androidx/annotation/NonNull E value)` Returns true if the specified value is mapped from any key. |
| `void` | `[delete](https://developer.android.com/reference/androidx/collection/SparseArrayCompat#delete(kotlin.Int))(int key)` **This method is deprecated.** Alias for remove(int). |
| `E` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int)(int key)` Gets the Object mapped from the specified key, or `null` if no such mapping has been made. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E defaultValue)` Gets the Object mapped from the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int,kotlin.Any)` if no such mapping has been made. |
| `final boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#getIsEmpty()()` Return true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0. |
| `int` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)(int key)` Returns the index for which `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)` would return the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)`, or a negative number if the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)` is not mapped. |
| `int` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfValue(kotlin.Any)(@https://developer.android.com/reference/androidx/annotation/NonNull E value)` Returns an index for which `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)` would return the specified key, or a negative number if no keys map to the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfValue(kotlin.Any)`. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#isEmpty()()` Return true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0. |
| `int` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)(int index)` Given an index in the range `0...[size]-1`, returns the key from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)`th key-value mapping that this SparseArray stores. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Adds a mapping from the specified key to the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)`, replacing the previous mapping from the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)` if there was one. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#putAll(androidx.collection.SparseArrayCompat)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull E> other)` Copies all of the mappings from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#putAll(androidx.collection.SparseArrayCompat)` to this map. |
| `E` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#putIfAbsent(kotlin.Int,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Add a new value to the array map only if the key does not already have a value or it is mapped to `null`. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#remove(kotlin.Int)(int key)` Removes the mapping from the specified key, if there was any. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#remove(kotlin.Int,kotlin.Any)(int key, https://developer.android.com/reference/java/lang/Object.html value)` Remove an existing key from the array map only if it is currently mapped to `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#remove(kotlin.Int,kotlin.Any)`. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#removeAt(kotlin.Int)(int index)` Removes the mapping at the specified index. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#removeAtRange(kotlin.Int,kotlin.Int)(int index, int size)` Remove a range of mappings as a batch. |
| `E` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Replace the mapping for `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any)` only if it is already mapped to a value. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any,kotlin.Any)(int key, @https://developer.android.com/reference/androidx/annotation/NonNull E oldValue, @https://developer.android.com/reference/androidx/annotation/NonNull E newValue)` Replace the mapping for `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any,kotlin.Any)` only if it is already mapped to a value. |
| `void` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#setValueAt(kotlin.Int,kotlin.Any)(int index, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Given an index in the range `0...size()-1`, sets a new value for the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#setValueAt(kotlin.Int,kotlin.Any)`th key-value mapping that this SparseArray stores. |
| `int` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()()` Returns the number of key-value mappings that this SparseArray currently stores. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#toString()()` Returns a string representation of the object. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E` | `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)(int index)` Given an index in the range `0...[size]-1`, returns the value from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)`th key-value mapping that this SparseArray stores. |

| ### Extension functions |
|---|---|
| `final boolean` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).contains(kotlin.Int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, int key )` Returns true if the collection contains `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).contains(kotlin.Int)`. |
| `final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).forEach(kotlin.Function2)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, @https://developer.android.com/reference/androidx/annotation/NonNull Function2<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull value, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> action )` Performs the given `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).forEach(kotlin.Function2)` for each key/value entry. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).getOrDefault(kotlin.Int,kotlin.Any)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, int key, @https://developer.android.com/reference/androidx/annotation/NonNull T defaultValue )` Return the value corresponding to `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrDefault(kotlin.Int,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrDefault(kotlin.Int,kotlin.Any)` when not present. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull T` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).getOrElse(kotlin.Int,kotlin.Function0)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, int key, @https://developer.android.com/reference/androidx/annotation/NonNull Function0<@https://developer.android.com/reference/androidx/annotation/NonNull T> defaultValue )` Return the value corresponding to `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrElse(kotlin.Int,kotlin.Function0)`, or from `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrElse(kotlin.Int,kotlin.Function0)` when not present. |
| `final int` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).getSize()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver )` Returns the number of key/value pairs in the collection. |
| `final boolean` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).isNotEmpty()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver )` Return true when the collection contains elements. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-int-iterator/index.html` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).keyIterator()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver )` Return an iterator over the collection's keys. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).plus(androidx.collection.SparseArrayCompat)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> other )` Creates a new collection by adding or replacing entries from `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).plus(androidx.collection.SparseArrayCompat)`. |
| `final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).set(kotlin.Int,kotlin.Any)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, int key, @https://developer.android.com/reference/androidx/annotation/NonNull T value )` Allows the use of the index operator for storing values in the collection. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Iterator.html<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/SparseArrayKt.https://developer.android.com/reference/androidx/collection/SparseArrayCompat#(androidx.collection.SparseArrayCompat).valueIterator()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/SparseArrayCompat<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver )` Return an iterator over the collection's values. |

## Public constructors

### SparseArrayCompat

```
public <E extends Object> SparseArrayCompat(int initialCapacity)
```

Creates a new SparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings. If you supply an initial capacity of 0, the sparse array will be initialized with a light-weight representation not requiring any additional array allocations.

| Parameters |
|---|---|
| `int initialCapacity` | initial capacity of the array. The array will not require any additional memory allocation to store the specified number of mappings. If you supply an initialCapacity of 0, the sparse array will be initialized with a light-weight representation not requiring any additional array allocations. Default initialCapacity is 10. |

## Public methods

### append

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void append(int key, @NonNull E value)
```

Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array.

### clear

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void clear()
```

Removes all key-value mappings from this SparseArray.

### clone

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public @NonNull SparseArrayCompat<@NonNull E> clone()
```

### containsKey

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public boolean containsKey(int key)
```

Returns true if the specified key is mapped.

### containsValue

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public boolean containsValue(@NonNull E value)
```

Returns true if the specified value is mapped from any key.

### delete

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/collection#1.1.0)

```
public void [delete](https://developer.android.com/reference/androidx/collection/SparseArrayCompat#delete(kotlin.Int))(int key)
```

> [!CAUTION]
> **This method is deprecated.**   
> Alias for remove(int), use this instead:
>
> ```
> remove(key)
> ```

### get

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public E get(int key)
```

Gets the Object mapped from the specified key, or `null` if no such mapping has been made.

### get

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public @NonNull E get(int key, @NonNull E defaultValue)
```

Gets the Object mapped from the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#get(kotlin.Int,kotlin.Any)` if no such mapping has been made.

### getIsEmpty

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/collection#1.3.0)

```
public final boolean getIsEmpty()
```

Return true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0.

| Returns |
|---|---|
| `boolean` | true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0. |

### indexOfKey

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public int indexOfKey(int key)
```

Returns the index for which `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)` would return the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)`, or a negative number if the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)` is not mapped.

| Parameters |
|---|---|
| `int key` | the key to search for |

| Returns |
|---|---|
| `int` | the index for which `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)` would return the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)`, or a negative number if the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfKey(kotlin.Int)` is not mapped |

### indexOfValue

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public int indexOfValue(@NonNull E value)
```

Returns an index for which `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)` would return the specified key, or a negative number if no keys map to the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#indexOfValue(kotlin.Any)`.

Beware that this is a linear search, unlike lookups by key, and that multiple keys can map to the same value and this will find only one of them.

Note also that unlike most collections' `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.ArraySet).indexOf(kotlin.Any,kotlin.Int)` methods, this method compares values using `===` rather than `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/equals.html`.

### isEmpty

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public boolean isEmpty()
```

Return true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0.

| Returns |
|---|---|
| `boolean` | true if `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#size()` is 0. |

### keyAt

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public int keyAt(int index)
```

Given an index in the range `0...[size]-1`, returns the key from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#keyAt(kotlin.Int)`th key-value mapping that this SparseArray stores.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-index-out-of-bounds-exception/index.html` | if index is not within `0..[size]-1` |

### put

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void put(int key, @NonNull E value)
```

Adds a mapping from the specified key to the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)`, replacing the previous mapping from the specified `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)` if there was one.

### putAll

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void putAll(@NonNull SparseArrayCompat<@NonNull E> other)
```

Copies all of the mappings from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#putAll(androidx.collection.SparseArrayCompat)` to this map. The effect of this call is equivalent to that of calling `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#put(kotlin.Int,kotlin.Any)` on this map once for each mapping from key to value in `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#putAll(androidx.collection.SparseArrayCompat)`.

### putIfAbsent

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/collection#1.1.0)

```
public E putIfAbsent(int key, @NonNull E value)
```

Add a new value to the array map only if the key does not already have a value or it is mapped to `null`.

| Parameters |
|---|---|
| `int key` | The key under which to store the value. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E value` | The value to store for the given key. |

| Returns |
|---|---|
| `E` | Returns the value that was stored for the given key, or `null` if there was no such key. |

### remove

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void remove(int key)
```

Removes the mapping from the specified key, if there was any.

### remove

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/collection#1.1.0)

```
public boolean remove(int key, Object value)
```

Remove an existing key from the array map only if it is currently mapped to `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#remove(kotlin.Int,kotlin.Any)`.

| Parameters |
|---|---|
| `int key` | The key of the mapping to remove. |
| `https://developer.android.com/reference/java/lang/Object.html value` | The value expected to be mapped to the key. |

| Returns |
|---|---|
| `boolean` | Returns `true` if the mapping was removed. |

### removeAt

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void removeAt(int index)
```

Removes the mapping at the specified index.

### removeAtRange

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void removeAtRange(int index, int size)
```

Remove a range of mappings as a batch.

| Parameters |
|---|---|
| `int index` | Index to begin at |
| `int size` | Number of mappings to remove |

### replace

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/collection#1.1.0)

```
public E replace(int key, @NonNull E value)
```

Replace the mapping for `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any)` only if it is already mapped to a value.

| Parameters |
|---|---|
| `int key` | The key of the mapping to replace. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E value` | The value to store for the given key. |

| Returns |
|---|---|
| `E` | Returns the previous mapped value or `null`. |

### replace

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/collection#1.1.0)

```
public boolean replace(int key, @NonNull E oldValue, @NonNull E newValue)
```

Replace the mapping for `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#replace(kotlin.Int,kotlin.Any,kotlin.Any)` only if it is already mapped to a value.

| Parameters |
|---|---|
| `int key` | The key of the mapping to replace. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E oldValue` | The value expected to be mapped to the key. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E newValue` | The value to store for the given key. |

| Returns |
|---|---|
| `boolean` | Returns `true` if the value was replaced. |

### setValueAt

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public void setValueAt(int index, @NonNull E value)
```

Given an index in the range `0...size()-1`, sets a new value for the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#setValueAt(kotlin.Int,kotlin.Any)`th key-value mapping that this SparseArray stores.

### size

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public int size()
```

Returns the number of key-value mappings that this SparseArray currently stores.

### toString

```
public @NonNull String toString()
```

Returns a string representation of the object.

This implementation composes a string by iterating over its mappings. If this map contains itself as a value, the string "(this Map)" will appear in its place.

### valueAt

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/collection#1.0.0)

```
public @NonNull E valueAt(int index)
```

Given an index in the range `0...[size]-1`, returns the value from the `https://developer.android.com/reference/androidx/collection/SparseArrayCompat#valueAt(kotlin.Int)`th key-value mapping that this SparseArray stores.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-index-out-of-bounds-exception/index.html` | if index is not within `0..[size]-1` |

## Extension functions

### SparseArrayKt.contains

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:contains)

```
public final boolean <T extends Object> SparseArrayKt.contains(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    int key
)
```

Returns true if the collection contains `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).contains(kotlin.Int)`.

### SparseArrayKt.forEach

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:forEach)

```
public final void <T extends Object> SparseArrayKt.forEach(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    @NonNull Function2<@NonNull Integer, @NonNull value, Unit> action
)
```

Performs the given `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).forEach(kotlin.Function2)` for each key/value entry.

### SparseArrayKt.getOrDefault

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:getOrDefault)

```
public final @NonNull T <T extends Object> SparseArrayKt.getOrDefault(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    int key,
    @NonNull T defaultValue
)
```

Return the value corresponding to `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrDefault(kotlin.Int,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrDefault(kotlin.Int,kotlin.Any)` when not present.

### SparseArrayKt.getOrElse

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:getOrElse)

```
public final @NonNull T <T extends Object> SparseArrayKt.getOrElse(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    int key,
    @NonNull Function0<@NonNull T> defaultValue
)
```

Return the value corresponding to `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrElse(kotlin.Int,kotlin.Function0)`, or from `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).getOrElse(kotlin.Int,kotlin.Function0)` when not present.

### SparseArrayKt.getSize

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+symbol:size)

```
public final int <T extends Object> SparseArrayKt.getSize(
    @NonNull SparseArrayCompat<@NonNull T> receiver
)
```

Returns the number of key/value pairs in the collection.

### SparseArrayKt.isNotEmpty

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:isNotEmpty)

```
public final boolean <T extends Object> SparseArrayKt.isNotEmpty(
    @NonNull SparseArrayCompat<@NonNull T> receiver
)
```

Return true when the collection contains elements.

### SparseArrayKt.keyIterator

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:keyIterator)

```
public final @NonNull IntIterator <T extends Object> SparseArrayKt.keyIterator(
    @NonNull SparseArrayCompat<@NonNull T> receiver
)
```

Return an iterator over the collection's keys.

### SparseArrayKt.plus

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:plus)

```
public final @NonNull SparseArrayCompat<@NonNull T> <T extends Object> SparseArrayKt.plus(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    @NonNull SparseArrayCompat<@NonNull T> other
)
```

Creates a new collection by adding or replacing entries from `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.SparseArrayCompat).plus(androidx.collection.SparseArrayCompat)`.

### SparseArrayKt.set

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:set)

```
public final void <T extends Object> SparseArrayKt.set(
    @NonNull SparseArrayCompat<@NonNull T> receiver,
    int key,
    @NonNull T value
)
```

Allows the use of the index operator for storing values in the collection.

### SparseArrayKt.valueIterator

Artifact: [androidx.collection:collection](https://developer.android.com/jetpack/androidx/releases/collection) [View Source](https://cs.android.com/search?q=file:androidx/collection/SparseArray.kt+function:valueIterator)

```
public final @NonNull Iterator<@NonNull T> <T extends Object> SparseArrayKt.valueIterator(
    @NonNull SparseArrayCompat<@NonNull T> receiver
)
```

Return an iterator over the collection's values.