Builder
class Builder
kotlin.Any | |
↳ | androidx.work.Data.Builder |
A builder for Data
objects.
Summary
Public constructors | |
---|---|
<init>() A builder for |
Public methods | |
---|---|
Data |
build() Builds a |
Data.Builder |
Puts all input key-value pairs from a |
Data.Builder |
putAll(@NonNull values: MutableMap<String!, Any!>) Puts all input key-value pairs from a |
Data.Builder |
putBoolean(@NonNull key: String, value: Boolean) Puts a boolean into the arguments. |
Data.Builder |
putBooleanArray(@NonNull key: String, @NonNull value: BooleanArray) Puts a boolean array into the arguments. |
Data.Builder |
Puts an byte into the arguments. |
Data.Builder |
putByteArray(@NonNull key: String, @NonNull value: ByteArray) Puts an integer array into the arguments. |
Data.Builder |
Puts a double into the arguments. |
Data.Builder |
putDoubleArray(@NonNull key: String, @NonNull value: DoubleArray) Puts a double array into the arguments. |
Data.Builder |
Puts a float into the arguments. |
Data.Builder |
putFloatArray(@NonNull key: String, @NonNull value: FloatArray) Puts a float array into the arguments. |
Data.Builder |
Puts an integer into the arguments. |
Data.Builder |
putIntArray(@NonNull key: String, @NonNull value: IntArray) Puts an integer array into the arguments. |
Data.Builder |
Puts a long into the arguments. |
Data.Builder |
putLongArray(@NonNull key: String, @NonNull value: LongArray) Puts a long array into the arguments. |
Data.Builder |
Puts a String into the arguments. |
Data.Builder |
putStringArray(@NonNull key: String, @NonNull value: Array<String!>) Puts a String array into the arguments. |
Public constructors
Public methods
build
@NonNull fun build(): Data
Builds a Data
object.
Return | |
---|---|
Data |
The Data object containing all key-value pairs specified by this Builder . |
putAll
@NonNull fun putAll(@NonNull data: Data): Data.Builder
Puts all input key-value pairs from a Data
into the Builder.
Valid value types are: Boolean, Integer, Long, Float, Double, String, and their array versions. Invalid types will throw an IllegalArgumentException
.
Parameters | |
---|---|
data |
Data: Data containing key-value pairs to add |
Return | |
---|---|
Data.Builder |
The Builder |
putAll
@NonNull fun putAll(@NonNull values: MutableMap<String!, Any!>): Data.Builder
Puts all input key-value pairs from a Map
into the Builder.
Valid value types are: Boolean, Integer, Long, Float, Double, String, and their array versions. Invalid types will throw an IllegalArgumentException
.
Parameters | |
---|---|
values |
MutableMap<String!, Any!>: A Map of key-value pairs to add |
Return | |
---|---|
Data.Builder |
The Builder |
putBoolean
@NonNull fun putBoolean(
@NonNull key: String,
value: Boolean
): Data.Builder
Puts a boolean into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
Boolean: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putBooleanArray
@NonNull fun putBooleanArray(
@NonNull key: String,
@NonNull value: BooleanArray
): Data.Builder
Puts a boolean array into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
BooleanArray: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putByte
@NonNull fun putByte(
@NonNull key: String,
value: Byte
): Data.Builder
Puts an byte into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
Byte: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putByteArray
@NonNull fun putByteArray(
@NonNull key: String,
@NonNull value: ByteArray
): Data.Builder
Puts an integer array into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
ByteArray: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putDouble
@NonNull fun putDouble(
@NonNull key: String,
value: Double
): Data.Builder
Puts a double into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
Double: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putDoubleArray
@NonNull fun putDoubleArray(
@NonNull key: String,
@NonNull value: DoubleArray
): Data.Builder
Puts a double array into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
DoubleArray: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putFloat
@NonNull fun putFloat(
@NonNull key: String,
value: Float
): Data.Builder
Puts a float into the arguments.
Parameters | |
---|---|
key |
String: The key for this argument |
value |
Float: The value for this argument |
Return | |
---|---|
Data.Builder |
The Builder |
putFloatArray
@NonNull fun putFloatArray(
@NonNull