SparseBooleanArray
open class SparseBooleanArray : Cloneable
| kotlin.Any | |
| ↳ | android.util.SparseBooleanArray |
SparseBooleanArrays map integers to booleans. Unlike a normal array of booleans there can be gaps in the indices. It is intended to be more memory efficient than using a HashMap to map Integers to Booleans, both because it avoids auto-boxing keys and values and its data structure doesn't rely on an extra entry object for each mapping.
Note that this container keeps its mappings in an array data structure, using a binary search to find keys. The implementation is not intended to be appropriate for data structures that may contain large numbers of items. It is generally slower than a traditional HashMap, since lookups require a binary search and adds and removes require inserting and deleting entries in the array. For containers holding up to hundreds of items, the performance difference is not significant, less than 50%.
It is possible to iterate over the items in this container using keyAt(int) and valueAt(int). Iterating over the keys using keyAt(int) with ascending values of the index will return the keys in ascending order, or the values corresponding to the keys in ascending order in the case of valueAt(int).
Summary
| Public constructors | |
|---|---|
|
Creates a new SparseBooleanArray containing no mappings. |
|
SparseBooleanArray(initialCapacity: Int)Creates a new SparseBooleanArray containing no mappings that will not require any additional memory allocation to store the specified number of mappings. |
|
| Public methods | |
|---|---|
| open Unit |
Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array. |
| open Unit |
clear()Removes all key-value mappings from this SparseBooleanArray. |
| open SparseBooleanArray |
clone() |
| open Unit |
Removes the mapping from the specified key, if there was any. |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Boolean |
Gets the boolean mapped from the specified key, or |
| open Boolean |
Gets the boolean mapped from the specified key, or the specified value if no such mapping has been made. |
| open Int |
hashCode() |
| open Int |
indexOfKey(key: Int)Returns the index for which |
| open Int |
indexOfValue(value: Boolean)Returns an index for which |
| open Int |
Given an index in the range |
| open Unit |
Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one. |
| open Unit |
Removes the mapping at the specified index. |
| open Unit |
setValueAt(index: Int, value: Boolean)Directly set the value at a particular index. |
| open Int |
size()Returns the number of key-value mappings that this SparseBooleanArray currently stores. |
| open String |
toString()Returns a string representation of the object. |
| open Boolean |
Given an index in the range |
Public constructors
SparseBooleanArray
SparseBooleanArray()
Creates a new SparseBooleanArray containing no mappings.
SparseBooleanArray
SparseBooleanArray(initialCapacity: Int)
Creates a new SparseBooleanArray 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
append
open fun append(
key: Int,
value: Boolean
): Unit
Puts a key/value pair into the array, optimizing for the case where the key is greater than all existing keys in the array.
clear
open fun clear(): Unit
Removes all key-value mappings from this SparseBooleanArray.
clone
open fun clone(): SparseBooleanArray
| Return | |
|---|---|
SparseBooleanArray |
a clone of this instance. |
| Exceptions | |
|---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
delete
open fun delete(key: Int): Unit
Removes the mapping from the specified key, if there was any.
equals
open fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
that |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
get
open fun get(key: Int): Boolean
Gets the boolean mapped from the specified key, or false if no such mapping has been made.
get
open fun get(
key: Int,
valueIfKeyNotFound: Boolean
): Boolean
Gets the boolean mapped from the specified key, or the specified value if no such mapping has been made.
hashCode
open fun hashCode(): Int
| Return | |
|---|---|
Int |
a hash code value for this object. |
indexOfKey
open fun indexOfKey(key: Int): Int
Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.
indexOfValue
open fun indexOfValue(value: Boolean): Int
Returns an index for which valueAt 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.
keyAt
open fun keyAt(index: Int): Int
Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this SparseBooleanArray stores.
The keys corresponding to indices in ascending order are guaranteed to be in ascending order, e.g., keyAt(0) will return the smallest key and keyAt(size()-1) will return the largest key.
For indices outside of the range 0...size()-1, the behavior is undefined for apps targeting android.os.Build.VERSION_CODES#P and earlier, and an ArrayIndexOutOfBoundsException is thrown for apps targeting android.os.Build.VERSION_CODES#Q and later.
put
open fun put(
key: Int,
value: Boolean
): Unit
Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one.
removeAt
open fun removeAt(index: Int): Unit
Removes the mapping at the specified index.
For indices outside of the range 0...size()-1, the behavior is undefined.
setValueAt
open fun setValueAt(
index: Int,
value: Boolean
): Unit
Directly set the value at a particular index.
For indices outside of the range 0...size()-1, the behavior is undefined for apps targeting android.os.Build.VERSION_CODES#P and earlier, and an ArrayIndexOutOfBoundsException is thrown for apps targeting android.os.Build.VERSION_CODES#Q and later.
size
open fun size(): Int
Returns the number of key-value mappings that this SparseBooleanArray currently stores.
toString
open fun toString(): String
Returns a string representation of the object.
This implementation composes a string by iterating over its mappings.
| Return | |
|---|---|
String |
a string representation of the object. |
valueAt
open fun valueAt(index: Int): Boolean
Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this SparseBooleanArray stores.
The values corresponding to indices in ascending order are guaranteed to be associated with keys in ascending order, e.g., valueAt(0) will return the value associated with the smallest key and valueAt(size()-1) will return the value associated with the largest key.
For indices outside of the range 0...size()-1, the behavior is undefined for apps targeting android.os.Build.VERSION_CODES#P and earlier, and an ArrayIndexOutOfBoundsException is thrown for apps targeting android.os.Build.VERSION_CODES#Q and later.