EnumValue.Known

classEnumValue.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 newKnown instance with the given property values.

open operatorBoolean
equals(other: Any?)

Compares this object with another object for equality.

openInt

Calculates and returns the hash code for this object.

openString

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

Public properties

openString

Enum.name ofvalue.

open T

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 newKnown 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 ofKnown whosevalue compares equal to this object'svalue using the== operator.

hashCode

open fun hashCode(): Int

Calculates and returns the hash code for this object.

The hash code isnot 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 isnot 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 ofvalue.

value

open val value: T

The enum value wrapped by this object.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-09 UTC.