Home How it Works Android APIMiner IDE Version More Info

to top

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

SparseIntArray

extends Object
implements Cloneable

java.lang.Object
↳	android.util.SparseIntArray

Class Overview

SparseIntArrays map integers to integers. Unlike a normal array of integers, there can be gaps in the indices. It is intended to be more efficient than using a HashMap to map Integers to Integers.

Summary

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

Public Methods
? Examples	void	append(int key, int 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.
? Examples	void	clear() Removes all key-value mappings from this SparseIntArray.
? Examples	SparseIntArray	clone() Creates and returns a copy of this `Object`.
? Examples	void	delete(int key) Removes the mapping from the specified key, if there was any.
? Examples	int	get(int key) Gets the int mapped from the specified key, or `0` if no such mapping has been made.
? Examples	int	get(int key, int valueIfKeyNotFound) Gets the int mapped from the specified key, or the specified value if no such mapping has been made.
? Examples	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.
? Examples	int	indexOfValue(int 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.
? Examples	int	keyAt(int index) Given an index in the range `0...size()-1`, returns the key from the `index`th key-value mapping that this SparseIntArray stores.
? Examples	void	put(int key, int value) Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.
? Examples	void	removeAt(int index) Removes the mapping at the given index.
? Examples	int	size() Returns the number of key-value mappings that this SparseIntArray currently stores.
? Examples	int	valueAt(int index) Given an index in the range `0...size()-1`, returns the value from the `index`th key-value mapping that this SparseIntArray stores.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public SparseIntArray ()

Added in API level 1

Creates a new SparseIntArray containing no mappings.

public SparseIntArray (int initialCapacity)

Added in API level 1

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

Public Methods

public void append (int key, int value)

Added in API level 1

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 1

Removes all key-value mappings from this SparseIntArray.

public SparseIntArray clone ()

Added in API level 1

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

Added in API level 1

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

public int get (int key)

Added in API level 1

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

public int get (int key, int valueIfKeyNotFound)

Added in API level 1

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

public int indexOfKey (int key)

Added in API level 1

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

Added in API level 1

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 int keyAt (int index)

Added in API level 1

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

public void put (int key, int value)

Added in API level 1

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 removeAt (int index)

Added in API level 3

Removes the mapping at the given index.

public int size ()

Added in API level 1

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

public int valueAt (int index)

Added in API level 1

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

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Enums

Exceptions

SparseIntArray

Class Overview

Summary

Public Constructors

public SparseIntArray ()

public SparseIntArray (int initialCapacity)

Public Methods

public void append (int key, int value)

public void clear ()

public SparseIntArray clone ()

Returns

public void delete (int key)

public int get (int key)

public int get (int key, int valueIfKeyNotFound)

public int indexOfKey (int key)

public int indexOfValue (int value)

public int keyAt (int index)

public void put (int key, int value)

public void removeAt (int index)

public int size ()

public int valueAt (int index)