Enum TextDecoration

java.lang.Object
java.lang.Enum<TextDecoration>
net.kyori.adventure.text.format.TextDecoration
All Implemented Interfaces:
Serializable, Comparable<TextDecoration>, java.lang.constant.Constable, ComponentBuilderApplicable, StyleBuilderApplicable, TextFormat

public enum TextDecoration
extends Enum<TextDecoration>
implements StyleBuilderApplicable, TextFormat
An enumeration of decorations which may be applied to a Component.
Since:
4.0.0
  • Enum Constant Details

    • OBFUSCATED

      public static final TextDecoration OBFUSCATED
      A decoration which makes text obfuscated/unreadable.
      Since:
      4.0.0
    • BOLD

      public static final TextDecoration BOLD
      A decoration which makes text appear bold.
      Since:
      4.0.0
    • STRIKETHROUGH

      public static final TextDecoration STRIKETHROUGH
      A decoration which makes text have a strike through it.
      Since:
      4.0.0
    • UNDERLINED

      public static final TextDecoration UNDERLINED
      A decoration which makes text have an underline.
      Since:
      4.0.0
    • ITALIC

      public static final TextDecoration ITALIC
      A decoration which makes text appear in italics.
      Since:
      4.0.0
  • Field Details

  • Method Details

    • values

      public static TextDecoration[] 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 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
    • styleApply

      public void styleApply​(@NonNull Style.Builder style)
      Description copied from interface: StyleBuilderApplicable
      Applies to style.
      Specified by:
      styleApply in interface StyleBuilderApplicable
      Parameters:
      style - the style builder
    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Enum<TextDecoration>