Fzzy Config/me.fzzyhmstrs.fzzy_config.util/TriState

TriState

enum TriState : Enum<TriState> , TriStateProvider, EnumTranslatable, StringIdentifiable

Enum representing a three-state system: True, False, Default. This tri-state implements TriStateProvider, a generic representation of a three-state system.

In general, a DEFAULT should state should act as a "pass", refraining from altering state when possible.

Author

fzzyhmstrs

Since

0.6.5

Entries

DEFAULT

TRUE

FALSE

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<TriState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

asString

open override fun asString(): String

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

Override of descriptionKey that utilized the prefix and enum constant name

getAsBoolean

open override fun getAsBoolean(): Boolean

Gets the value of the tri-state. Implemented from BooleanSupplier.

getBoxed

open override fun getBoxed(): Boolean?

Gets the value of the tri-state as a boxed, nullable boolean.

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasPrefix

open override fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

orElse

open override fun orElse(value: Boolean): Boolean

Gets the value of this tri-state. If the value is DEFAULT then use the supplied value.

orElseGet

open override fun orElseGet(supplier: BooleanSupplier): Boolean

open override fun orElseGet(supplier: Supplier<Boolean>): Boolean

Gets the value of this tri-state. If the value is DEFAULT then use the supplied value.

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

open override fun prefix(): String

Defines the prefix of the translation/description key

prefixKey

open override fun prefixKey(): String

Override of descriptionKey that utilized the prefix and enum constant name

translation

open override fun translation(fallback: String?): MutableText

Override of translation that falls back to the enum constant name. Example "TEST"

translationKey

open override fun translationKey(): String

Override of translationKey that utilized the prefix and enum constant name

validate

open override fun validate(input: Boolean): Boolean

Validates a provided boolean input against the current tri-state.

valueOf

fun valueOf(value: String): TriState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TriState>

Returns an array containing the constants of this enum type, in the order they're declared.