Skip to content

Most visited

Recently visited

navigation
added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:27.0.0

SparseArrayCompat

public class SparseArrayCompat
extends Object implements Cloneable

java.lang.Object
   ↳ android.support.v4.util.SparseArrayCompat<E>


A copy of the current platform (currently KITKAT version of SparseArray; provides a removeAt() method and other things.

Summary

Public constructors

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.

Public methods

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.

void clear()

Removes all key-value mappings from this SparseArray.

SparseArrayCompat<E> clone()
void delete(int key)

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

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.

int indexOfKey(int key)

Returns the index for which keyAt(int) 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(int) would return the specified key, or a negative number if no keys map to the specified value.

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.

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 remove(int key)

Alias for delete(int).

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.

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.

int size()

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

String toString()

This implementation composes a string by iterating over its mappings.

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.

Inherited methods

From class java.lang.Object

Public constructors

SparseArrayCompat

added in version 22.1.0
SparseArrayCompat ()

Creates a new SparseArray containing no mappings.

SparseArrayCompat

added in version 22.1.0
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
initialCapacity int

Public methods

append

added in version 22.1.0
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.

Parameters
key int

value E

clear

added in version 22.1.0
void clear ()

Removes all key-value mappings from this SparseArray.

clone

added in version 22.1.0
SparseArrayCompat<E> clone ()

Returns
SparseArrayCompat<E>

delete

added in version 22.1.0
void delete (int key)

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

Parameters
key int

get

added in version 22.1.0
E get (int key)

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

Parameters
key int

Returns
E

get

added in version 22.1.0
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.

Parameters
key int

valueIfKeyNotFound E

Returns
E

indexOfKey

added in version 22.1.0
int indexOfKey (int key)

Returns the index for which keyAt(int) would return the specified key, or a negative number if the specified key is not mapped.

Parameters
key int

Returns
int

indexOfValue

added in version 22.1.0
int indexOfValue (E value)

Returns an index for which valueAt(int) 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.

Parameters
value E

Returns
int

keyAt

added in version 22.1.0
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.

Parameters
index int

Returns
int

put

added in version 22.1.0
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.

Parameters
key int

value E

remove

added in version 22.1.0
void remove (int key)

Alias for delete(int).

Parameters
key int

removeAt

added in version 22.1.0
void removeAt (int index)

Removes the mapping at the specified index.

Parameters
index int

removeAtRange

added in version 22.1.0
void removeAtRange (int index, 
                int size)

Remove a range of mappings as a batch.

Parameters
index int: Index to begin at

size int: Number of mappings to remove

setValueAt

added in version 22.1.0
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.

Parameters
index int

value E

size

added in version 22.1.0
int size ()

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

Returns
int

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.

Returns
String

valueAt

added in version 22.1.0
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.

Parameters
index int

Returns
E

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)