Reference:Android.util.SparseArray

From Triled Wiki

android.util
public class android.util.SparseArray

java.lang.Object
	android.util.SparseArray

SparseArrays map integers 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 Integers to Objects.

Contents 1 Summary 1.1 Public Constructors 1.2 Public Methods 1.2.1 Methods inherited from class java.lang.Object 2 Details 2.1 Public Constructors 2.1.1 public SparseArray() 2.1.2 public SparseArray(int initialCapacity) 2.2 Public Methods 2.2.1 public void append(int key, E value) 2.2.2 public void clear() 2.2.3 public void delete(int key) 2.2.4 public E get(int key, E valueIfKeyNotFound) 2.2.5 public E get(int key) 2.2.6 public int indexOfKey(int key) 2.2.7 public int indexOfValue(E value) 2.2.8 public int keyAt(int index) 2.2.9 public void put(int key, E value) 2.2.10 public void remove(int key) 2.2.11 public int size() 2.2.12 public E valueAt(int index) 3 References

[edit] Summary

[edit] Public Constructors

					SparseArray ()
					Creates a new SparseArray containing no mappings.
					SparseArray (int initialCapacity)
					Creates a new SparseArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings.

[edit] 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.
				void	delete (int key)
					Removes the mapping from the specified key, if there was any.
				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.
				E	get (int key)
					Gets the Object mapped from the specified key, or nullif 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).
				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.

[edit] Methods inherited from class java.lang.Object

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

[edit] Details

[edit] Public Constructors

[edit] public SparseArray()

Creates a new SparseArray containing no mappings.

[edit] public SparseArray(int initialCapacity)

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

[edit] Public Methods

[edit] 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.

[edit] public void clear()

Removes all key-value mappings from this SparseArray.

[edit] public void delete(int key)

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

[edit] 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.

[edit] public E get(int key)

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

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] public void remove(int key)

Alias for delete(int).

[edit] public int size()

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

[edit] 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.

[edit] References

• Original documentation page for Android SDK build m5-rc15e - 14 apr 2008 17:27