# Data
Artifact: [androidx.work:work-runtime](https://developer.android.com/jetpack/androidx/releases/work) [View Source](https://cs.android.com/search?q=file:androidx/work/Data_.kt+class:androidx.work.Data) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
*** ** * ** ***
```
class Data
```
*** ** * ** ***
A persistable set of key/value pairs which are used as inputs and outputs for `https://developer.android.com/reference/kotlin/androidx/work/ListenableWorker`s. Keys are Strings, and values can be Strings, primitive types, or their array variants.
This is a lightweight container, and should not be considered your data store. As such, there is an enforced .MAX_DATA_BYTES limit on the serialized (byte array) size of the payloads. This class will throw `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html`s if you try to serialize or deserialize past this limit.
## Summary
| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/work/Data.Builder` A builder for `https://developer.android.com/reference/kotlin/androidx/work/Data` objects. |
| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#MAX_DATA_BYTES()` The maximum number of bytes for Data when it is serialized (converted to a byte array). |
| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/Data` | `@https://developer.android.com/reference/kotlin/androidx/room/TypeConverter https://developer.android.com/reference/kotlin/androidx/work/Data#fromByteArray(kotlin.ByteArray)(bytes: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html)` Converts a byte array to `https://developer.android.com/reference/kotlin/androidx/work/Data`. |
| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/Data` | `https://developer.android.com/reference/kotlin/androidx/work/Data#EMPTY()` An empty Data object with no elements. |
| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/work/Data#Data(androidx.work.Data)(other: https://developer.android.com/reference/kotlin/androidx/work/Data)` Copy constructor |
| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getBoolean(kotlin.String,kotlin.Boolean)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Gets the boolean value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getBooleanArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the boolean array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getByte(kotlin.String,kotlin.Byte)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html)` Gets the byte value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getByteArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the byte array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getDouble(kotlin.String,kotlin.Double)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Gets the double value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getDoubleArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the double array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getFloat(kotlin.String,kotlin.Float)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)` Gets the float value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getFloatArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the float array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getInt(kotlin.String,kotlin.Int)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Gets the integer value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getIntArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the integer array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getLong(kotlin.String,kotlin.Long)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Gets the long value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getLongArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the long array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getNullableStringArray(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the string array value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/work/Data#getString(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Gets the String value for the given key. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html?` | `[getStringArray](https://developer.android.com/reference/kotlin/androidx/work/Data#getStringArray(kotlin.String))(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` **This function is deprecated.** Use getNullableStringArray(key) instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | ` https://developer.android.com/reference/kotlin/androidx/work/Data#hasKeyWithValueOfType(kotlin.String,java.lang.Class)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, klass: https://developer.android.com/reference/java/lang/Class.html)` Returns `true` if the instance of `https://developer.android.com/reference/kotlin/androidx/work/Data` has a non-null value corresponding to the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` key with the expected type of `T`. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#hashCode()()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#toByteArray()()` Converts this Data to a byte array suitable for sending to other processes in your application. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#toString()()` |
| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html` | `https://developer.android.com/reference/kotlin/androidx/work/Data#keyValueMap()` |
| ### Extension functions |
|---|---|
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | ` https://developer.android.com/reference/kotlin/androidx/work/Data.https://developer.android.com/reference/kotlin/androidx/work/Data#(androidx.work.Data).hasKeyWithValueOfType(kotlin.String)(key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns true if the instance of `https://developer.android.com/reference/kotlin/androidx/work/Data` has a value corresponding to the given `https://developer.android.com/reference/kotlin/androidx/work/package-summary#(androidx.work.Data).hasKeyWithValueOfType(kotlin.String)` with an expected type `https://developer.android.com/reference/kotlin/androidx/work/package-summary#(androidx.work.Data).hasKeyWithValueOfType(kotlin.String)`. |
## Constants
### MAX_DATA_BYTES
```
const val MAX_DATA_BYTES: Int
```
The maximum number of bytes for Data when it is serialized (converted to a byte array). Please see the class-level Javadoc for more information.
## Public companion functions
### fromByteArray
Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/work#2.10.0)
```
@TypeConverter
fun fromByteArray(bytes: ByteArray): Data
```
Converts a byte array to `https://developer.android.com/reference/kotlin/androidx/work/Data`.
| Parameters |
|---|---|
| `bytes: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` | The byte array representation to convert |
| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/work/Data` | An `https://developer.android.com/reference/kotlin/androidx/work/Data` object built from the input |
| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if bytes is bigger than .MAX_DATA_BYTES |
## Public companion properties
### EMPTY
```
val EMPTY: Data
```
An empty Data object with no elements.
## Public constructors
### Data
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
Data(other: Data)
```
Copy constructor
## Public functions
### equals
```
open operator fun equals(other: Any?): Boolean
```
### getBoolean
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getBoolean(key: String, defaultValue: Boolean): Boolean
```
Gets the boolean value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | The value specified by the key if it exists; the default value otherwise |
### getBooleanArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getBooleanArray(key: String): BooleanArray?
```
Gets the boolean array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getByte
Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/work#2.1.0)
```
fun getByte(key: String, defaultValue: Byte): Byte
```
Gets the byte value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html` | The value specified by the key if it exists; the default value otherwise |
### getByteArray
Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/work#2.1.0)
```
fun getByteArray(key: String): ByteArray?
```
Gets the byte array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getDouble
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getDouble(key: String, defaultValue: Double): Double
```
Gets the double value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | The value specified by the key if it exists; the default value otherwise |
### getDoubleArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getDoubleArray(key: String): DoubleArray?
```
Gets the double array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getFloat
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getFloat(key: String, defaultValue: Float): Float
```
Gets the float value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The value specified by the key if it exists; the default value otherwise |
### getFloatArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getFloatArray(key: String): FloatArray?
```
Gets the float array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getInt
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getInt(key: String, defaultValue: Int): Int
```
Gets the integer value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The value specified by the key if it exists; the default value otherwise |
### getIntArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getIntArray(key: String): IntArray?
```
Gets the integer array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getLong
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getLong(key: String, defaultValue: Long): Long
```
Gets the long value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The default value to return if the key is not found |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The value specified by the key if it exists; the default value otherwise |
### getLongArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getLongArray(key: String): LongArray?
```
Gets the long array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getNullableStringArray
Added in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)
```
fun getNullableStringArray(key: String): Array?
```
Gets the string array value for the given key. The array may contain `null` elements.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getString
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
fun getString(key: String): String?
```
Gets the String value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | The value specified by the key if it exists; `null` otherwise |
### getStringArray
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0) Deprecated in [2.12.0](https://developer.android.com/jetpack/androidx/releases/work#2.12.0)
```
fun [getStringArray](https://developer.android.com/reference/kotlin/androidx/work/Data#getStringArray(kotlin.String))(key: String): Array?
```
> [!CAUTION]
> **This function is deprecated.**
> Use getNullableStringArray(key) instead. This method does not correctly handle String arrays which may contain null elements, use this instead:
>
> ```kotlin
> getNullableStringArray(key)
> ```
Gets the String array value for the given key.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The key for the argument |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html?` | The value specified by the key if it exists; `null` otherwise |
### hasKeyWithValueOfType
Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/work#2.3.0)
```
fun hasKeyWithValueOfType(key: String, klass: Class): Boolean
```
Returns `true` if the instance of `https://developer.android.com/reference/kotlin/androidx/work/Data` has a non-null value corresponding to the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` key with the expected type of `T`.
| Parameters |
|---|---|
| `key: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` key |
| `klass: https://developer.android.com/reference/java/lang/Class.html` | The `https://developer.android.com/reference/java/lang/Class.html` container for the expected type |
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `true` If the instance of `https://developer.android.com/reference/kotlin/androidx/work/Data` has a value for the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` key with the expected type. |
### hashCode
```
open fun hashCode(): Int
```
### toByteArray
Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/work#2.3.0)
```
fun toByteArray(): ByteArray
```
Converts this Data to a byte array suitable for sending to other processes in your application. There are no versioning guarantees with this byte array, so you should not use this for IPCs between applications or persistence.
| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html` | The byte array representation of the input |
| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if the serialized payload is bigger than .MAX_DATA_BYTES |
### toString
```
open fun toString(): String
```
## Public properties
### keyValueMap
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/work#1.0.0)
```
val keyValueMap: Map
```
## Extension functions
### Data.hasKeyWithValueOfType
Artifact: [androidx.work:work-runtime](https://developer.android.com/jetpack/androidx/releases/work) [View Source](https://cs.android.com/search?q=file:androidx/work/Data.kt+function:hasKeyWithValueOfType)
```
inline fun Data.hasKeyWithValueOfType(key: String): Boolean
```
Returns true if the instance of `https://developer.android.com/reference/kotlin/androidx/work/Data` has a value corresponding to the given `https://developer.android.com/reference/kotlin/androidx/work/package-summary#(androidx.work.Data).hasKeyWithValueOfType(kotlin.String)` with an expected type `https://developer.android.com/reference/kotlin/androidx/work/package-summary#(androidx.work.Data).hasKeyWithValueOfType(kotlin.String)`.