Fetch upstream

.checkstyle/checkstyle.xml

@@ -42,7 +42,7 @@
     <!-- https://checkstyle.org/config_javadoc.html#AtclauseOrder -->
     <module name="AtclauseOrder">
       <property name="violateExecutionOnNonTightHtml" value="true"/>
-      <property name="tagOrder" value="@author, @deprecated, @exception, @param, @return, @serial, @serialData, @serialField, @throws, @see, @since, @sinceMinecraft, @version"/>
+      <property name="tagOrder" value="@author, @exception, @param, @return, @serial, @serialData, @serialField, @throws, @see, @since, @sinceMinecraft, @version, @deprecated"/>
     </module>
 
     <!-- https://checkstyle.org/config_imports.html#AvoidStarImport -->
@@ -245,9 +245,6 @@
     <!-- https://checkstyle.org/config_whitespace.html#TypecastParenPad -->
     <module name="TypecastParenPad"/>
 
-    <!-- https://checkstyle.org/config_coding.html#UnnecessaryParentheses -->
-    <module name="UnnecessaryParentheses"/>
-
     <!-- https://checkstyle.org/config_imports.html#UnusedImports -->
     <module name="UnusedImports"/>
 

.checkstyle/suppressions.xml

@@ -4,10 +4,10 @@
   <!-- let me be excited, checkstyle! -->
   <suppress files="api[\\/]src[\\/]main[\\/]java[\\/]net[\\/]kyori[\\/]adventure[\\/]Adventure.java" checks="SummaryJavadoc"/>
 
-  <!-- no javadoc on test classes -->
-  <suppress files="src[\\/](test|jmh)[\\/]java[\\/].*" checks="FilteringWriteTag"/>
-  <suppress files="src[\\/](test|jmh)[\\/]java[\\/].*" checks="JavadocPackage"/>
-  <suppress files="src[\\/](test|jmh)[\\/]java[\\/].*" checks="MissingJavadoc.*"/>
+  <!-- no javadoc on test and internal classes -->
+  <suppress files="src[\\/](test|jmh)[\\/]java[\\/].*" checks="(FilteringWriteTag|JavadocPackage|MissingJavadoc.*)"/>
+  <suppress files="api[\\/]src[\\/]main[\\/]java[\\/]net[\\/]kyori[\\/]adventure[\\/]internal[\\/].*" checks="(FilteringWriteTag|JavadocPackage|MissingJavadoc.*)"/>
+  <suppress files="minimessage[\\/]src[\\/]main[\\/]java[\\/]net[\\/]kyori[\\/]adventure[\\/]text[\\/]minimessage[\\/]parser[\\/].*" checks="(FilteringWriteTag|JavadocPackage|MissingJavadoc.*)"/>
 
   <suppress files=".*[\\/]nbt[\\/](List|Compound)BinaryTag.java" checks="MethodName"/>
 </suppressions>

.github/workflows/build.yml

@@ -1,6 +1,17 @@
 name: "build"
 
-on: ["pull_request", "push"]
+on:
+  push:
+    branches: "**"
+    tags-ignore: ["**"]
+  pull_request:
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.event.number || github.ref }}"
+  cancel-in-progress: true
+
+env:
+  RUNTIME_VERSION: 11
 
 jobs:
   build:
@@ -13,17 +24,21 @@ jobs:
     steps:
       - name: "checkout repository"
         uses: "actions/checkout@v2"
-      - name: "setup jdk 11"
-        uses: "actions/setup-java@v1"
+      - name: "setup jdk ${{ env.RUNTIME_VERSION }}"
+        uses: "actions/setup-java@v2"
+        with:
+          distribution: "temurin"
+          java-version: "${{ env.RUNTIME_VERSION }}"
+      - name: "run gradle build"
+        uses: "gradle/gradle-build-action@v2"
         with:
