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.

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.

public void clear()

Removes all key-value mappings from this SparseArray.

public boolean containsKey(int key)

Returns true if the specified key is mapped.

public boolean containsValue(@NonNull E value)

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

public E get(int key)

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

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

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

public final boolean getIsEmpty()

Return true if size is 0.

public 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.

public int indexOfValue(@NonNull 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.

public boolean isEmpty()

Return true if size is 0.

public 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.

public void put(int 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.

public void putAll(@NonNull SparseArrayCompat<@NonNull 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.

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.

public void remove(int key)

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

public boolean remove(int key, Object value)

Remove an existing key from the array map only if it is currently mapped to value.

public void removeAt(int index)

Removes the mapping at the specified index.

public void removeAtRange(int index, int size)

Remove a range of mappings as a batch.

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

Replace the mapping for key only if it is already mapped to a value.

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

Replace the mapping for key only if it is already mapped to a value.

public void setValueAt(int index, @NonNull 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.

public int size()

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

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.

public @NonNull 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.

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

Returns true if the collection contains key.

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

Performs the given action for each key/value entry.

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

Return the value corresponding to key, or defaultValue when not present.

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 key, or from defaultValue when not present.

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

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

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

Return true when the collection contains elements.

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

Return an iterator over the collection's keys.

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 other.

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.

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

Return an iterator over the collection's values.