IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

EnumValue.Known

class EnumValue.Known<T : Enum<T>> : EnumValue

Represents a known enum value.

Summary

Public constructors
`<T : Enum<T>> Known(value: T)`

Public functions
`EnumValue.Known<T>`	`copy(value: T)` Creates and returns a new `Known` instance with the given property values.
`open operator Boolean`	`equals(other: Any?)` Compares this object with another object for equality.
`open Int`	`hashCode()` Calculates and returns the hash code for this object.
`open String`	`toString()` Returns a string representation of this object, useful for debugging.

Public properties
`open String`	`stringValue` `Enum.name` of `value`.
`open T`	`value` The enum value wrapped by this object.

Public constructors

Known

<T : Enum<T>> Known(value: T)

Parameters
`value: T`	The enum value.

Public functions

copy

fun copy(value: T = this.value): EnumValue.Known<T>

Creates and returns a new Known instance with the given property values.

equals

open operator fun equals(other: Any?): Boolean

Compares this object with another object for equality.

Parameters
`other: Any?`	The object to compare to this for equality.

Returns
`Boolean`	true if, and only if, the other object is an instance of `Known` whose `value` compares equal to this object's `value` using the `==` operator.

hashCode

open fun hashCode(): Int

Calculates and returns the hash code for this object.

The hash code is not guaranteed to be stable across application restarts.

Returns
`Int`	the hash code for this object, that incorporates the values of this object's public properties.

toString

open fun toString(): String

Returns a string representation of this object, useful for debugging.

The string representation is not guaranteed to be stable and may change without notice at any time. Therefore, the only recommended usage of the returned string is debugging and/or logging. Namely, parsing the returned string or storing the returned string in non-volatile storage should generally be avoided in order to be robust in case that the string representation changes.

Public properties

stringValue

open val stringValue: String

Enum.name of value.

value

open val value: T

The enum value wrapped by this object.