# LongSparseArray

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

*** ** * ** ***


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

<br />

*** ** * ** ***

SparseArray mapping longs 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 Longs 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/LongSparseArray#keyAt(kotlin.Int)` and `https://developer.android.com/reference/androidx/collection/LongSparseArray#valueAt(kotlin.Int)`. Iterating over the keys using `https://developer.android.com/reference/androidx/collection/LongSparseArray#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/LongSparseArray#valueAt(kotlin.Int)`.

## Summary

| ### Public constructors |
|---|
| `<E extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/LongSparseArray#LongSparseArray(kotlin.Int)(int initialCapacity)` Creates a new `https://developer.android.com/reference/androidx/collection/LongSparseArray` 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/LongSparseArray#append(kotlin.Long,kotlin.Any)(long 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/LongSparseArray#clear()()` Removes all key-value mappings from this `https://developer.android.com/reference/androidx/collection/LongSparseArray`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull E>` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#clone()()` |
| `boolean` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsKey(kotlin.Long)(long key)` Returns `true` if the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsKey(kotlin.Long)` is mapped. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsValue(kotlin.Any)(@https://developer.android.com/reference/androidx/annotation/NonNull E value)` Returns `true` if the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsValue(kotlin.Any)` is mapped from any key. |
| `void` | `[delete](https://developer.android.com/reference/androidx/collection/LongSparseArray#delete(kotlin.Long))(long key)` **This method is deprecated.** Alias for \`remove(key)\`. |
| `E` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#get(kotlin.Long)(long key)` Gets the value mapped from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#get(kotlin.Long)`, 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/LongSparseArray#get(kotlin.Long,kotlin.Any)(long key, @https://developer.android.com/reference/androidx/annotation/NonNull E defaultValue)` Gets the value mapped from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#get(kotlin.Long,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/LongSparseArray#get(kotlin.Long,kotlin.Any)` if no such mapping has been made. |
| `int` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#indexOfKey(kotlin.Long)(long key)` Returns the index for which `https://developer.android.com/reference/androidx/collection/LongSparseArray#keyAt(kotlin.Int)` would return the specified key, or a negative number if the specified key is not mapped. |
| `int` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#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/LongSparseArray#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/LongSparseArray#indexOfValue(kotlin.Any)`. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#isEmpty()()` Return `true` if `https://developer.android.com/reference/androidx/collection/LongSparseArray#size()` is 0. |
| `long` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#keyAt(kotlin.Int)(int index)` Given an index in the range `0...size()-1`, returns the key from the `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores. |
| `void` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#put(kotlin.Long,kotlin.Any)(long key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one. |
| `void` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#putAll(androidx.collection.LongSparseArray)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull E> other)` Copies all of the mappings from `https://developer.android.com/reference/androidx/collection/LongSparseArray#putAll(androidx.collection.LongSparseArray)` to this map. |
| `E` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#putIfAbsent(kotlin.Long,kotlin.Any)(long 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/LongSparseArray#remove(kotlin.Long)(long key)` Removes the mapping from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#remove(kotlin.Long)`, if there was any. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#remove(kotlin.Long,kotlin.Any)(long key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Remove an existing key from the array map only if it is currently mapped to `https://developer.android.com/reference/androidx/collection/LongSparseArray#remove(kotlin.Long,kotlin.Any)`. |
| `void` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#removeAt(kotlin.Int)(int index)` Removes the mapping at the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#removeAt(kotlin.Int)`. |
| `E` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#replace(kotlin.Long,kotlin.Any)(long key, @https://developer.android.com/reference/androidx/annotation/NonNull E value)` Replace the mapping for `https://developer.android.com/reference/androidx/collection/LongSparseArray#replace(kotlin.Long,kotlin.Any)` only if it is already mapped to a value. |
| `boolean` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#replace(kotlin.Long,kotlin.Any,kotlin.Any)(long 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/LongSparseArray#replace(kotlin.Long,kotlin.Any,kotlin.Any)` only if it is already mapped to a value. |
| `void` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#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 `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores. |
| `int` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#size()()` Returns the number of key-value mappings that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` 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/LongSparseArray#toString()()` Returns a string representation of the object. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E` | `https://developer.android.com/reference/androidx/collection/LongSparseArray#valueAt(kotlin.Int)(int index)` Given an index in the range `0...size()-1`, returns the value from the `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores. |

| ### Extension functions |
|---|---|
| `final boolean` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).contains(kotlin.Long)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, long key )` Returns true if the collection contains `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.LongSparseArray).contains(kotlin.Long)`. |
| `final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).forEach(kotlin.Function2)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@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/Long.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.LongSparseArray).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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).getOrDefault(kotlin.Long,kotlin.Any)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, long 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.LongSparseArray).getOrDefault(kotlin.Long,kotlin.Any)`, or `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.LongSparseArray).getOrDefault(kotlin.Long,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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).getOrElse(kotlin.Long,kotlin.Function0)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, long 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.LongSparseArray).getOrElse(kotlin.Long,kotlin.Function0)`, or from `https://developer.android.com/reference/androidx/collection/package-summary#(androidx.collection.LongSparseArray).getOrElse(kotlin.Long,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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).getSize()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).isNotEmpty()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@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/-long-iterator/index.html` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).keyIterator()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@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/LongSparseArray<@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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).plus(androidx.collection.LongSparseArray)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@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/LongSparseArray<@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.LongSparseArray).plus(androidx.collection.LongSparseArray)`. |
| `final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/collection/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).set(kotlin.Long,kotlin.Any)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver, long 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/LongSparseArrayKt.https://developer.android.com/reference/androidx/collection/LongSparseArray#(androidx.collection.LongSparseArray).valueIterator()( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/collection/LongSparseArray<@https://developer.android.com/reference/androidx/annotation/NonNull T> receiver )` Return an iterator over the collection's values. |

