DynamicBuilders.DynamicBool

Artifact: androidx.wear.protolayout:protolayout-expression

Added in 1.0.0

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 200)
interface DynamicBuilders.DynamicBool : DynamicBuilders.DynamicType

Interface defining a dynamic boolean type.

Summary

Public functions
`DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) and(input: DynamicBuilders.DynamicBool)` Returns a `DynamicBool` that is true if this `DynamicBool` and `input` are both true, otherwise it is false. i.e. `boolean result = this && input`
`java-static DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) constant(constant: Boolean)` Creates a constant-valued `DynamicBool`.
`DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) eq(other: DynamicBuilders.DynamicBool)` Returns a `DynamicBool` that is true if the value of this `DynamicBool` and `other` are equal, otherwise it's false.
`java-static DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) from(dynamicDataKey: DynamicDataKey<DynamicBuilders.DynamicBool!>)` Creates a `DynamicBool` that is bound to the value of an item of the State.
`java-static DynamicBuilders.DynamicBool`	`fromByteArray(byteArray: ByteArray)` Creates a `DynamicBool` from a byte array generated by `toDynamicBoolByteArray`.
`java-static DynamicBuilders.DynamicBool`	`fromByteArray(byteArray: ByteArray, offset: Int, length: Int)` Creates a `DynamicBool` from the provided byte array at the provided offset and length, that was generated by one of the toDynamicBoolByteArray overloads.
`DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) ne(other: DynamicBuilders.DynamicBool)` Returns a `DynamicBool` that is true if the value of this `DynamicBool` and `other` are not equal, otherwise it's false.
`DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) negate()` Returns a `DynamicBool` that has the opposite value of this `DynamicBool`. i.e. {code result = !this}
`DynamicBuilders.DynamicBool`	`@RequiresSchemaVersion(major = 1, minor = 200) or(input: DynamicBuilders.DynamicBool)` Returns a `DynamicBool` that is true if this `DynamicBool` or `input` are true, otherwise it is false. i.e. `boolean result = this \|\| input`
`ByteArray<Byte>`	`toDynamicBoolByteArray()` Serializes the `DynamicBool` into a new byte array that can later be used with `fromByteArray`.
`Int`	`toDynamicBoolByteArray(byteArray: ByteArray)` Serializes the `DynamicBool` into the provided byte array, returning the amount of bytes written, that can later be used with `DynamicBool.fromByteArray(byteArray, 0, bytesWritten)`.
`Int`	`toDynamicBoolByteArray(byteArray: ByteArray, offset: Int, length: Int)` Serializes the `DynamicBool` into the provided byte array, returning the amount of bytes written, limited by the provided offset and length, that can later be used with `DynamicBool.fromByteArray(byteArray, offset, bytesWritten)`.

Public functions

and

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
fun and(input: DynamicBuilders.DynamicBool): DynamicBuilders.DynamicBool

Returns a DynamicBool that is true if this DynamicBool and input are both true, otherwise it is false. i.e. boolean result = this && input

Parameters
`input: DynamicBuilders.DynamicBool`	The right hand operand of the "and" operation.

constant

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
java-static fun constant(constant: Boolean): DynamicBuilders.DynamicBool

Creates a constant-valued DynamicBool.

eq

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
fun eq(other: DynamicBuilders.DynamicBool): DynamicBuilders.DynamicBool

Returns a DynamicBool that is true if the value of this DynamicBool and other are equal, otherwise it's false.

from

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
java-static fun from(dynamicDataKey: DynamicDataKey<DynamicBuilders.DynamicBool!>): DynamicBuilders.DynamicBool

Creates a DynamicBool that is bound to the value of an item of the State.

Parameters
`dynamicDataKey: DynamicDataKey<DynamicBuilders.DynamicBool!>`	The key to a `DynamicDataValue` with a boolean value.

fromByteArray

Added in 1.0.0

java-static fun fromByteArray(byteArray: ByteArray): DynamicBuilders.DynamicBool

Creates a DynamicBool from a byte array generated by toDynamicBoolByteArray.

Throws
`java.lang.IllegalArgumentException`	if the byte array does not contain a valid serialization

fromByteArray

Added in 1.0.0

java-static fun fromByteArray(byteArray: ByteArray, offset: Int, length: Int): DynamicBuilders.DynamicBool

Creates a DynamicBool from the provided byte array at the provided offset and length, that was generated by one of the toDynamicBoolByteArray overloads.

Throws
`java.lang.IllegalArgumentException`	if the byte array does not contain a valid serialization in the provided offset and length

ne

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
fun ne(other: DynamicBuilders.DynamicBool): DynamicBuilders.DynamicBool

Returns a DynamicBool that is true if the value of this DynamicBool and other are not equal, otherwise it's false.

negate

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
fun negate(): DynamicBuilders.DynamicBool

Returns a DynamicBool that has the opposite value of this DynamicBool. i.e. {code result = !this}

or

Added in 1.0.0

@RequiresSchemaVersion(major = 1, minor = 200)
fun or(input: DynamicBuilders.DynamicBool): DynamicBuilders.DynamicBool

Returns a DynamicBool that is true if this DynamicBool or input are true, otherwise it is false. i.e. boolean result = this || input

Parameters
`input: DynamicBuilders.DynamicBool`	The right hand operand of the "or" operation.

toDynamicBoolByteArray

Added in 1.0.0

fun toDynamicBoolByteArray(): ByteArray<Byte>

Serializes the DynamicBool into a new byte array that can later be used with fromByteArray.

toDynamicBoolByteArray

Added in 1.0.0

fun toDynamicBoolByteArray(byteArray: ByteArray): Int

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, that can later be used with DynamicBool.fromByteArray(byteArray, 0, bytesWritten).

Throws
`java.lang.IllegalArgumentException`	if the byte array is too small

toDynamicBoolByteArray

Added in 1.0.0

fun toDynamicBoolByteArray(byteArray: ByteArray, offset: Int, length: Int): Int

Serializes the DynamicBool into the provided byte array, returning the amount of bytes written, limited by the provided offset and length, that can later be used with DynamicBool.fromByteArray(byteArray, offset, bytesWritten).

Throws
`java.lang.IllegalArgumentException`	if the byte array is too small