Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

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

public class

SparseArrayCompat

extends Object
implements Cloneable

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

Class Overview

A copy of the current platform (currently KITKAT version of SparseArray ; provides a removeAt() method and other things.

Summary

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

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.
SparseArrayCompat <E>	clone () Creates and returns a copy of this `Object` .
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 `index` th 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 `index` th key-value mapping that this SparseArray stores.
int	size () Returns the number of key-value mappings that this SparseArray currently stores.
String	toString () Returns a string containing a concise, human-readable description of this object. This implementation composes a string by iterating over its mappings.
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. If you supply an initial capacity of 0, the sparse array will be initialized with a light-weight representation not requiring any additional array allocations.

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 SparseArrayCompat <E> clone ()

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)

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.

Note also that unlike most collections' indexOf methods, this method compares values using == rather than equals .

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

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 index th key-value mapping that this SparseArray stores.

public int size ()

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

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

          getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

This implementation composes a string by iterating over its mappings. If this map contains itself as a value, the string "(this Map)" will appear in its place.

Returns

a printable representation of this object.

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

Results

Interfaces

Classes

SparseArrayCompat

Class Overview

Summary

Public Constructors

public SparseArrayCompat ()

public SparseArrayCompat (int initialCapacity)

Public Methods

public void append (int key, E value)

public void clear ()

public SparseArrayCompat <E> clone ()

Returns

public void delete (int key)

public E get (int key)

public E get (int key, E valueIfKeyNotFound)

public int indexOfKey (int key)

public int indexOfValue (E value)

public int keyAt (int index)

public void put (int key, E value)

public void remove (int key)

public void removeAt (int index)

public void removeAtRange (int index, int size)

Parameters

public void setValueAt (int index, E value)

public int size ()

public String toString ()

Returns

public E valueAt (int index)