LongSparseArray
public class LongSparseArray<E extends Object>
SparseArray mapping longs to Objects. Unlike a normal array of Objects, there can be gaps in the indices. It is intended to be more memory efficient than using a HashMap to map Longs to Objects, both because it avoids auto-boxing keys 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%.
To help with performance, the container includes an optimization when removing keys: instead of compacting its array immediately, it leaves the removed entry marked as deleted. The entry can then be re-used for the same key, or compacted later in a single garbage collection step of all removed entries. This garbage collection will need to be performed at any time the array needs to be grown or the map size or entry values are retrieved.
It is possible to iterate over the items in this container using keyAt and valueAt. Iterating over the keys using keyAt 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.
Summary
Public constructors |
|---|
<E extends Object> LongSparseArray(int initialCapacity)Creates a new |
Public methods |
|
|---|---|
void |
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 |
@NonNull LongSparseArray<@NonNull E> |
clone() |
boolean |
containsKey(long key)Returns |
boolean |
containsValue(@NonNull E value)Returns |
void |
This method is deprecated. Alias for `remove(key)`. |
E |
get(long key)Gets the value mapped from the specified |
@NonNull E |
Gets the value mapped from the specified |
int |
indexOfKey(long key)Returns the index for which |
int |
indexOfValue(@NonNull E value)Returns an index for which |
boolean |
isEmpty()Return |
long |
keyAt(int index)Given an index in the range |
void |
Adds a mapping from the specified key to the specified value, replacing the previous mapping from the specified key if there was one. |
void |
putAll(@NonNull LongSparseArray<@NonNull E> other)Copies all of the mappings from |
E |
putIfAbsent(long key, @NonNull E value)Add a new value to the array map only if the key does not already have a value or it is mapped to |
void |
remove(long key)Removes the mapping from the specified |
boolean |
Remove an existing key from the array map only if it is currently mapped to |
void |
removeAt(int index)Removes the mapping at the specified |
E |
Replace the mapping for |
boolean |
Replace the mapping for |
void |
setValueAt(int index, @NonNull E value)Given an index in the range |
int |
size()Returns the number of key-value mappings that this |
@NonNull String |
toString()Returns a string representation of the object. |
@NonNull E |
valueAt(int index)Given an index in the range |
Extension functions |
|
|---|---|
final boolean |
<T extends Object> LongSparseArrayKt.contains(Returns true if the collection contains |
final void |
<T extends Object> LongSparseArrayKt.forEach(Performs the given |
final @NonNull T |
<T extends Object> LongSparseArrayKt.getOrDefault(Return the value corresponding to |
final @NonNull T |
<T extends Object> LongSparseArrayKt.getOrElse(Return the value corresponding to |
final int |
LongSparseArrayKt.getSize(@NonNull LongSparseArray<@NonNull T> receiver)Returns the number of key/value pairs in the collection. |
final boolean |
<T extends Object> LongSparseArrayKt.isNotEmpty(Return true when the collection contains elements. |
final @NonNull LongIterator |
<T extends Object> LongSparseArrayKt.keyIterator(Return an iterator over the collection's keys. |
final @NonNull LongSparseArray<@NonNull T> |
<T extends Object> LongSparseArrayKt.plus(Creates a new collection by adding or replacing entries from |
final void |
<T extends Object> LongSparseArrayKt.set(Allows the use of the index operator for storing values in the collection. |
final @NonNull Iterator<@NonNull T> |
<T extends Object> LongSparseArrayKt.valueIterator(Return an iterator over the collection's values. |
Public constructors
LongSparseArray
public <E extends Object> LongSparseArray(int initialCapacity)
Creates a new LongSparseArray 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
public void append(long key, @NonNull 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.
containsKey
public boolean containsKey(long key)
Returns true if the specified key is mapped.
containsValue
public boolean containsValue(@NonNull E value)
Returns true if the specified value is mapped from any key.
get
public E get(long key)
Gets the value mapped from the specified key, or null if no such mapping has been made.
get
public @NonNull E get(long key, @NonNull E defaultValue)
Gets the value mapped from the specified key, or defaultValue if no such mapping has been made.
indexOfKey
public int indexOfKey(long key)
Returns the index for which keyAt would return the specified key, or a negative number if the specified key is not mapped.
indexOfValue
public int indexOfValue(@NonNull E value)
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.
isEmpty
public boolean isEmpty()
Return true if size is 0.
| Returns | |
|---|---|
boolean |
|
keyAt
public long keyAt(int index)
Given an index in the range 0...size()-1, returns the key from the indexth key-value mapping that this LongSparseArray 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.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
put
public void put(long key, @NonNull 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.
putAll
public void putAll(@NonNull LongSparseArray<@NonNull E> other)
Copies all of the mappings from other to this map. The effect of this call is equivalent to that of calling put on this map once for each mapping from key to value in other.
putIfAbsent
public E putIfAbsent(long key, @NonNull E value)
Add a new value to the array map only if the key does not already have a value or it is mapped to null.
| Parameters | |
|---|---|
long key |
The key under which to store the value. |
@NonNull E value |
The value to store for the given key. |
| Returns | |
|---|---|
E |
Returns the value that was stored for the given key, or |
remove
public void remove(long key)
Removes the mapping from the specified key, if there was any.
remove
public boolean remove(long key, @NonNull E value)
Remove an existing key from the array map only if it is currently mapped to value.
| Parameters | |
|---|---|
long key |
The key of the mapping to remove. |
@NonNull E value |
The value expected to be mapped to the key. |
| Returns | |
|---|---|
boolean |
Returns |
replace
public E replace(long key, @NonNull E value)
Replace the mapping for key only if it is already mapped to a value.
| Parameters | |
|---|---|
long key |
The key of the mapping to replace. |
@NonNull E value |
The value to store for the given key. |
| Returns | |
|---|---|
E |
Returns the previous mapped value or |
replace
public boolean replace(long key, @NonNull E oldValue, @NonNull E newValue)
Replace the mapping for key only if it is already mapped to a value.
| Parameters | |
|---|---|
long key |
The key of the mapping to replace. |
@NonNull E oldValue |
The value expected to be mapped to the key. |
@NonNull E newValue |
The value to store for the given key. |
| Returns | |
|---|---|
boolean |
Returns |
setValueAt
public void setValueAt(int index, @NonNull E value)
Given an index in the range 0...size()-1, sets a new value for the indexth key-value mapping that this LongSparseArray stores.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
size
public int size()
Returns the number of key-value mappings that this LongSparseArray currently stores.
toString
public @NonNull String toString()
Returns a string representation of the object.
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.
valueAt
public @NonNull E valueAt(int index)
Given an index in the range 0...size()-1, returns the value from the indexth key-value mapping that this LongSparseArray 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.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
Extension functions
LongSparseArrayKt.contains
public final boolean <T extends Object> LongSparseArrayKt.contains(
@NonNull LongSparseArray<@NonNull T> receiver,
long key
)
Returns true if the collection contains key.
LongSparseArrayKt.forEach
public final void <T extends Object> LongSparseArrayKt.forEach(
@NonNull LongSparseArray<@NonNull T> receiver,
@NonNull Function2<@NonNull Long, @NonNull value, Unit> action
)
Performs the given action for each key/value entry.
LongSparseArrayKt.getOrDefault
public final @NonNull T <T extends Object> LongSparseArrayKt.getOrDefault(
@NonNull LongSparseArray<@NonNull T> receiver,
long key,
@NonNull T defaultValue
)
Return the value corresponding to key, or defaultValue when not present.
LongSparseArrayKt.getOrElse
public final @NonNull T <T extends Object> LongSparseArrayKt.getOrElse(
@NonNull LongSparseArray<@NonNull T> receiver,
long key,
@NonNull Function0<@NonNull T> defaultValue
)
Return the value corresponding to key, or from defaultValue when not present.
LongSparseArrayKt.getSize
public final int LongSparseArrayKt.getSize(@NonNull LongSparseArray<@NonNull T> receiver)
Returns the number of key/value pairs in the collection.
LongSparseArrayKt.isNotEmpty
public final boolean <T extends Object> LongSparseArrayKt.isNotEmpty(
@NonNull LongSparseArray<@NonNull T> receiver
)
Return true when the collection contains elements.
LongSparseArrayKt.keyIterator
public final @NonNull LongIterator <T extends Object> LongSparseArrayKt.keyIterator(
@NonNull LongSparseArray<@NonNull T> receiver
)
Return an iterator over the collection's keys.
LongSparseArrayKt.plus
public final @NonNull LongSparseArray<@NonNull T> <T extends Object> LongSparseArrayKt.plus(
@NonNull LongSparseArray<@NonNull T> receiver,
@NonNull LongSparseArray<@NonNull T> other
)
Creates a new collection by adding or replacing entries from other.
LongSparseArrayKt.set
public final void <T extends Object> LongSparseArrayKt.set(
@NonNull LongSparseArray<@NonNull T> receiver,
long key,
@NonNull T value
)
Allows the use of the index operator for storing values in the collection.
LongSparseArrayKt.valueIterator
public final @NonNull Iterator<@NonNull T> <T extends Object> LongSparseArrayKt.valueIterator(
@NonNull LongSparseArray<@NonNull T> receiver
)
Return an iterator over the collection's values.