All Implemented Interfaces:

java.lang.Cloneable
```
public class SparseArrayCompat<E>
 implements Cloneable
                    
```
A copy of the latest implementation from AndroidX, Collections, 1.1. 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 the map size or entry values are retrieved.
It is possible to iterate over the items in this container using keyAt and valueAt. Iterating over the keys using keyAt(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 valueAt(int).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`SparseArrayCompat()`	Creates a new SparseArray containing no mappings.
`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.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`SparseArrayCompat<E>`	`clone()`
`E`	`get(int key)`	Gets the Object mapped from the specified key, or `null` if no such mapping has been made.
`E`	`get(int key, E valueIfKeyNotFound)`	Gets the Object mapped from the specified key, or the specified Object if no such mapping has been made.
`void`	`delete(int key)`
`void`	`remove(int key)`	Removes the mapping from the specified key, if there was any.
`boolean`	`remove(int key, Object value)`	Remove an existing key from the array map only if it is currently mapped to `value`.
`void`	`removeAt(int index)`	Removes the mapping at the specified index.
`void`	`removeAtRange(int index, int size)`	Remove a range of mappings as a batch.
`E`	`replace(int key, E value)`	Replace the mapping for `key` only if it is already mapped to a value.
`boolean`	`replace(int key, E oldValue, E newValue)`	Replace the mapping for `key` only if it is already mapped to a value.
`void`	`put(int key, 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`	`putAll(@NotNull() SparseArrayCompat<out E> other)`	Copies all of the mappings from the `other` to this map.
`E`	`putIfAbsent(int key, 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`.
`int`	`size()`	Returns the number of key-value mappings that this SparseArray currently stores.
`boolean`	`isEmpty()`	Return true if size() is 0.
`int`	`keyAt(int index)`	Given an index in the range `0...size()-1`, returns the key from the `index`th key-value mapping that this SparseArray stores.
`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 SparseArray stores.
`void`	`setValueAt(int index, E value)`	Given an index in the range `0...size()-1`, sets a new value for the `index`th key-value mapping that this SparseArray stores.
`int`	`indexOfKey(int key)`	Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.
`int`	`indexOfValue(E value)`	Returns an index for which valueAt would return the specified key, or a negative number if no keys map to the specified value.
`boolean`	`containsKey(int key)`	Returns true if the specified key is mapped.
`boolean`	`containsValue(E value)`	Returns true if the specified value is mapped from any key.
`void`	`clear()`	Removes all key-value mappings from this SparseArray.
`void`	`append(int key, 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.
`String`	`toString()`	This implementation composes a string by iterating over its mappings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SparseArrayCompat
```
SparseArrayCompat()
```
    Creates a new SparseArray containing no mappings.
  - SparseArrayCompat
```
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.
- Method Detail
  - clone
```
 SparseArrayCompat<E> clone()
```
  - get
```
@Nullable() E get(int key)
```
    Gets the Object mapped from the specified key, or null if no such mapping has been made.
  - get
```
 E get(int key, E valueIfKeyNotFound)
```
    Gets the Object mapped from the specified key, or the specified Object if no such mapping has been made.
  - delete
```
@Deprecated() void delete(int key)
```
  - remove
```
 void remove(int key)
```
    Removes the mapping from the specified key, if there was any.
  - remove
```
 boolean remove(int key, Object value)
```
    Remove an existing key from the array map only if it is currently mapped to value.
    
    Parameters:
    
    key - The key of the mapping to remove.
    
    value - The value expected to be mapped to the key.
  - removeAt
```
 void removeAt(int index)
```
    Removes the mapping at the specified index.
  - removeAtRange
```
 void removeAtRange(int index, int size)
```
    Remove a range of mappings as a batch.
    
    Parameters:
    
    index - Index to begin at
    
    size - Number of mappings to remove
  - replace
```
@Nullable() E replace(int key, E value)
```
    Replace the mapping for key only if it is already mapped to a value.
    
    Parameters:
    
    key - The key of the mapping to replace.
    
    value - The value to store for the given key.
  - replace
```
 boolean replace(int key, E oldValue, E newValue)
```
    Replace the mapping for key only if it is already mapped to a value.
    
    Parameters:
    
    key - The key of the mapping to replace.
    
    oldValue - The value expected to be mapped to the key.
    
    newValue - The value to store for the given key.
  - put
```
 void put(int key, 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
```
 void putAll(@NotNull() SparseArrayCompat<out E> other)
```
    Copies all of the mappings from the other to this map. The effect of this call is equivalent to that of calling put on this map once for each mapping from key to value in other.
  - putIfAbsent
```
@Nullable() E putIfAbsent(int key, 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:
    
    key - The key under which to store the value.
    
    value - The value to store for the given key.
  - size
```
 int size()
```
    Returns the number of key-value mappings that this SparseArray currently stores.
  - isEmpty
```
 boolean isEmpty()
```
    Return true if size() is 0.
  - keyAt
```
 int keyAt(int index)
```
    Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this SparseArray stores.
  - valueAt
```
 E valueAt(int index)
```
    Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this SparseArray stores.
  - setValueAt
```
 void setValueAt(int index, E value)
```
    Given an index in the range 0...size()-1, sets a new value for the indexth key-value mapping that this SparseArray stores.
  - indexOfKey
```
 int indexOfKey(int key)
```
    Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.
  - indexOfValue
```
 int indexOfValue(E value)
```
    Returns an index for which valueAt would return the specified key, or a negative number if no keys map to the specified value.
    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' indexOf methods, this method compares values using == rather than equals.
  - containsKey
```
 boolean containsKey(int key)
```
    Returns true if the specified key is mapped.
  - containsValue
```
 boolean containsValue(E value)
```
    Returns true if the specified value is mapped from any key.
  - clear
```
 void clear()
```
    Removes all key-value mappings from this SparseArray.
  - append
```
 void append(int key, 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.
  - toString
```
 String toString()
```
    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.

Class SparseArrayCompat

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SparseArrayCompat

SparseArrayCompat

Method Detail

clone

get

get

delete

remove

remove

removeAt

removeAtRange

replace

replace

put

putAll

putIfAbsent

size

isEmpty

keyAt

valueAt

setValueAt

indexOfKey

indexOfValue

containsKey

containsValue

clear

append

toString