Package net.kyori.adventure.text.format

Enum TextDecoration.State

java.lang.Object
java.lang.Enum<TextDecoration.State>
net.kyori.adventure.text.format.TextDecoration.State
All Implemented Interfaces:
Serializable, Comparable<TextDecoration.State>
Enclosing class:
TextDecoration
public static enum TextDecoration.State extends Enum<TextDecoration.State>
A state that a TextDecoration can be in.
Since:
4.0.0

  • Enum Constant Details

    • NOT_SET

      public static final TextDecoration.State NOT_SET
      State describing the absence of a value.
      Since:
      4.0.0

    • FALSE

      public static final TextDecoration.State FALSE
      State describing a false value.
      Since:
      4.0.0

    • TRUE

      public static final TextDecoration.State TRUE
      State describing a true value.
      Since:
      4.0.0

  • Method Details

    • values

      public static TextDecoration.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static TextDecoration.State valueOf(String name)
      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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<TextDecoration.State>

    • byBoolean

      @NotNull public static @NotNull TextDecoration.State byBoolean(boolean flag)
      Gets a state from a boolean.
      Parameters:
      flag - the boolean
      Returns:
      the state
      Since:
      4.0.0

    • byBoolean

      @NotNull public static @NotNull TextDecoration.State byBoolean(@Nullable @Nullable Boolean flag)
      Gets a state from a Boolean.
      Parameters:
      flag - the boolean
      Returns:
      the state
      Since:
      4.0.0

    • byTriState

      @NotNull public static @NotNull TextDecoration.State byTriState(@NotNull @NotNull TriState flag)
      Gets a state from a TriState.
      Parameters:
      flag - the tristate
      Returns:
      the state
      Since:
      4.10.0