## Public constructors

### LongSparseArray

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

Creates a new `https://developer.android.com/reference/androidx/collection/LongSparseArray` 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.

## Public methods

### append

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

```
public void append(long 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 `https://developer.android.com/reference/androidx/collection/LongSparseArray`.

### clone

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

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

### containsKey

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

```
public boolean containsKey(long key)
```

Returns `true` if the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsKey(kotlin.Long)` 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 `https://developer.android.com/reference/androidx/collection/LongSparseArray#containsValue(kotlin.Any)` 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/LongSparseArray#delete(kotlin.Long))(long key)
```

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

Removes the mapping from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#delete(kotlin.Long)`, if there was any.

### get

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

```
public E get(long key)
```

Gets the value mapped from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#get(kotlin.Long)`, 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(long key, @NonNull E defaultValue)
```

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

### indexOfKey

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

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

Returns the index for which `https://developer.android.com/reference/androidx/collection/LongSparseArray#keyAt(kotlin.Int)` would return the specified key, or a negative number if the specified key 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/LongSparseArray#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/LongSparseArray#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.

### 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/LongSparseArray#size()` is 0.

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

### keyAt

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

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

Given an index in the range `0...size()-1`, returns the key from the `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores.

The keys corresponding to indices in ascending order are guaranteed to be in ascending order, e.g., `keyAt(0)` will return the smallest key and `keyAt(size()-1)` will return the largest key.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if `https://developer.android.com/reference/androidx/collection/LongSparseArray#keyAt(kotlin.Int)` is not in the range `0...size()-1` |

### put

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

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

Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key 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 LongSparseArray<@NonNull E> other)
```

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

### putIfAbsent

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

```
public E putIfAbsent(long 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 |
|---|---|
| `long 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(long key)
```

Removes the mapping from the specified `https://developer.android.com/reference/androidx/collection/LongSparseArray#remove(kotlin.Long)`, if there was any.

### remove

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

```
public boolean remove(long key, @NonNull E value)
```

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

| Parameters |
|---|---|
| `long key` | The key of the mapping to remove. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull E 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 `https://developer.android.com/reference/androidx/collection/LongSparseArray#removeAt(kotlin.Int)`.

### replace

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

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

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

| Parameters |
|---|---|
| `long 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(long key, @NonNull E oldValue, @NonNull E newValue)
```

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

| Parameters |
|---|---|
| `long 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 `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if `https://developer.android.com/reference/androidx/collection/LongSparseArray#setValueAt(kotlin.Int,kotlin.Any)` is not in the range `0...size()-1` |

### 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 `https://developer.android.com/reference/androidx/collection/LongSparseArray` 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 `index`th key-value mapping that this `https://developer.android.com/reference/androidx/collection/LongSparseArray` stores.

The values corresponding to indices in ascending order are guaranteed to be associated with keys in ascending order, e.g., `valueAt(0)` will return the value associated with the smallest key and `valueAt(size()-1)` will return the value associated with the largest key.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if `https://developer.android.com/reference/androidx/collection/LongSparseArray#valueAt(kotlin.Int)` is not in the range `0...size()-1` |

## Extension functions

### LongSparseArrayKt.contains

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

```
public final boolean <T extends Object> LongSparseArrayKt.contains(
    @NonNull LongSparseArray<@NonNull T> receiver,
    long key
)
```

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

### LongSparseArrayKt.forEach

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

```
public final void <T extends Object> LongSparseArrayKt.forEach(
    @NonNull LongSparseArray<@NonNull T> receiver,
    @NonNull Function2<@NonNull Long, @NonNull value, Unit> action
)
```

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

### LongSparseArrayKt.getOrDefault

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

```
public final @NonNull T <T extends Object> LongSparseArrayKt.getOrDefault(
    @NonNull LongSparseArray<@NonNull T> receiver,
    long key,
    @NonNull T defaultValue
)
```

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

### LongSparseArrayKt.getOrElse

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

```
public final @NonNull T <T extends Object> LongSparseArrayKt.getOrElse(
    @NonNull LongSparseArray<@NonNull T> receiver,
    long key,
    @NonNull Function0<@NonNull T> defaultValue
)
```

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

### LongSparseArrayKt.getSize

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

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

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

### LongSparseArrayKt.isNotEmpty

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

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

Return true when the collection contains elements.

### LongSparseArrayKt.keyIterator

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

```
public final @NonNull LongIterator <T extends Object> LongSparseArrayKt.keyIterator(
    @NonNull LongSparseArray<@NonNull T> receiver
)
```

Return an iterator over the collection's keys.

### LongSparseArrayKt.plus

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

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

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

### LongSparseArrayKt.set

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

```
public final void <T extends Object> LongSparseArrayKt.set(
    @NonNull LongSparseArray<@NonNull T> receiver,
    long key,
    @NonNull T value
)
```

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

### LongSparseArrayKt.valueIterator

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

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

Return an iterator over the collection's values.