androidx.core.util

Kotlin |Java

Interfaces

Consumer	Compat version of `java.util.function.Consumer`
Pool	Interface for managing a pool of objects.
Predicate	Compat version of `java.util.function.Predicate`
Supplier	Compat version of `java.util.function.Supplier`

Classes

AtomicFile	Static library support version of the framework's `android.util.AtomicFile`, a helper class for performing atomic operations on a file by writing to a new file and renaming it into the place of the original file after the write has successfully completed.
ObjectsCompat	This class consists of static utility methods for operating on objects.
Pair	Container to ease passing around a tuple of two objects.
PatternsCompat	Commonly used regular expression patterns.
Pools	Helper class for creating pools of objects.

Top-level functions summary

LruCache<K, V>	`lruCache(maxSize: Int, crossinline sizeOf: (key: K, value: V) -> Int = { _, _ -> 1 }, crossinline create: (key: K) -> V? = { null as V? }, crossinline onEntryRemoved: (evicted: Boolean, key: K, oldValue: V, newValue: V?) -> Unit = { _, _, _, _ -> })` Creates an LruCache with the given parameters.
infix Range<T>	`T.rangeTo(that: T)` Creates a range from this Comparable value to that.

Extension functions summary

For android.util.AtomicFile
ByteArray	`AtomicFile.readBytes()` Gets the entire content of this file as a byte array.
String	`AtomicFile.readText(charset: Charset = Charsets.UTF_8)` Gets the entire content of this file as a String using UTF-8 or specified charset.
Unit	`AtomicFile.tryWrite(block: (out: FileOutputStream) -> Unit)` Perform the write operations inside block on this file.
Unit	`AtomicFile.writeBytes(array: ByteArray)` Sets the content of this file as an array of bytes.
Unit	`AtomicFile.writeText(text: String, charset: Charset = Charsets.UTF_8)` Sets the content of this file as text encoded using UTF-8 or specified charset.

For android.util.LongSparseArray
operator Boolean	`LongSparseArray<T>.contains(key: Long)` Returns true if the collection contains key.
Boolean	`LongSparseArray<T>.containsKey(key: Long)` Returns true if the collection contains key.
Boolean	`LongSparseArray<T>.containsValue(value: T)` Returns true if the collection contains value.
Unit	`LongSparseArray<T>.forEach(action: (key: Long, value: T) -> Unit)` Performs the given action for each key/value entry.
T	`LongSparseArray<T>.getOrDefault(key: Long, defaultValue: T)` Return the value corresponding to key, or defaultValue when not present.
T	`LongSparseArray<T>.getOrElse(key: Long, defaultValue: () -> T)` Return the value corresponding to key, or from defaultValue when not present.
Boolean	`LongSparseArray<T>.isEmpty()` Return true when the collection contains no elements.
Boolean	`LongSparseArray<T>.isNotEmpty()` Return true when the collection contains elements.
LongIterator	`LongSparseArray<T>.keyIterator()` Return an iterator over the collection's keys.
operator LongSparseArray<T>	`LongSparseArray<T>.plus(other: LongSparseArray<T>)` Creates a new collection by adding or replacing entries from other.
Unit	`LongSparseArray<T>.putAll(other: LongSparseArray<T>)` Update this collection by adding or replacing entries from other.
Boolean	`LongSparseArray<T>.remove(key: Long, value: T)` Removes the entry for key only if it is mapped to value.
operator Unit	`LongSparseArray<T>.set(key: Long, value: T)` Allows the use of the index operator for storing values in the collection.
Iterator<T>	`LongSparseArray<T>.valueIterator()` Return an iterator over the collection's values.

For android.util.Pair
operator F	`Pair<F, S>.component1()` Returns the first component of the pair.
operator S	`Pair<F, S>.component2()` Returns the second component of the pair.
Pair<F, S>	`Pair<F, S>.toKotlinPair()` Returns this Android `Pair` as a Kotlin `Pair`.

