public class

SparseBooleanArray

extends Object
java.lang.Object
   ↳ android.util.SparseBooleanArray

Class Overview

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

Summary

Public Constructors
SparseBooleanArray()
Creates a new SparseBooleanArray containing no mappings.
SparseBooleanArray(int initialCapacity)
Creates a new SparseBooleanArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings.
Public Methods
void append(int key, boolean 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 SparseBooleanArray.
void delete(int key)
Removes the mapping from the specified key, if there was any.
boolean get(int key)
Gets the boolean mapped from the specified key, or false if no such mapping has been made.
boolean get(int key, boolean valueIfKeyNotFound)
Gets the boolean mapped from the specified key, or the specified value 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(boolean 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 SparseBooleanArray stores.
void put(int key, boolean value)
Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.
int size()
Returns the number of key-value mappings that this SparseBooleanArray currently stores.
boolean valueAt(int index)
Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this SparseBooleanArray stores.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SparseBooleanArray ()

Since: API Level 1

Creates a new SparseBooleanArray containing no mappings.

public SparseBooleanArray (int initialCapacity)

Since: API Level 1

Creates a new SparseBooleanArray 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, boolean value)

Since: 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 ()

Since: API Level 1

Removes all key-value mappings from this SparseBooleanArray.

public void delete (int key)

Since: API Level 1

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

public boolean get (int key)

Since: API Level 1

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

public boolean get (int key, boolean valueIfKeyNotFound)

Since: API Level 1

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

public int indexOfKey (int key)

Since: 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 (boolean value)

Since: 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)

Since: API Level 1

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

public void put (int key, boolean value)

Since: 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 int size ()

Since: API Level 1

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

public boolean valueAt (int index)

Since: API Level 1

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