android.support.v4.util
Class SparseArrayCompat<E>

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

public class SparseArrayCompat<E>
extends Object

A copy of Honeycomb's SparseArray, that provides a removeAt() method.

Constructor Summary

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.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SparseArrayCompat

public SparseArrayCompat()

Creates a new SparseArray containing no mappings.

SparseArrayCompat

public 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

get

public E get(int key)

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

get

public 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

public void delete(int key)

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

remove

public void remove(int key)

Alias for delete(int).

removeAt

public void removeAt(int index)

Removes the mapping at the specified index.

removeAtRange

public 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

put

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

size

public int size()

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

keyAt

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.

valueAt

public 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

public 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

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

indexOfValue

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

clear

public void clear()

Removes all key-value mappings from this SparseArray.

append

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