For android.util.Range
infix Range<T>	`Range<T>.and(other: Range<T>)` Return the intersection of this range and other.
operator Range<T>	`Range<T>.plus(value: T)` Return the smallest range that includes this and value.
operator Range<T>	`Range<T>.plus(other: Range<T>)` Return the smallest range that includes this and other.
ClosedRange<T>	`Range<T>.toClosedRange()` Returns this Range as a ClosedRange.

For android.util.Size
operator Int	`Size.component1()` Returns "width", the first component of this Size.
operator Int	`Size.component2()` Returns "height", the second component of this Size.

For android.util.SizeF
operator Float	`SizeF.component1()` Returns "width", the first component of this SizeF.
operator Float	`SizeF.component2()` Returns "height", the second component of this SizeF.

For android.util.SparseArray
operator Boolean	`SparseArray<T>.contains(key: Int)` Returns true if the collection contains key.
Boolean	`SparseArray<T>.containsKey(key: Int)` Returns true if the collection contains key.
Boolean	`SparseArray<T>.containsValue(value: T)` Returns true if the collection contains value.
Unit	`SparseArray<T>.forEach(action: (key: Int, value: T) -> Unit)` Performs the given action for each key/value entry.
T	`SparseArray<T>.getOrDefault(key: Int, defaultValue: T)` Return the value corresponding to key, or defaultValue when not present.
T	`SparseArray<T>.getOrElse(key: Int, defaultValue: () -> T)` Return the value corresponding to key, or from defaultValue when not present.
Boolean	`SparseArray<T>.isEmpty()` Return true when the collection contains no elements.
Boolean	`SparseArray<T>.isNotEmpty()` Return true when the collection contains elements.
IntIterator	`SparseArray<T>.keyIterator()` Return an iterator over the collection's keys.
operator SparseArray<T>	`SparseArray<T>.plus(other: SparseArray<T>)` Creates a new collection by adding or replacing entries from other.
Unit	`SparseArray<T>.putAll(other: SparseArray<T>)` Update this collection by adding or replacing entries from other.
Boolean	`SparseArray<T>.remove(key: Int, value: T)` Removes the entry for key only if it is mapped to value.
operator Unit	`SparseArray<T>.set(key: Int, value: T)` Allows the use of the index operator for storing values in the collection.
Iterator<T>	`SparseArray<T>.valueIterator()` Return an iterator over the collection's values.

For android.util.SparseBooleanArray
operator Boolean	`SparseBooleanArray.contains(key: Int)` Returns true if the collection contains key.
Boolean	`SparseBooleanArray.containsKey(key: Int)` Returns true if the collection contains key.
Boolean	`SparseBooleanArray.containsValue(value: Boolean)` Returns true if the collection contains value.
Unit	`SparseBooleanArray.forEach(action: (key: Int, value: Boolean) -> Unit)` Performs the given action for each key/value entry.
Boolean	`SparseBooleanArray.getOrDefault(key: Int, defaultValue: Boolean)` Return the value corresponding to key, or defaultValue when not present.
Boolean	`SparseBooleanArray.getOrElse(key: Int, defaultValue: () -> Boolean)` Return the value corresponding to key, or from defaultValue when not present.
Boolean	`SparseBooleanArray.isEmpty()` Return true when the collection contains no elements.
Boolean	`SparseBooleanArray.isNotEmpty()` Return true when the collection contains elements.
IntIterator	`SparseBooleanArray.keyIterator()` Return an iterator over the collection's keys.
operator SparseBooleanArray	`SparseBooleanArray.plus(other: SparseBooleanArray)` Creates a new collection by adding or replacing entries from other.
Unit	`SparseBooleanArray.putAll(other: SparseBooleanArray)` Update this collection by adding or replacing entries from other.
Boolean	`SparseBooleanArray.remove(key: Int, value: Boolean)` Removes the entry for key only if it is mapped to value.
operator Unit	`SparseBooleanArray.set(key: Int, value: Boolean)` Allows the use of the index operator for storing values in the collection.
BooleanIterator	`SparseBooleanArray.valueIterator()` Return an iterator over the collection's values.