-          java-version: "11"
-      - name: "build"
-        run: "./gradlew build"
+          cache-read-only: "${{ !startsWith(github.ref, 'refs/heads/main/') || github.event_name == 'pull_request' }}"
+          arguments: "build"
       - name: "Archive test results"
         if: "${{ always() }}"
         uses: "actions/upload-artifact@v2"
         with:
-          name: "test-results"
+          name: "${{ runner.os }}-test-results"
           path: |
             build/reports/
             */build/reports/
@@ -36,7 +51,7 @@ jobs:
             echo "STATUS=release" >> $GITHUB_ENV
           fi
       - name: "publish"
-        if: "${{ runner.os == 'Linux' && env.STATUS != 'release' && github.event_name == 'push' && github.ref == 'refs/heads/master' }}"
+        if: "${{ runner.os == 'Linux' && env.STATUS != 'release' && github.event_name == 'push' && startsWith(github.ref, 'refs/heads/main/') }}"
         run: "./gradlew publish"
         env:
           ORG_GRADLE_PROJECT_sonatypeUsername: "${{ secrets.SONATYPE_USERNAME }}"

api/src/main/java/net/kyori/adventure/bossbar/BossBar.java

@@ -68,17 +68,17 @@ public interface BossBar extends Examinable {
   /**
    * The minimum value the progress can be.
    *
-   * @deprecated for removal since 4.2.0, use {@link #MIN_PROGRESS}
    * @since 4.0.0
+   * @deprecated for removal since 4.2.0, use {@link #MIN_PROGRESS}
    */
   @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
   @Deprecated
   float MIN_PERCENT = MIN_PROGRESS;
   /**
    * The maximum value the progress can be.
    *
-   * @deprecated for removal since 4.2.0, use {@link #MAX_PROGRESS}
    * @since 4.0.0
+   * @deprecated for removal since 4.2.0, use {@link #MAX_PROGRESS}
    */
   @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
   @Deprecated
@@ -209,8 +209,8 @@ public interface BossBar extends Examinable {
    * <p>The progress is a value between 0 and 1.</p>
    *
    * @return the progress
-   * @deprecated for removal since 4.2.0, use {@link #progress()}
    * @since 4.0.0
+   * @deprecated for removal since 4.2.0, use {@link #progress()}
    */
   @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
   @Deprecated
@@ -226,8 +226,8 @@ default float percent() {
    * @param progress the progress
    * @return the bossbar
    * @throws IllegalArgumentException if progress is less than 0 or greater than 1
-   * @deprecated for removal since 4.2.0, use {@link #progress(float)}
    * @since 4.0.0
+   * @deprecated for removal since 4.2.0, use {@link #progress(float)}
    */
   @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
   @Contract("_ -> this")
@@ -415,8 +415,8 @@ default void bossBarProgressChanged(final @NotNull BossBar bar, final float oldP
      * @param bar the bossbar
      * @param oldProgress the old progress
      * @param newProgress the new progress
-     * @deprecated for removal since 4.2.0, use {@link #bossBarProgressChanged(BossBar, float, float)}
      * @since 4.0.0
+     * @deprecated for removal since 4.2.0, use {@link #bossBarProgressChanged(BossBar, float, float)}
      */
     @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
     @Deprecated

api/src/main/java/net/kyori/adventure/bossbar/BossBarImpl.java

@@ -33,9 +33,9 @@
 import java.util.function.BiPredicate;
 import java.util.function.Consumer;
 import java.util.stream.Stream;
+import net.kyori.adventure.internal.Internals;
 import net.kyori.adventure.text.Component;
 import net.kyori.examination.ExaminableProperty;
-import net.kyori.examination.string.StringExaminer;
 import org.jetbrains.annotations.NotNull;
 
 import static java.util.Objects.requireNonNull;
@@ -262,6 +262,6 @@ private void forEachListener(final @NotNull Consumer<Listener> consumer) {
 
   @Override
   public String toString() {
-    return this.examine(StringExaminer.simpleEscaping());
+    return Internals.toString(this);
   }
 }

api/src/main/java/net/kyori/adventure/identity/IdentityImpl.java

@@ -24,8 +24,8 @@
 package net.kyori.adventure.identity;
 
 import java.util.UUID;
+import net.kyori.adventure.internal.Internals;
 import net.kyori.examination.Examinable;
-import net.kyori.examination.string.StringExaminer;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -43,7 +43,7 @@ final class IdentityImpl implements Examinable, Identity {
 
   @Override
   public String toString() {
-    return this.examine(StringExaminer.simpleEscaping());
+    return Internals.toString(this);
   }
 
   @Override

api/src/main/java/net/kyori/adventure/internal/Internals.java

@@ -0,0 +1,49 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2022 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package net.kyori.adventure.internal;
+
+import net.kyori.examination.Examinable;
+import net.kyori.examination.string.StringExaminer;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Utilities internal to Adventure.
+ */
+@ApiStatus.Internal
+public final class Internals {
+  private Internals() {
+  }
+
+  /**
+   * Examines an {@link Examinable} using the {@link StringExaminer}.
+   *
+   * @param examinable the examinable
+   * @return the result from examining
+   * @since 4.10.0
+   */
+  public static @NotNull String toString(final @NotNull Examinable examinable) {
+    return examinable.examine(StringExaminer.simpleEscaping());
+  }
+}

text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/transformation/package-info.java → api/src/main/java/net/kyori/adventure/internal/package-info.java

@@ -22,6 +22,7 @@
  * SOFTWARE.
  */
 /**
- * Transformations.
+ * Internal things, not for public use.
  */
-package net.kyori.adventure.text.minimessage.transformation;
+@org.jetbrains.annotations.ApiStatus.Internal
+package net.kyori.adventure.internal;

api/src/main/java/net/kyori/adventure/internal/properties/AdventureProperties.java

@@ -0,0 +1,97 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2022 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package net.kyori.adventure.internal.properties;
+
+import java.util.function.Function;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Adventure properties.
+ *
+ * @since 4.10.0
+ */
+@ApiStatus.Internal
+public final class AdventureProperties {
+  /**
+   * Property for specifying whether debug mode is enabled.
+   *
+   * @since 4.10.0
+   */
+  public static final Property<Boolean> DEBUG = property("debug", Boolean::parseBoolean, false);
+  /**
+   * Property for specifying the default translation locale.
+   *
+   * @since 4.10.0
+   */
+  public static final Property<String> DEFAULT_TRANSLATION_LOCALE = property("defaultTranslationLocale", Function.identity(), null);
+  /**
+   * Property for specifying whether service load failures are fatal.
+   *
+   * @since 4.10.0
+   */
+  public static final Property<Boolean> SERVICE_LOAD_FAILURES_ARE_FATAL = property("serviceLoadFailuresAreFatal", Boolean::parseBoolean, Boolean.TRUE);
+  /**
+   * Property for specifying whether to warn when legacy formatting is detected.
+   *
+   * @since 4.10.0
+   */
+  public static final Property<Boolean> TEXT_WARN_WHEN_LEGACY_FORMATTING_DETECTED = property("text.warnWhenLegacyFormattingDetected", Boolean::parseBoolean, Boolean.FALSE);
+
+  private AdventureProperties() {
+  }
+
+  /**
+   * Creates a new property.
+   *
+   * @param name the property name
+   * @param parser the value parser
+   * @param defaultValue the default value
+   * @param <T> the value type
+   * @return a property
+   * @since 4.10.0
+   */
+  public static <T> @NotNull Property<T> property(final @NotNull String name, final @NotNull Function<String, T> parser, final @Nullable T defaultValue) {
+    return AdventurePropertiesImpl.property(name, parser, defaultValue);
+  }
+
+  /**
+   * A property.
+   *
+   * @param <T> the value type
+   * @since 4.10.0
+   */
+  @ApiStatus.Internal
+  @ApiStatus.NonExtendable
+  public interface Property<T> {
+    /**
+     * Gets the value.
+     *
+     * @return the value
+     * @since 4.10.0
+     */
+    @Nullable T value();
+  }
+}