2.4.1

Author: isXander

build.gradle.kts

@@ -16,7 +16,7 @@ plugins {
 val ciRun = System.getenv().containsKey("GITHUB_ACTIONS")
 
 group = "dev.isxander"
-version = "2.4.0"
+version = "2.4.1"
 
 if (ciRun)
     version = "$version+${grgit.branch.current().name.replace('/', '.')}-SNAPSHOT"
@@ -192,6 +192,7 @@ publishing {
             artifactId = "yet-another-config-lib"
 
             from(components["java"])
+            artifact(tasks["remapSourcesJar"])
         }
     }
 

changelogs/2.4.1.md

@@ -0,0 +1,9 @@
+## Features
+
+- `OptionGroup.Builder` and `ConfigCategory.Builder` now extend `OptionAddable` so you can abstractly
+add options to either of them.
+
+## API Changes
+
+- Deprecated the varargs tooltip builder method in `Option.Builder` due to unsafe varargs. There is now
+  an equivalent that is not varargs but a single function.

src/client/java/dev/isxander/yacl/api/ConfigCategory.java

@@ -36,7 +36,7 @@ static Builder createBuilder() {
         return new ConfigCategoryImpl.BuilderImpl();
     }
 
-    interface Builder {
+    interface Builder extends OptionAddable {
         /**
          * Sets name of the category
          *
@@ -52,6 +52,7 @@ interface Builder {
          * @see ConfigCategory#groups()
          * @see OptionGroup#isRoot()
          */
+        @Override
         Builder option(@NotNull Option<?> option);
 
         /**
@@ -62,7 +63,8 @@ interface Builder {
          * @see ConfigCategory#groups()
          * @see OptionGroup#isRoot()
          */
-        Builder options(@NotNull Collection<Option<?>> options);
+        @Override
+        Builder options(@NotNull Collection<? extends Option<?>> options);
 
         /**
          * Adds an option group.

src/client/java/dev/isxander/yacl/api/Option.java

@@ -132,7 +132,15 @@ interface Builder<T> {
          *
          * @param tooltipGetter function to get tooltip depending on value {@link Builder#build()}.
          */
-        @SuppressWarnings("unchecked")
+        Builder<T> tooltip(@NotNull Function<T, Component> tooltipGetter);
+
+        /**
+         * Sets the tooltip to be used by the option.
+         * No need to wrap the text yourself, the gui does this itself.
+         *
+         * @param tooltipGetter function to get tooltip depending on value {@link Builder#build()}.
+         */
+        @Deprecated
         Builder<T> tooltip(@NotNull Function<T, Component>... tooltipGetter);
 
         /**

src/client/java/dev/isxander/yacl/api/OptionAddable.java

@@ -0,0 +1,19 @@
+package dev.isxander.yacl.api;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+
+public interface OptionAddable {
+    /**
+     * Adds an option to an abstract builder.
+     * To construct an option, use {@link Option#createBuilder(Class)}
+     */
+    OptionAddable option(@NotNull Option<?> option);
+
+    /**
+     * Adds multiple options to an abstract builder.
+     * To construct an option, use {@link Option#createBuilder(Class)}
+     */
+    OptionAddable options(@NotNull Collection<? extends Option<?>> options);
+}

src/client/java/dev/isxander/yacl/api/OptionGroup.java

@@ -47,7 +47,7 @@ static Builder createBuilder() {
         return new OptionGroupImpl.BuilderImpl();
     }
 
-    interface Builder {
+    interface Builder extends OptionAddable {
         /**
          * Sets name of the group, can be {@link Component#empty()} to just separate options, like sodium.
          *
@@ -70,6 +70,7 @@ interface Builder {
          *
          * @see OptionGroup#options()
          */
+        @Override
         Builder option(@NotNull Option<?> option);
 
         /**
@@ -78,6 +79,7 @@ interface Builder {
          *
          * @see OptionGroup#options()
          */
+        @Override
         Builder options(@NotNull Collection<? extends Option<?>> options);
 
         /**

src/client/java/dev/isxander/yacl/impl/ConfigCategoryImpl.java

@@ -74,7 +74,7 @@ public Builder option(@NotNull Option<?> option) {
         }
 
         @Override
-        public Builder options(@NotNull Collection<Option<?>> options) {
+        public Builder options(@NotNull Collection<? extends Option<?>> options) {
             Validate.notNull(options, "`options` must not be null");
 
             if (options.stream().anyMatch(ListOption.class::isInstance))

src/client/java/dev/isxander/yacl/impl/OptionImpl.java

@@ -175,8 +175,17 @@ public Option.Builder<T> name(@NotNull Component name) {
             return this;
         }
 
+        @Override
+        public Builder<T> tooltip(@NotNull Function<T, Component> tooltipGetter) {
+            Validate.notNull(tooltipGetter, "`tooltipGetter` cannot be null");
+
+            this.tooltipGetters.add(tooltipGetter);
+            return this;
+        }
+
         @Override
         @SafeVarargs
+        @Deprecated
         public final Option.Builder<T> tooltip(@NotNull Function<T, Component>... tooltipGetter) {
             Validate.notNull(tooltipGetter, "`tooltipGetter` cannot be null");