For android.util.SparseIntArray
operator Boolean	`SparseIntArray.contains(key: Int)` Returns true if the collection contains key.
Boolean	`SparseIntArray.containsKey(key: Int)` Returns true if the collection contains key.
Boolean	`SparseIntArray.containsValue(value: Int)` Returns true if the collection contains value.
Unit	`SparseIntArray.forEach(action: (key: Int, value: Int) -> Unit)` Performs the given action for each key/value entry.
Int	`SparseIntArray.getOrDefault(key: Int, defaultValue: Int)` Return the value corresponding to key, or defaultValue when not present.
Int	`SparseIntArray.getOrElse(key: Int, defaultValue: () -> Int)` Return the value corresponding to key, or from defaultValue when not present.
Boolean	`SparseIntArray.isEmpty()` Return true when the collection contains no elements.
Boolean	`SparseIntArray.isNotEmpty()` Return true when the collection contains elements.
IntIterator	`SparseIntArray.keyIterator()` Return an iterator over the collection's keys.
operator SparseIntArray	`SparseIntArray.plus(other: SparseIntArray)` Creates a new collection by adding or replacing entries from other.
Unit	`SparseIntArray.putAll(other: SparseIntArray)` Update this collection by adding or replacing entries from other.
Boolean	`SparseIntArray.remove(key: Int, value: Int)` Removes the entry for key only if it is mapped to value.
operator Unit	`SparseIntArray.set(key: Int, value: Int)` Allows the use of the index operator for storing values in the collection.
IntIterator	`SparseIntArray.valueIterator()` Return an iterator over the collection's values.

For android.util.SparseLongArray
operator Boolean	`SparseLongArray.contains(key: Int)` Returns true if the collection contains key.
Boolean	`SparseLongArray.containsKey(key: Int)` Returns true if the collection contains key.
Boolean	`SparseLongArray.containsValue(value: Long)` Returns true if the collection contains value.
Unit	`SparseLongArray.forEach(action: (key: Int, value: Long) -> Unit)` Performs the given action for each key/value entry.
Long	`SparseLongArray.getOrDefault(key: Int, defaultValue: Long)` Return the value corresponding to key, or defaultValue when not present.
Long	`SparseLongArray.getOrElse(key: Int, defaultValue: () -> Long)` Return the value corresponding to key, or from defaultValue when not present.
Boolean	`SparseLongArray.isEmpty()` Return true when the collection contains no elements.
Boolean	`SparseLongArray.isNotEmpty()` Return true when the collection contains elements.
IntIterator	`SparseLongArray.keyIterator()` Return an iterator over the collection's keys.
operator SparseLongArray	`SparseLongArray.plus(other: SparseLongArray)` Creates a new collection by adding or replacing entries from other.
Unit	`SparseLongArray.putAll(other: SparseLongArray)` Update this collection by adding or replacing entries from other.
Boolean	`SparseLongArray.remove(key: Int, value: Long)` Removes the entry for key only if it is set to value.
operator Unit	`SparseLongArray.set(key: Int, value: Long)` Allows the use of the index operator for storing values in the collection.
LongIterator	`SparseLongArray.valueIterator()` Return an iterator over the collection's values.

For kotlin.Double
Half	`Double.toHalf()` Returns a Half instance representing given Double.

For kotlin.Float
Half	`Float.toHalf()` Returns a Half instance representing given Float.

For kotlin.Pair
Pair<F, S>	`Pair<F, S>.toAndroidPair()` Returns this Kotlin `Pair` as an Android `Pair`.
Pair<F, S>	`Pair<F, S>.toAndroidXPair()` Returns this Kotlin `Pair` as an AndroidX `Pair`.

For kotlin.Short
Half	`Short.toHalf()` Returns a Half instance representing given Short.

For kotlin.String
Half	`String.toHalf()` Returns a Half instance representing given String.

For kotlin.ranges.ClosedRange
Range<T>	`ClosedRange<T>.toRange()` Returns this ClosedRange as a Range.

