api: add TextDecoration#withState

Fixes #431
KyoriPowered · Oct 31, 2021 · 5228cce · 5228cce
1 parent d2569b5
commit 5228cce
Showing 1 changed file with 24 additions and 2 deletions.
diff --git a/api/src/main/java/net/kyori/adventure/text/format/TextDecoration.java b/api/src/main/java/net/kyori/adventure/text/format/TextDecoration.java
@@ -78,7 +78,7 @@ public enum TextDecoration implements StyleBuilderApplicable, TextFormat {
   }
 
   /**
-   * Creates a {@link TextDecorationAndState}.
+   * Creates a {@link TextDecorationAndState}, annotating this decoration with the given {@code state}.
    *
    * @param state the state
    * @return a {@link TextDecorationAndState}
@@ -89,7 +89,7 @@ public enum TextDecoration implements StyleBuilderApplicable, TextFormat {
   }
 
   /**
-   * Creates a {@link TextDecorationAndState}.
+   * Creates a {@link TextDecorationAndState}, annotating this decoration with the given {@code state}.
    *
    * @param state the state
    * @return a {@link TextDecorationAndState}
@@ -99,6 +99,28 @@ public enum TextDecoration implements StyleBuilderApplicable, TextFormat {
     return new TextDecorationAndStateImpl(this, state);
   }
 
+  /**
+   * An alias for {@link #as(boolean)}.
+   *
+   * @param state the state
+   * @return a {@link TextDecorationAndState}
+   * @since 4.8.0
+   */
+  public final @NotNull TextDecorationAndState withState(final boolean state) {
+    return this.as(State.byBoolean(state));
+  }
+
+  /**
+   * An alias for {@link #as(State)}.
+   *
+   * @param state the state
+   * @return a {@link TextDecorationAndState}
+   * @since 4.8.0
+   */
+  public final @NotNull TextDecorationAndState withState(final @NotNull State state) {
+    return this.as(state);
+  }
+
   @Override
   public void styleApply(final Style.@NotNull Builder style) {
     style.decorate(this);