Home How it Works Android APIMiner IDE Version More Info

to top

Classes

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

public class

SparseArrayCompat

extends Object

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

Class Overview

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

Summary

Public Constructors
? Examples	SparseArrayCompat() Creates a new SparseArray containing no mappings.
? Examples	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
? Examples	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.
? Examples	void	clear() Removes all key-value mappings from this SparseArray.
? Examples	void	delete(int key) Removes the mapping from the specified key, if there was any.
? Examples	E	get(int key) Gets the Object mapped from the specified key, or `null` if no such mapping has been made.
? Examples	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.
? 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(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.
? 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 SparseArray stores.
? Examples	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.
? Examples	void	remove(int key) Alias for `delete(int)`.
? Examples	void	removeAt(int index) Removes the mapping at the specified index.
? Examples	void	removeAtRange(int index, int size) Remove a range of mappings as a batch.
? Examples	void	setValueAt(int index, E value) Given an index in the range `0...size()-1`, sets a new value for the `index`th key-value mapping that this SparseArray stores.
? Examples	int	size() Returns the number of key-value mappings that this SparseArray currently stores.
? Examples	E	valueAt(int index) Given an index in the range `0...size()-1`, returns the value from the `index`th key-value mapping that this SparseArray 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 SparseArrayCompat ()

Creates a new SparseArray containing no mappings.

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.

Public Methods

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.

public void clear ()

Removes all key-value mappings from this SparseArray.

public void delete (int key)

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

public E get (int key)

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

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.

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.

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.

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.

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.

public void remove (int key)

Alias for delete(int).

public void removeAt (int index)

Removes the mapping at the specified index.

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

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.

public int size ()

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

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.

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

Classes