to top
Android APIs
public class

LongSparseArray

extends Object
implements Cloneable
java.lang.Object
   ↳ android.util.LongSparseArray<E>

Class Overview

SparseArray mapping longs to Objects. Unlike a normal array of Objects, there can be gaps in the indices. It is intended to be more efficient than using a HashMap to map Longs to Objects.

Summary

Public Constructors
LongSparseArray()
Creates a new LongSparseArray containing no mappings.
LongSparseArray(int initialCapacity)
Creates a new LongSparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings.
Public Methods
void append(long 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 LongSparseArray.
LongSparseArray<E> clone()
Creates and returns a copy of this Object.
void delete(long key)
Removes the mapping from the specified key, if there was any.
E get(long key, E valueIfKeyNotFound)
Gets the Object mapped from the specified key, or the specified Object if no such mapping has been made.
E get(long key)
Gets the Object mapped from the specified key, or null if no such mapping has been made.
int indexOfKey(long 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.
long keyAt(int index)
Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this LongSparseArray stores.
void put(long 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(long key)
Alias for delete(long).
void removeAt(int index)
Removes the mapping at the specified index.
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 LongSparseArray stores.
int size()
Returns the number of key-value mappings that this LongSparseArray currently stores.
E valueAt(int index)
Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this LongSparseArray stores.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LongSparseArray ()

Added in API level 16

Creates a new LongSparseArray containing no mappings.

public LongSparseArray (int initialCapacity)

Added in API level 16

Creates a new LongSparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings.

Public Methods

public void append (long key, E value)

Added in API level 16

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 ()

Added in API level 16

Removes all key-value mappings from this LongSparseArray.

public LongSparseArray<E> clone ()

Added in API level 16

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
  • a copy of this object.

public void delete (long key)

Added in API level 16

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

public E get (long key, E valueIfKeyNotFound)

Added in API level 16

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

public E get (long key)

Added in API level 16

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

public int indexOfKey (long key)

Added in API level 16

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

public int indexOfValue (E value)

Added in API level 16

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.

public long keyAt (int index)

Added in API level 16

Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this LongSparseArray stores.

public void put (long key, E value)

Added in API level 16

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

Added in API level 16

Alias for delete(long).

public void removeAt (int index)

Added in API level 16

Removes the mapping at the specified index.

public void setValueAt (int index, E value)

Added in API level 16

Given an index in the range 0...size()-1, sets a new value for the indexth key-value mapping that this LongSparseArray stores.

public int size ()

Added in API level 16

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

public E valueAt (int index)

Added in API level 16

Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this LongSparseArray stores.