Polishing

Author: sbrannen

spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHints.java

@@ -38,6 +38,7 @@ class SchedulerFactoryBeanRuntimeHints implements RuntimeHintsRegistrar {
 
 	private final ReflectiveRuntimeHintsRegistrar reflectiveRegistrar = new ReflectiveRuntimeHintsRegistrar();
 
+
 	@Override
 	public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
 		if (!ClassUtils.isPresent(SCHEDULER_FACTORY_CLASS_NAME, classLoader)) {
@@ -53,4 +54,5 @@ public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
 	private void typeHint(Builder typeHint) {
 		typeHint.withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS).onReachableType(SchedulerFactoryBean.class);
 	}
+
 }

spring-context/src/main/java/org/springframework/context/annotation/ImportRuntimeHints.java

@@ -29,7 +29,7 @@
  * should be processed.
  *
  * <p>Unlike declaring {@link RuntimeHintsRegistrar} using
- * {@code spring/aot.factories}, this annotation allows for more flexible
+ * {@code META-INF/spring/aot.factories}, this annotation allows for more flexible
  * registration where it is only processed if the annotated component or bean
  * method is actually registered in the bean factory. To illustrate this
  * behavior, consider the following example:
@@ -47,19 +47,24 @@
  *
  * }</pre>
  *
- * If the configuration class above is processed, {@code MyHints} will be
- * contributed only if {@code MyCondition} matches. If it does not, and
- * therefore {@code MyService} is not defined as a bean, the hints will
+ * <p>If the configuration class above is processed, {@code MyHints} will be
+ * contributed only if {@code MyCondition} matches. If the condition does not
+ * match, {@code MyService} will not be defined as a bean and the hints will
  * not be processed either.
  *
- * <p>If several components refer to the same {@link RuntimeHintsRegistrar}
- * implementation, it is invoked only once for a given bean factory
- * processing.
+ * <p>{@code @ImportRuntimeHints} can also be applied to any test class that uses
+ * the <em>Spring TestContext Framework</em> to load an {@code ApplicationContext}.
+ *
+ * <p>If several components or test classes refer to the same {@link RuntimeHintsRegistrar}
+ * implementation, the registrar will only be invoked once for the given bean factory
+ * processing or test suite.
  *
  * @author Brian Clozel
  * @author Stephane Nicoll
  * @since 6.0
  * @see org.springframework.aot.hint.RuntimeHints
+ * @see org.springframework.aot.hint.annotation.Reflective
+ * @see org.springframework.aot.hint.annotation.RegisterReflectionForBinding
  */
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

spring-core/src/main/java/org/springframework/aot/hint/annotation/Reflective.java

@@ -29,14 +29,15 @@
  *
  * <p>When present, either directly or as a meta-annotation, this annotation
  * triggers the configured {@linkplain ReflectiveProcessor processors} against
- * the annotated element. By default, a reflection hint is added on the
+ * the annotated element. By default, a reflection hint is registered for the
  * annotated element so that it can be discovered and invoked if necessary.
  *
  * @author Stephane Nicoll
  * @author Sam Brannen
  * @since 6.0
  * @see SimpleReflectiveProcessor
  * @see ReflectiveRuntimeHintsRegistrar
+ * @see RegisterReflectionForBinding @RegisterReflectionForBinding
  */
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.CONSTRUCTOR,
 		ElementType.FIELD, ElementType.METHOD })

spring-core/src/main/java/org/springframework/aot/hint/annotation/ReflectiveProcessor.java

@@ -24,8 +24,12 @@
  * Process an {@link AnnotatedElement} and register the necessary reflection
  * hints for it.
  *