For Pair
operator F	`Pair<F, S>.component1()` Returns the first component of the pair.
operator S	`Pair<F, S>.component2()` Returns the second component of the pair.
Pair<F, S>	`Pair<F, S>.toKotlinPair()` Returns this AndroidX `Pair` as a Kotlin `Pair`.

Extension properties summary

For android.util.LongSparseArray
Int	`LongSparseArray<T>.size()` Returns the number of key/value pairs in the collection.

For android.util.SparseArray
Int	`SparseArray<T>.size()` Returns the number of key/value pairs in the collection.

For android.util.SparseBooleanArray
Int	`SparseBooleanArray.size()` Returns the number of key/value pairs in the collection.

For android.util.SparseIntArray
Int	`SparseIntArray.size()` Returns the number of key/value pairs in the collection.

For android.util.SparseLongArray
Int	`SparseLongArray.size()` Returns the number of key/value entries in the collection.

Top-level functions

lruCache

inline fun <K : Any, V : Any> lruCache(
    maxSize: Int, 
    crossinline sizeOf: (key: K, value: V) -> Int = { _, _ -> 1 }, 
    crossinline create: (key: K) -> V? = { null as V? }, 
    crossinline onEntryRemoved: (evicted: Boolean, key: K, oldValue: V, newValue: V?) -> Unit = { _, _, _, _ -> }
): LruCache<K, V>

Creates an LruCache with the given parameters.

Parameters
maxSize: Int	for caches that do not specify sizeOf, this is the maximum number of entries in the cache. For all other caches, this is the maximum sum of the sizes of the entries in this cache.
sizeOf: (key: K, value: V) -> Int = { _, _ -> 1 }	function that returns the size of the entry for key and value in user-defined units. The default implementation returns 1.
create: (key: K) -> V? = { null as V? }	a create called after a cache miss to compute a value for the corresponding key. Returns the computed value or null if no value can be computed. The default implementation returns null.
onEntryRemoved: (evicted: Boolean, key: K, oldValue: V, newValue: V?) -> Unit = { _, _, _, _ -> }	a function called for entries that have been evicted or removed.

See Also

rangeTo

@RequiresApi(21) inline infix fun <T : Comparable<T>> T.rangeTo(that: T): Range<T>

Creates a range from this Comparable value to that.

Exceptions
`IllegalArgumentException`	if this value is comparatively smaller than that.

Extension functions

and

@RequiresApi(21) inline infix fun <T : Comparable<T>> Range<T>.and(other: Range<T>): Range<T>

Return the intersection of this range and other.

Exceptions
`IllegalArgumentException`	if this is disjoint from other.

component1

inline operator fun <F, S> Pair<F, S>.component1(): F

Returns the first component of the pair.

This method allows to use destructuring declarations when working with pairs, for example:

val (first, second) = myPair

component1

@RequiresApi(21) inline operator fun Size.component1(): Int

Returns "width", the first component of this Size.

This method allows to use destructuring declarations when working with sizes, for example:

val (w, h) = mySize

component1

@RequiresApi(21) inline operator fun SizeF.component1(): Float

Returns "width", the first component of this SizeF.

This method allows to use destructuring declarations when working with sizes, for example:

val (w, h) = mySize

component1

inline operator fun <F, S> Pair<F, S>.component1(): F

Returns the first component of the pair.

This method allows to use destructuring declarations when working with pairs, for example:

val (first, second) = myPair

component2

inline operator fun <F, S> Pair<F, S>.component2(): S

Returns the second component of the pair.

This method allows to use destructuring declarations when working with pairs, for example:

val (first, second) = myPair

component2

@RequiresApi(21) inline operator fun Size.component2(): Int

Returns "height", the second component of this Size.

This method allows to use destructuring declarations when working with sizes, for example:

val (w, h) = mySize

component2

@RequiresApi(21) inline operator fun SizeF.component2(): Float

Returns "height", the second component of this SizeF.

This method allows to use destructuring declarations when working with sizes, for example:

val (w, h) = mySize

component2

inline operator fun <F, S> Pair<F, S>.component2(): S

Returns the second component of the pair.

This method allows to use destructuring declarations when working with pairs, for example:

val (first, second) = myPair