Remove BlockingSuggestionProvider.ConstantStrings (#605)

jpenilla · web-flow · commit 79f0599161d7 · 2023-12-29T00:32:38.000-08:00
diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/LiteralParser.java b/cloud-core/src/main/java/cloud/commandframework/arguments/LiteralParser.java
@@ -39,7 +39,7 @@
 import org.apiguardian.api.API;
 import org.checkerframework.checker.nullness.qual.NonNull;
 
-public final class LiteralParser<C> implements ArgumentParser<C, String>, BlockingSuggestionProvider.ConstantStrings<C> {
+public final class LiteralParser<C> implements ArgumentParser<C, String>, BlockingSuggestionProvider.Strings<C> {
 
     /**
      * Creates a new literal parser that accepts the given {@code name} and {@code aliases}.
@@ -90,7 +90,8 @@ private LiteralParser(final @NonNull String name, final @NonNull String... alias
     }
 
     @Override
-    public @NonNull Iterable<@NonNull String> stringSuggestions() {
+    public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                final @NonNull CommandInput input) {
         return Collections.singletonList(this.name);
     }
 
diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/standard/BooleanParser.java b/cloud-core/src/main/java/cloud/commandframework/arguments/standard/BooleanParser.java
@@ -41,7 +41,7 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 @API(status = API.Status.STABLE)
-public final class BooleanParser<C> implements ArgumentParser<C, Boolean>, BlockingSuggestionProvider.ConstantStrings<C> {
+public final class BooleanParser<C> implements ArgumentParser<C, Boolean>, BlockingSuggestionProvider.Strings<C> {
 
     private static final List<String> STRICT_LOWER = CommandInput.BOOLEAN_STRICT
             .stream().map(s -> s.toLowerCase(Locale.ROOT)).collect(Collectors.toList());
@@ -113,7 +113,8 @@ public BooleanParser(final boolean liberal) {
     }
 
     @Override
-    public @NonNull Iterable<@NonNull String> stringSuggestions() {
+    public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                final @NonNull CommandInput input) {
         if (!this.liberal) {
             return STRICT_LOWER;
         }
diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/standard/EnumParser.java b/cloud-core/src/main/java/cloud/commandframework/arguments/standard/EnumParser.java
@@ -43,7 +43,7 @@
 
 @API(status = API.Status.STABLE)
 public final class EnumParser<C, E extends Enum<E>> implements ArgumentParser<C, E>,
-        BlockingSuggestionProvider.ConstantStrings<C> {
+        BlockingSuggestionProvider.Strings<C> {
 
     /**
      * Creates a new enum parser.
@@ -112,7 +112,8 @@ public EnumParser(final @NonNull Class<E> enumClass) {
     }
 
     @Override
-    public @NonNull Iterable<@NonNull String> stringSuggestions() {
+    public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                final @NonNull CommandInput input) {
         return EnumSet.allOf(this.enumClass).stream().map(e -> e.name().toLowerCase(Locale.ROOT)).collect(Collectors.toList());
     }
 
diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/suggestion/BlockingSuggestionProvider.java b/cloud-core/src/main/java/cloud/commandframework/arguments/suggestion/BlockingSuggestionProvider.java
@@ -108,35 +108,4 @@ interface Strings<C> extends cloud.commandframework.arguments.suggestion.Blockin
                     .collect(Collectors.toList());
         }
     }
-
-    /**
-     * Specialized variant of {@link cloud.commandframework.arguments.suggestion.BlockingSuggestionProvider} that has {@link String} results
-     * instead of {@link Suggestion} results.
-     *
-     * <p>The provided default implementation of {@link #suggestions(CommandContext, CommandInput)}
-     * maps the {@link String} results to {@link Suggestion suggestions} using {@link Suggestion#simple(String)}.</p>
-     *
-     * @param <C> command sender type
-     */
-    @FunctionalInterface
-    @API(status = API.Status.STABLE, since = "2.0.0")
-    interface ConstantStrings<C> extends cloud.commandframework.arguments.suggestion.BlockingSuggestionProvider<C> {
-
-        /**
-         * Returns the suggestions for the given {@code input}.
-         *
-         * @return list of suggestions
-         */
-        @NonNull Iterable<@NonNull String> stringSuggestions();
-
-        @Override
-        default @NonNull Iterable<@NonNull Suggestion> suggestions(
-                final @NonNull CommandContext<C> context,
-                final @NonNull CommandInput input
-        ) {
-            return StreamSupport.stream(this.stringSuggestions().spliterator(), false)
-                    .map(Suggestion::simple)
-                    .collect(Collectors.toList());
-        }
-    }
 }
diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/EnchantmentParser.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/EnchantmentParser.java
@@ -42,7 +42,7 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 public final class EnchantmentParser<C> implements ArgumentParser<C, Enchantment>,
-        BlockingSuggestionProvider.ConstantStrings<C> {
+        BlockingSuggestionProvider.Strings<C> {
 
     /**
      * Creates a enchantment parser.
@@ -101,7 +101,8 @@ public final class EnchantmentParser<C> implements ArgumentParser<C, Enchantment
     }
 
     @Override
-    public @NonNull Iterable<@NonNull String> stringSuggestions() {
+    public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                final @NonNull CommandInput input) {
         final List<String> completions = new ArrayList<>();
         for (Enchantment value : Enchantment.values()) {
             if (value.getKey().getNamespace().equals(NamespacedKey.MINECRAFT)) {
diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/ItemStackParser.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/ItemStackParser.java
@@ -276,7 +276,7 @@ public boolean hasExtraData() {
     }
 
     private static final class LegacyParser<C> implements ArgumentParser.FutureArgumentParser<C, ProtoItemStack>,
-            BlockingSuggestionProvider.ConstantStrings<C> {
+            BlockingSuggestionProvider.Strings<C> {
 
         private final ArgumentParser<C, ProtoItemStack> parser = new MaterialParser<C>()
                 .mapSuccess((ctx, material) -> CompletableFuture.completedFuture(new LegacyProtoItemStack(material)));
@@ -290,7 +290,8 @@ private static final class LegacyParser<C> implements ArgumentParser.FutureArgum
         }
 
         @Override
-        public @NonNull Iterable<@NonNull String> stringSuggestions() {
+        public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                    final @NonNull CommandInput input) {
             return Arrays.stream(Material.values())
                     .filter(Material::isItem)
                     .map(value -> value.name().toLowerCase(Locale.ROOT))
diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/WorldParser.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/WorldParser.java
@@ -40,7 +40,7 @@
 import org.bukkit.World;
 import org.checkerframework.checker.nullness.qual.NonNull;
 
-public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingSuggestionProvider.ConstantStrings<C> {
+public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingSuggestionProvider.Strings<C> {
 
     /**
      * Creates a new world parser.
@@ -88,7 +88,8 @@ public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingS
     }
 
     @Override
-    public @NonNull Iterable<@NonNull String> stringSuggestions() {
+    public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,
+                                                                final @NonNull CommandInput input) {
         return Bukkit.getWorlds().stream().map(World::getName).collect(Collectors.toList());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`import org.apiguardian.api.API;`
`40`	`40`	`import org.checkerframework.checker.nullness.qual.NonNull;`
`41`	`41`
`42`		`-public final class LiteralParser<C> implements ArgumentParser<C, String>, BlockingSuggestionProvider.ConstantStrings<C> {`
	`42`	`+public final class LiteralParser<C> implements ArgumentParser<C, String>, BlockingSuggestionProvider.Strings<C> {`
`43`	`43`
`44`	`44`	`/**`
`45`	`45`	`* Creates a new literal parser that accepts the given {@code name} and {@code aliases}.`
`@@ -90,7 +90,8 @@ private LiteralParser(final @NonNull String name, final @NonNull String... alias`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`@Override`
`93`		`- public @NonNull Iterable<@NonNull String> stringSuggestions() {`
	`93`	`+ public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,`
	`94`	`+ final @NonNull CommandInput input) {`
`94`	`95`	`return Collections.singletonList(this.name);`
`95`	`96`	`}`
`96`	`97`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`
`44`	`44`	`@API(status = API.Status.STABLE)`
`45`	`45`	`public final class EnumParser<C, E extends Enum<E>> implements ArgumentParser<C, E>,`
`46`		`- BlockingSuggestionProvider.ConstantStrings<C> {`
	`46`	`+ BlockingSuggestionProvider.Strings<C> {`
`47`	`47`
`48`	`48`	`/**`
`49`	`49`	`* Creates a new enum parser.`
`@@ -112,7 +112,8 @@ public EnumParser(final @NonNull Class<E> enumClass) {`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`@Override`
`115`		`- public @NonNull Iterable<@NonNull String> stringSuggestions() {`
	`115`	`+ public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,`
	`116`	`+ final @NonNull CommandInput input) {`
`116`	`117`	`return EnumSet.allOf(this.enumClass).stream().map(e -> e.name().toLowerCase(Locale.ROOT)).collect(Collectors.toList());`
`117`	`118`	`}`
`118`	`119`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`import org.bukkit.World;`
`41`	`41`	`import org.checkerframework.checker.nullness.qual.NonNull;`
`42`	`42`
`43`		`-public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingSuggestionProvider.ConstantStrings<C> {`
	`43`	`+public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingSuggestionProvider.Strings<C> {`
`44`	`44`
`45`	`45`	`/**`
`46`	`46`	`* Creates a new world parser.`
`@@ -88,7 +88,8 @@ public final class WorldParser<C> implements ArgumentParser<C, World>, BlockingS`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`@Override`
`91`		`- public @NonNull Iterable<@NonNull String> stringSuggestions() {`
	`91`	`+ public @NonNull Iterable<@NonNull String> stringSuggestions(final @NonNull CommandContext<C> commandContext,`
	`92`	`+ final @NonNull CommandInput input) {`
`92`	`93`	`return Bukkit.getWorlds().stream().map(World::getName).collect(Collectors.toList());`
`93`	`94`	`}`
`94`	`95`