+ * <p>{@code ReflectiveProcessor} implementations are registered via
+ * {@link Reflective#processors() @Reflective(processors = ...)}.
+ *
  * @author Stephane Nicoll
  * @since 6.0
+ * @see Reflective @Reflective
  */
 public interface ReflectiveProcessor {
 

spring-core/src/main/java/org/springframework/aot/hint/annotation/ReflectiveRuntimeHintsRegistrar.java

@@ -96,12 +96,12 @@ private Entry createEntry(AnnotatedElement element) {
 				.stream(Reflective.class)
 				.map(annotation -> annotation.getClassArray("value"))
 				.flatMap(Arrays::stream)
-				.map(type -> (Class<? extends ReflectiveProcessor>) type)
 				.distinct()
+				.map(type -> (Class<? extends ReflectiveProcessor>) type)
 				.map(processorClass -> this.processors.computeIfAbsent(processorClass, this::instantiateClass))
 				.toList();
-		ReflectiveProcessor processorToUse = (processors.size() == 1 ? processors.get(0)
-				: new DelegatingReflectiveProcessor(processors));
+		ReflectiveProcessor processorToUse = (processors.size() == 1 ? processors.get(0) :
+				new DelegatingReflectiveProcessor(processors));
 		return new Entry(element, processorToUse);
 	}
 

spring-core/src/main/java/org/springframework/aot/hint/annotation/RegisterReflectionForBinding.java

@@ -25,25 +25,24 @@
 import org.springframework.core.annotation.AliasFor;
 
 /**
- * Indicate that the classes specified in the annotation attributes require some
+ * Indicates that the classes specified in the annotation attributes require some
  * reflection hints for binding or reflection-based serialization purposes. For each
  * class specified, hints on constructors, fields, properties, record components,
  * including types transitively used on properties and record components are registered.
  * At least one class must be specified in the {@code value} or {@code classes} annotation
  * attributes.
  *
- * <p>The annotated element can be a configuration class, for example:
+ * <p>The annotated element can be a configuration class &mdash; for example:
  *
  * <pre class="code">
  * &#064;Configuration
  * &#064;RegisterReflectionForBinding({ Foo.class, Bar.class })
  * public class MyConfig {
- *
  *     // ...
  * }</pre>
  *
- * <p>The annotated element can also be any Spring bean class, constructor, field, or method.
- * For example:
+ * <p>The annotated element can be any Spring bean class, constructor, field,
+ * or method &mdash; for example:
  *
  * <pre class="code">
  * &#064;Service
@@ -56,9 +55,13 @@
  *
  * }</pre>
  *
+ * <p>The annotated element can also be any test class that uses the <em>Spring
+ * TestContext Framework</em> to load an {@code ApplicationContext}.
+ *
  * @author Sebastien Deleuze
  * @since 6.0
  * @see org.springframework.aot.hint.BindingReflectionHintsRegistrar
+ * @see Reflective @Reflective
  */
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
@@ -67,10 +70,7 @@
 public @interface RegisterReflectionForBinding {
 
 	/**
-	 * Classes for which reflection hints should be registered.
-	 * <p>At least one class must be specified either via {@link #value} or
-	 * {@link #classes}.
-	 * @see #classes()
+	 * Alias for {@link #classes()}.
 	 */
 	@AliasFor("classes")
 	Class<?>[] value() default {};

spring-core/src/main/java/org/springframework/aot/hint/annotation/RegisterReflectionForBindingProcessor.java

@@ -36,9 +36,11 @@ public class RegisterReflectionForBindingProcessor implements ReflectiveProcesso
 
 	private final BindingReflectionHintsRegistrar bindingRegistrar = new BindingReflectionHintsRegistrar();
 
+
 	@Override
 	public void registerReflectionHints(ReflectionHints hints, AnnotatedElement element) {
-		RegisterReflectionForBinding registerReflection = AnnotationUtils.getAnnotation(element, RegisterReflectionForBinding.class);
+		RegisterReflectionForBinding registerReflection =
+				AnnotationUtils.getAnnotation(element, RegisterReflectionForBinding.class);
 		if (registerReflection != null) {
 			Class<?>[] classes = registerReflection.classes();
 			Assert.state(classes.length != 0, () -> "A least one class should be specified in " +

spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/MessageMappingReflectiveProcessor.java

@@ -34,12 +34,13 @@
 
 /**
  * {@link ReflectiveProcessor} implementation for {@link MessageMapping}
- * annotated types. On top of registering reflection hints for invoking
+ * annotated types. In addition to registering reflection hints for invoking
  * the annotated method, this implementation handles:
+ *
  * <ul>
- *     <li>Return types.</li>
- *     <li>Parameters identified as potential payload.</li>
- *     <li>{@link Message} parameters.</li>
+ *     <li>Return types</li>
+ *     <li>Parameters identified as potential payloads</li>
+ *     <li>{@link Message} parameters</li>
  * </ul>
  *
  * @author Sebastien Deleuze
@@ -49,6 +50,7 @@ class MessageMappingReflectiveProcessor implements ReflectiveProcessor {
 
 	private final BindingReflectionHintsRegistrar bindingRegistrar = new BindingReflectionHintsRegistrar();
 
+
 	@Override
 	public void registerReflectionHints(ReflectionHints hints, AnnotatedElement element) {
 		if (element instanceof Class<?> type) {
@@ -99,6 +101,8 @@ protected void registerReturnValueHints(ReflectionHints hints, Method method) {
 	@Nullable
 	protected Type getMessageType(MethodParameter parameter) {
 		MethodParameter nestedParameter = parameter.nested();
-		return (nestedParameter.getNestedParameterType() == nestedParameter.getParameterType() ? null : nestedParameter.getNestedParameterType());
+		return (nestedParameter.getNestedParameterType() == nestedParameter.getParameterType() ?
+				null : nestedParameter.getNestedParameterType());
 	}
+
 }

spring-test/src/main/java/org/springframework/test/context/aot/TestContextAotGenerator.java

@@ -137,15 +137,20 @@ public void processAheadOfTime(Stream<Class<?>> testClasses) throws TestContextA
 				mergedConfigMappings.add(mergedConfig, testClass);
 				collectRuntimeHintsRegistrarClasses(testClass, coreRuntimeHintsRegistrarClasses);
 				reflectiveRuntimeHintsRegistrar.registerRuntimeHints(this.runtimeHints, testClass);
-				this.testRuntimeHintsRegistrars.forEach(registrar ->
-						registrar.registerHints(this.runtimeHints, testClass, classLoader));
+				this.testRuntimeHintsRegistrars.forEach(registrar -> {
+					if (logger.isTraceEnabled()) {
+						logger.trace("Processing RuntimeHints contribution from class [%s]"
+								.formatted(registrar.getClass().getCanonicalName()));
+					}
+					registrar.registerHints(this.runtimeHints, testClass, classLoader);
+				});
 			});
 
 			coreRuntimeHintsRegistrarClasses.stream()
 					.map(BeanUtils::instantiateClass)
 					.forEach(registrar -> {
 						if (logger.isTraceEnabled()) {
-							logger.trace("Processing RuntimeHints contribution from test class [%s]"
+							logger.trace("Processing RuntimeHints contribution from class [%s]"
 									.formatted(registrar.getClass().getCanonicalName()));
 						}
 						registrar.registerHints(this.runtimeHints, classLoader);

spring-test/src/main/java/org/springframework/test/context/aot/TestRuntimeHintsRegistrar.java

@@ -34,6 +34,12 @@
  * specific to particular test classes, favor implementing {@code RuntimeHintsRegistrar}
  * over this API.
  *
+ * <p>As an alternative to implementing and registering a {@code TestRuntimeHintsRegistrar},
+ * you may choose to annotate a test class with
+ * {@link org.springframework.aot.hint.annotation.Reflective @Reflective},
+ * {@link org.springframework.aot.hint.annotation.RegisterReflectionForBinding @RegisterReflectionForBinding},
+ * or {@link org.springframework.context.annotation.ImportRuntimeHints @ImportRuntimeHints}.
+ *
  * @author Sam Brannen
  * @since 6.0
  * @see org.springframework.aot.hint.RuntimeHintsRegistrar

spring-web/src/main/java/org/springframework/web/bind/annotation/ControllerMappingReflectiveProcessor.java

@@ -33,12 +33,13 @@
 
 /**
  * {@link ReflectiveProcessor} implementation for {@link Controller} and
- * controller-specific annotated methods. On top of registering reflection
+ * controller-specific annotated methods. In addition to registering reflection
  * hints for invoking the annotated method, this implementation handles:
+ *
  * <ul>
- *     <li>Return types annotated with {@link ResponseBody}.</li>
- *     <li>Parameters annotated with {@link RequestBody}.</li>
- *     <li>{@link HttpEntity} return type and parameters.</li>
+ *     <li>Return types annotated with {@link ResponseBody}</li>
+ *     <li>Parameters annotated with {@link RequestBody}</li>
+ *     <li>{@link HttpEntity} return types and parameters</li>
  * </ul>
  *
  * @author Stephane Nicoll
@@ -49,6 +50,7 @@ class ControllerMappingReflectiveProcessor implements ReflectiveProcessor {
 
 	private final BindingReflectionHintsRegistrar bindingRegistrar = new BindingReflectionHintsRegistrar();
 
+
 	@Override
 	public void registerReflectionHints(ReflectionHints hints, AnnotatedElement element) {
 		if (element instanceof Class<?> type) {
@@ -98,8 +100,8 @@ else if (HttpEntity.class.isAssignableFrom(returnTypeParameter.getParameterType(
 	@Nullable
 	private Type getHttpEntityType(MethodParameter parameter) {
 		MethodParameter nestedParameter = parameter.nested();
-		return (nestedParameter.getNestedParameterType() == nestedParameter.getParameterType()
-				? null : nestedParameter.getNestedParameterType());
+		return (nestedParameter.getNestedParameterType() == nestedParameter.getParameterType() ?
+				null : nestedParameter.getNestedParameterType());
 	}
 
 }

spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandlerReflectiveProcessor.java

@@ -37,4 +37,5 @@ protected void registerReturnTypeHints(ReflectionHints hints, MethodParameter re
 		}
 		super.registerReturnTypeHints(hints, returnTypeParameter);
 	}
+
 }

spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchangeReflectiveProcessor.java

@@ -29,7 +29,7 @@
 
 /**
  * {@link ReflectiveProcessor} implementation for {@link HttpExchange @HttpExchange}
- * and annotated methods. On top of registering reflection hints for invoking
+ * annotated methods. In addition to registering reflection hints for invoking
  * the annotated method, this implementation handles reflection-based
  * binding for return types and parameters annotated with {@link RequestBody}.
  *
@@ -40,6 +40,7 @@ class HttpExchangeReflectiveProcessor implements ReflectiveProcessor {
 
 	private final BindingReflectionHintsRegistrar bindingRegistrar = new BindingReflectionHintsRegistrar();
 
+
 	@Override
 	public void registerReflectionHints(ReflectionHints hints, AnnotatedElement element) {
 		if (element instanceof Method method) {