Polish DynamicPropertyRegistrar documentation

spring-projects · Sep 12, 2024 · d097eea · d097eea
1 parent 398e552
commit d097eea
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/...ages/testing/testcontext-framework/ctx-management/dynamic-property-sources.adoc b/...ages/testing/testcontext-framework/ctx-management/dynamic-property-sources.adoc
@@ -162,7 +162,7 @@ Java::
 		}
 
 		@Bean
-		DynamicPropertyRegistrar apiServerProperties(ApiServer apiServer) {
+		DynamicPropertyRegistrar apiPropertiesRegistrar(ApiServer apiServer) {
 			return registry -> registry.add("api.url", apiServer::getUrl);
 		}
 	}
@@ -181,7 +181,7 @@ Kotlin::
 		}
 
 		@Bean
-		fun apiServerProperties(apiServer: ApiServer): DynamicPropertyRegistrar {
+		fun apiPropertiesRegistrar(apiServer: ApiServer): DynamicPropertyRegistrar {
 			return registry -> registry.add("api.url", apiServer::getUrl)
 		}
 	}

diff --git a/spring-test/src/main/java/org/springframework/test/context/DynamicPropertyRegistrar.java b/spring-test/src/main/java/org/springframework/test/context/DynamicPropertyRegistrar.java
@@ -67,7 +67,7 @@
  *     }
  *
  *     &#064;Bean
- *     DynamicPropertyRegistrar apiServerProperties(ApiServer apiServer) {
+ *     DynamicPropertyRegistrar apiPropertiesRegistrar(ApiServer apiServer) {
  *         return registry -> registry.add("api.url", apiServer::getUrl);
  *     }
  *
@@ -82,6 +82,9 @@
 @FunctionalInterface
 public interface DynamicPropertyRegistrar {
 
+	/**
+	 * Register dynamic properties in the supplied registry.
+	 */
 	void accept(DynamicPropertyRegistry registry);
 
 }
diff --git a/.../test/java/org/springframework/test/context/DynamicPropertyRegistrarIntegrationTests.java b/.../test/java/org/springframework/test/context/DynamicPropertyRegistrarIntegrationTests.java
@@ -117,12 +117,12 @@ ApiServer apiServer() {
 		// context which further ensures that the dynamic "api.url" property is
 		// available to all standard singleton beans.
 		@Bean
-		DynamicPropertyRegistrar apiServerProperties1(ApiServer apiServer) {
+		DynamicPropertyRegistrar apiPropertiesRegistrar1(ApiServer apiServer) {
 			return registry -> registry.add(API_URL_1, () -> apiServer.getUrl() + "/1");
 		}
 
 		@Bean
-		DynamicPropertyRegistrar apiServerProperties2(ApiServer apiServer) {
+		DynamicPropertyRegistrar apiPropertiesRegistrar2(ApiServer apiServer) {
 			return registry -> registry.add(API_URL_2, () -> apiServer.getUrl() + "/2");
 		}
 

diff --git a/...src/test/java/org/springframework/test/context/DynamicPropertySourceIntegrationTests.java b/...src/test/java/org/springframework/test/context/DynamicPropertySourceIntegrationTests.java
@@ -112,7 +112,7 @@ void serviceHasInjectedValues(@Autowired Service service) {
 	static class Config {
 
 		@Bean
-		DynamicPropertyRegistrar magicWordProperties() {
+		DynamicPropertyRegistrar magicPropertiesRegistrar() {
 			return registry -> registry.add(MAGIC_WORD, () -> "enigma");
 		}