-
- All Implemented Interfaces:
-
java.lang.Cloneable
public class LongSparseArray<E> implements Cloneable
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 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(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 ofvalueAt(int)
.
-
-
Constructor Summary
Constructors Constructor Description LongSparseArray()
Creates a new LongSparseArray containing no mappings. LongSparseArray(int initialCapacity)
Creates a new LongSparseArray containing no mappings that will notrequire any additional memory allocation to store the specifiednumber of mappings.
-
Method Summary
Modifier and Type Method Description LongSparseArray<E>
clone()
E
get(long key)
Gets the Object mapped from the specified key, or null
if no such mapping has been made.E
get(long key, E valueIfKeyNotFound)
Gets the Object mapped from the specified key, or the specified Objectif no such mapping has been made. void
delete(long key)
void
remove(long key)
Removes the mapping from the specified key, if there was any. boolean
remove(long key, Object value)
Remove an existing key from the array map only if it is currently mapped to {@code value}
.void
removeAt(int index)
Removes the mapping at the specified index. E
replace(long key, E value)
Replace the mapping for {@code key}
only if it is already mapped to a value.boolean
replace(long key, E oldValue, E newValue)
Replace the mapping for {@code key}
only if it is already mapped to a value.void
put(long key, E value)
Adds a mapping from the specified key to the specified value,replacing the previous mapping from the specified key if therewas one. void
putAll(@NonNull() LongSparseArray<out E> other)
Copies all of the mappings from the {@code other}
to this map.E
putIfAbsent(long key, E value)
Add a new value to the array map only if the key does not already have a value or it ismapped to {@code null}
.int
size()
Returns the number of key-value mappings that this LongSparseArraycurrently stores. boolean
isEmpty()
Return true if size() is 0. long
keyAt(int index)
Given an index in the range 0...size()-1
, returnsthe key from theindex
th key-value mapping that thisLongSparseArray stores.E
valueAt(int index)
Given an index in the range 0...size()-1
, returnsthe value from theindex
th key-value mapping that thisLongSparseArray stores.void
setValueAt(int index, E value)
Given an index in the range 0...size()-1
, sets a newvalue for theindex
th key-value mapping that thisLongSparseArray stores.int
indexOfKey(long key)
Returns the index for which keyAt would return thespecified key, or a negative number if the specifiedkey is not mapped. int
indexOfValue(E value)
Returns an index for which valueAt would return thespecified key, or a negative number if no keys map to thespecified value.Beware that this is a linear search, unlike lookups by key,and that multiple keys can map to the same value and this willfind only one of them. boolean
containsKey(long key)
Returns true if the specified key is mapped. boolean
containsValue(E value)
Returns true if the specified value is mapped from any key. void
clear()
Removes all key-value mappings from this LongSparseArray. void
append(long key, E value)
Puts a key/value pair into the array, optimizing for the case wherethe key is greater than all existing keys in the array. String
toString()
This implementation composes a string by iterating over its mappings. -
-
Constructor Detail
-
LongSparseArray
LongSparseArray()
Creates a new LongSparseArray containing no mappings.
-
LongSparseArray
LongSparseArray(int initialCapacity)
Creates a new LongSparseArray containing no mappings that will notrequire any additional memory allocation to store the specifiednumber of mappings.
-
-
Method Detail
-
clone
LongSparseArray<E> clone()
-
get
@Nullable() E get(long key)
Gets the Object mapped from the specified key, or
null
if no such mapping has been made.
-
get
E get(long key, E valueIfKeyNotFound)
Gets the Object mapped from the specified key, or the specified Objectif no such mapping has been made.
-
delete
@Deprecated() void delete(long key)
-
remove
void remove(long key)
Removes the mapping from the specified key, if there was any.
-
remove
boolean remove(long key, Object value)
Remove an existing key from the array map only if it is currently mapped to
{@code value}
.- Parameters:
key
- The key of the mapping to remove.value
- The value expected to be mapped to the key.
-
removeAt
void removeAt(int index)
Removes the mapping at the specified index.
-
replace
@Nullable() E replace(long key, E value)
Replace the mapping for
{@code key}
only if it is already mapped to a value.- Parameters:
key
- The key of the mapping to replace.value
- The value to store for the given key.
-
replace
boolean replace(long key, E oldValue, E newValue)
Replace the mapping for
{@code key}
only if it is already mapped to a value.- Parameters:
key
- The key of the mapping to replace.oldValue
- The value expected to be mapped to the key.newValue
- The value to store for the given key.
-
put
void put(long key, E value)
Adds a mapping from the specified key to the specified value,replacing the previous mapping from the specified key if therewas one.
-
putAll
void putAll(@NonNull() LongSparseArray<out E> other)
Copies all of the mappings from the
{@code other}
to this map. The effect of this call isequivalent to that of calling put on this map once for each mappingfrom key to value in{@code other}
.
-
putIfAbsent
@Nullable() E putIfAbsent(long key, E value)
Add a new value to the array map only if the key does not already have a value or it ismapped to
{@code null}
.- Parameters:
key
- The key under which to store the value.value
- The value to store for the given key.
-
size
int size()
Returns the number of key-value mappings that this LongSparseArraycurrently stores.
-
isEmpty
boolean isEmpty()
Return true if size() is 0.
-
keyAt
long keyAt(int index)
Given an index in the range
0...size()-1
, returnsthe key from theindex
th key-value mapping that thisLongSparseArray stores.The keys corresponding to indices in ascending order are guaranteed tobe in ascending order, e.g.,
keyAt(0)
will return thesmallest key andkeyAt(size()-1)
will return the largestkey.
-
valueAt
E valueAt(int index)
Given an index in the range
0...size()-1
, returnsthe value from theindex
th key-value mapping that thisLongSparseArray stores.The values corresponding to indices in ascending order are guaranteedto be associated with keys in ascending order, e.g.,
valueAt(0)
will return the value associated with thesmallest key andvalueAt(size()-1)
will return the valueassociated with the largest key.
-
setValueAt
void setValueAt(int index, E value)
Given an index in the range
0...size()-1
, sets a newvalue for theindex
th key-value mapping that thisLongSparseArray stores.
-
indexOfKey
int indexOfKey(long key)
Returns the index for which keyAt would return thespecified key, or a negative number if the specifiedkey is not mapped.
-
indexOfValue
int indexOfValue(E value)
Returns an index for which valueAt would return thespecified key, or a negative number if no keys map to thespecified value.Beware that this is a linear search, unlike lookups by key,and that multiple keys can map to the same value and this willfind only one of them.
-
containsKey
boolean containsKey(long key)
Returns true if the specified key is mapped.
-
containsValue
boolean containsValue(E value)
Returns true if the specified value is mapped from any key.
-
clear
void clear()
Removes all key-value mappings from this LongSparseArray.
-
append
void append(long key, E value)
Puts a key/value pair into the array, optimizing for the case wherethe key is greater than all existing keys in the array.
-
-
-
-