Create BuilderSupplier interface

jvalkeal · jvalkeal · commit f91b255bda85 · 2023-01-08T13:38:33.000Z
- Fixes #607
diff --git a/spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/CommandCatalogAutoConfiguration.java b/spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/CommandCatalogAutoConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2022 the original author or authors.
+ * Copyright 2021-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,6 @@
 package org.springframework.shell.boot;
 
 import java.util.List;
-import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.ObjectProvider;
@@ -29,6 +28,7 @@
 import org.springframework.shell.command.CommandCatalog;
 import org.springframework.shell.command.CommandCatalogCustomizer;
 import org.springframework.shell.command.CommandRegistration;
+import org.springframework.shell.command.CommandRegistration.BuilderSupplier;
 import org.springframework.shell.command.CommandResolver;
 
 @AutoConfiguration
@@ -76,7 +76,7 @@ public CommandRegistrationCustomizer helpOptionsCommandRegistrationCustomizer(Sp
 
 	@Bean
 	@ConditionalOnMissingBean
-	public Supplier<CommandRegistration.Builder> commandRegistrationBuilderSupplier(
+	public BuilderSupplier commandRegistrationBuilderSupplier(
 			ObjectProvider<CommandRegistrationCustomizer> customizerProvider) {
 		return () -> {
 			CommandRegistration.Builder builder = CommandRegistration.builder();
diff --git a/spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/StandardAPIAutoConfiguration.java b/spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/StandardAPIAutoConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,8 +16,6 @@
 
 package org.springframework.shell.boot;
 
-import java.util.function.Supplier;
-
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
@@ -55,7 +53,7 @@ public ValueProvider fileValueProvider() {
 
 	@Bean
 	public MethodTargetRegistrar standardMethodTargetResolver(ApplicationContext applicationContext,
-			Supplier<CommandRegistration.Builder> builder) {
+			CommandRegistration.BuilderSupplier builder) {
 		return new StandardMethodTargetRegistrar(applicationContext, builder);
 	}
 }
diff --git a/spring-shell-core/src/main/java/org/springframework/shell/command/CommandRegistration.java b/spring-shell-core/src/main/java/org/springframework/shell/command/CommandRegistration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -137,6 +137,14 @@ public static Builder builder() {
 		return new DefaultBuilder();
 	}
 
+	/**
+	 * Interface used to supply instance of a {@link Builder}. Meant to be a single
+	 * point access to centrally configured builder in an application context.
+	 */
+	@FunctionalInterface
+	public interface BuilderSupplier extends Supplier<Builder> {
+	}
+
 	/**
 	 * Spec defining an option.
 	 */
diff --git a/spring-shell-docs/src/main/asciidoc/using-shell-commands-programmaticmodel.adoc b/spring-shell-docs/src/main/asciidoc/using-shell-commands-programmaticmodel.adoc
@@ -12,7 +12,7 @@ include::{snippets}/CommandRegistrationBeanSnippets.java[tag=plain]
 ====
 
 If all your commands have something in common, an instance of
-a _Supplier<CommandRegistration.Builder>_ is created which can
+a _CommandRegistration.BuilderSupplier_ is created which can
 be autowired. Default implementation of this supplier returns
 a new builder so you don't need to worry about its internal state.
 
diff --git a/spring-shell-docs/src/test/java/org/springframework/shell/docs/CommandRegistrationBeanSnippets.java b/spring-shell-docs/src/test/java/org/springframework/shell/docs/CommandRegistrationBeanSnippets.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.docs;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.boot.CommandRegistrationCustomizer;
 import org.springframework.shell.command.CommandRegistration;
@@ -37,7 +35,7 @@ CommandRegistration commandRegistration() {
 	class Dump2 {
 		// tag::fromsupplier[]
 		@Bean
-		CommandRegistration commandRegistration(Supplier<CommandRegistration.Builder> builder) {
+		CommandRegistration commandRegistration(CommandRegistration.BuilderSupplier builder) {
 			return builder.get()
 				.command("mycommand")
 				.build();
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ArityCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ArityCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.command.CommandRegistration.OptionArity;
@@ -40,7 +38,7 @@ public String testBooleanArity1DefaultTrue(
 	}
 
 	@Bean
-	public CommandRegistration testBooleanArity1DefaultTrueRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testBooleanArity1DefaultTrueRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "boolean-arity1-default-true")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/DefaultValueCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/DefaultValueCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.standard.ShellComponent;
@@ -39,7 +37,7 @@ public String testDefaultValue(
 	}
 
 	@Bean
-	public CommandRegistration testDefaultValueRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testDefaultValueRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "default-value")
 			.group(GROUP)
@@ -64,7 +62,7 @@ public String testDefaultValueBoolean1(
 	}
 
 	@Bean
-	public CommandRegistration testDefaultValueBoolean1Registration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testDefaultValueBoolean1Registration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "default-value-boolean1")
 			.group(GROUP)
@@ -90,7 +88,7 @@ public String testDefaultValueBoolean2(
 	}
 
 	@Bean
-	public CommandRegistration testDefaultValueBoolean2Registration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testDefaultValueBoolean2Registration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "default-value-boolean2")
 			.group(GROUP)
@@ -116,7 +114,7 @@ public String testDefaultValueBoolean3(
 	}
 
 	@Bean
-	public CommandRegistration testDefaultValueBoolean3Registration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testDefaultValueBoolean3Registration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "default-value-boolean3")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ErrorHandlingCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ErrorHandlingCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 
 import java.io.IOException;
 import java.io.PrintWriter;
-import java.util.function.Supplier;
 
 import org.jline.terminal.Terminal;
 
@@ -87,7 +86,7 @@ void errorHandler3(CustomException4 e, Terminal terminal) {
 	}
 
 	@Bean
-	CommandRegistration testErrorHandlingRegistration(Supplier<CommandRegistration.Builder> builder) {
+	CommandRegistration testErrorHandlingRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "error-handling")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ExitCodeCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ExitCodeCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.standard.ShellComponent;
@@ -30,7 +28,7 @@
 public class ExitCodeCommands extends BaseE2ECommands {
 
 	@Bean
-	public CommandRegistration testExitCodeRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testExitCodeRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "exit-code")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/HelpOptionCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/HelpOptionCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
@@ -28,7 +26,7 @@
 public class HelpOptionCommands extends BaseE2ECommands {
 
 	@Autowired
-	Supplier<CommandRegistration.Builder> builder;
+	CommandRegistration.BuilderSupplier builder;
 
 	@ShellMethod(key = LEGACY_ANNO + "help-option-default", group = GROUP)
 	public String testHelpOptionDefault(
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/HiddenCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/HiddenCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.standard.ShellComponent;
@@ -25,7 +23,7 @@
 public class HiddenCommands extends BaseE2ECommands {
 
 	@Bean
-	public CommandRegistration testHidden1Registration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testHidden1Registration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "hidden-1")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/InteractiveCompletionCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/InteractiveCompletionCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 
 import java.util.Arrays;
 import java.util.List;
-import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 import org.springframework.context.annotation.Bean;
@@ -41,7 +40,7 @@ public String testInteractiveCompletion1(
 	}
 
 	@Bean
-	CommandRegistration testInteractiveCompletion1Registration(Supplier<CommandRegistration.Builder> builder) {
+	CommandRegistration testInteractiveCompletion1Registration(CommandRegistration.BuilderSupplier builder) {
 		Test1ValuesProvider test1ValuesProvider = new Test1ValuesProvider();
 		Test2ValuesProvider test2ValuesProvider = new Test2ValuesProvider();
 		return builder.get()
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/OptionTypeCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/OptionTypeCommands.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,6 @@
 package org.springframework.shell.samples.e2e;
 
 import java.io.PrintWriter;
-import java.util.function.Supplier;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
@@ -33,7 +32,7 @@
 public class OptionTypeCommands extends BaseE2ECommands {
 
 	@Bean
-	public CommandRegistration testOptionTypeRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testOptionTypeRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type")
 			.group(GROUP)
@@ -77,7 +76,7 @@ public String optionTypeStringAnnotation(
 	}
 
 	@Bean
-	public CommandRegistration optionTypeStringRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration optionTypeStringRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type-string")
 			.group(GROUP)
@@ -113,7 +112,7 @@ public String optionTypeBooleanAnnotation(
 	}
 
 	@Bean
-	public CommandRegistration optionTypeBooleanRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration optionTypeBooleanRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type-boolean")
 			.group(GROUP)
@@ -173,7 +172,7 @@ public String optionTypeIntegerAnnotation(
 	}
 
 	@Bean
-	public CommandRegistration optionTypeIntegerRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration optionTypeIntegerRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type-integer")
 			.group(GROUP)
@@ -213,7 +212,7 @@ public String optionTypeEnumAnnotation(
 	}
 
 	@Bean
-	public CommandRegistration optionTypeEnumRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration optionTypeEnumRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type-enum")
 			.group(GROUP)
@@ -236,7 +235,7 @@ public CommandRegistration optionTypeEnumRegistration(Supplier<CommandRegistrati
 	//
 
 	@Bean
-	public CommandRegistration optionTypeVoidRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration optionTypeVoidRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "option-type-void")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/OptionalValueCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/OptionalValueCommands.java
@@ -15,8 +15,6 @@
  */
 package org.springframework.shell.samples.e2e;
 
-import java.util.function.Supplier;
-
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.command.CommandRegistration;
 import org.springframework.shell.standard.ShellComponent;
@@ -39,7 +37,7 @@ public String testOptionalValue(
 	}
 
 	@Bean
-	public CommandRegistration testOptionalValueRegistration(Supplier<CommandRegistration.Builder> builder) {
+	public CommandRegistration testOptionalValueRegistration(CommandRegistration.BuilderSupplier builder) {
 		return builder.get()
 			.command(REG, "optional-value")
 			.group(GROUP)
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/RequiredValueCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/RequiredValueCommands.java
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/UnrecognisedOptionCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/UnrecognisedOptionCommands.java
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ValidatedValueCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/ValidatedValueCommands.java
diff --git a/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/WriteCommands.java b/spring-shell-samples/src/main/java/org/springframework/shell/samples/e2e/WriteCommands.java
diff --git a/spring-shell-standard/src/main/java/org/springframework/shell/standard/StandardMethodTargetRegistrar.java b/spring-shell-standard/src/main/java/org/springframework/shell/standard/StandardMethodTargetRegistrar.java
diff --git a/spring-shell-standard/src/test/java/org/springframework/shell/standard/StandardMethodTargetRegistrarTests.java b/spring-shell-standard/src/test/java/org/springframework/shell/standard/StandardMethodTargetRegistrarTests.java
