Polishing

Author: sbrannen

spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanDefinitionPropertyValueCodeGeneratorDelegates.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -47,15 +47,15 @@
 abstract class BeanDefinitionPropertyValueCodeGeneratorDelegates {
 
 	/**
-	 * Return the {@link Delegate} implementations for common bean definition
-	 * property value types. These are:
+	 * A list of {@link Delegate} implementations for the following common bean
+	 * definition property value types.
 	 * <ul>
-	 * <li>{@link ManagedList},</li>
-	 * <li>{@link ManagedSet},</li>
-	 * <li>{@link ManagedMap},</li>
-	 * <li>{@link LinkedHashMap},</li>
-	 * <li>{@link BeanReference},</li>
-	 * <li>{@link TypedStringValue}.</li>
+	 * <li>{@link ManagedList}</li>
+	 * <li>{@link ManagedSet}</li>
+	 * <li>{@link ManagedMap}</li>
+	 * <li>{@link LinkedHashMap}</li>
+	 * <li>{@link BeanReference}</li>
+	 * <li>{@link TypedStringValue}</li>
 	 * </ul>
 	 * When combined with {@linkplain ValueCodeGeneratorDelegates#INSTANCES the
 	 * delegates for common value types}, this should be added first as they have

spring-beans/src/main/java/org/springframework/beans/factory/aot/CodeWarnings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -20,7 +20,6 @@
 import java.util.Collections;
 import java.util.LinkedHashSet;
 import java.util.Set;
-import java.util.StringJoiner;
 import java.util.stream.Stream;
 
 import org.springframework.javapoet.AnnotationSpec;
@@ -118,9 +117,7 @@ private CodeBlock generateValueCode() {
 
 	@Override
 	public String toString() {
-		return new StringJoiner(", ", CodeWarnings.class.getSimpleName(), "")
-				.add(this.warnings.toString())
-				.toString();
+		return CodeWarnings.class.getSimpleName() + this.warnings;
 	}
 
 }

spring-beans/src/test/java/org/springframework/beans/factory/aot/CodeWarningsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -43,14 +43,10 @@ class CodeWarningsTests {
 	private static final TestCompiler TEST_COMPILER = TestCompiler.forSystem()
 			.withCompilerOptions("-Xlint:all", "-Werror");
 
-	private final CodeWarnings codeWarnings;
+	private final CodeWarnings codeWarnings = new CodeWarnings();
 
-	private final TestGenerationContext generationContext;
+	private final TestGenerationContext generationContext = new TestGenerationContext();
 
-	CodeWarningsTests() {
-		this.codeWarnings = new CodeWarnings();
-		this.generationContext = new TestGenerationContext();
-	}
 
 	@Test
 	void registerNoWarningDoesNotIncludeAnnotation() {
@@ -67,8 +63,7 @@ void registerWarningSuppressesIt() {
 		compile(method -> {
 			this.codeWarnings.suppress(method);
 			method.addStatement("$T bean = new $T()", DeprecatedBean.class, DeprecatedBean.class);
-		}, compiled -> assertThat(compiled.getSourceFile())
-				.contains("@SuppressWarnings(\"deprecation\")"));
+		}, compiled -> assertThat(compiled.getSourceFile()).contains("@SuppressWarnings(\"deprecation\")"));
 	}
 
 	@Test
@@ -80,26 +75,25 @@ void registerSeveralWarningsSuppressesThem() {
 			this.codeWarnings.suppress(method);
 			method.addStatement("$T bean = new $T()", DeprecatedBean.class, DeprecatedBean.class);
 			method.addStatement("$T another = new $T()", DeprecatedForRemovalBean.class, DeprecatedForRemovalBean.class);
-		}, compiled -> assertThat(compiled.getSourceFile())
-				.contains("@SuppressWarnings({ \"deprecation\", \"removal\" })"));
+		}, compiled -> assertThat(compiled.getSourceFile()).contains("@SuppressWarnings({ \"deprecation\", \"removal\" })"));
 	}
 
 	@Test
 	@SuppressWarnings("deprecation")
 	void detectDeprecationOnAnnotatedElementWithDeprecated() {
 		this.codeWarnings.detectDeprecation(DeprecatedBean.class);
-		assertThat(this.codeWarnings.getWarnings()).containsExactly("deprecation");
+		assertThat(this.codeWarnings.getWarnings()).containsOnly("deprecation");
 	}
 
 	@Test
 	@SuppressWarnings("removal")
 	void detectDeprecationOnAnnotatedElementWithDeprecatedForRemoval() {
 		this.codeWarnings.detectDeprecation(DeprecatedForRemovalBean.class);
-		assertThat(this.codeWarnings.getWarnings()).containsExactly("removal");
+		assertThat(this.codeWarnings.getWarnings()).containsOnly("removal");
 	}
 
 	@Test
-	void toStringIncludeWarnings() {
+	void toStringIncludesWarnings() {
 		this.codeWarnings.register("deprecation");
 		this.codeWarnings.register("rawtypes");
 		assertThat(this.codeWarnings).hasToString("CodeWarnings[deprecation, rawtypes]");

spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.

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

@@ -142,11 +142,11 @@ private CronExpression(CronField seconds, CronField minutes, CronField hours,
 	 *
 	 * <p>Example expressions:
 	 * <ul>
-	 * <li>{@code "0 0 * * * *"} = the top of every hour of every day.</li>
-	 * <li><code>"*&#47;10 * * * * *"</code> = every ten seconds.</li>
-	 * <li>{@code "0 0 8-10 * * *"} = 8, 9 and 10 o'clock of every day.</li>
-	 * <li>{@code "0 0 6,19 * * *"} = 6:00 AM and 7:00 PM every day.</li>
-	 * <li>{@code "0 0/30 8-10 * * *"} = 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day.</li>
+	 * <li>{@code "0 0 * * * *"} = the top of every hour of every day</li>
+	 * <li><code>"*&#47;10 * * * * *"</code> = every ten seconds</li>
+	 * <li>{@code "0 0 8-10 * * *"} = 8, 9 and 10 o'clock of every day</li>
+	 * <li>{@code "0 0 6,19 * * *"} = 6:00 AM and 7:00 PM every day</li>
+	 * <li>{@code "0 0/30 8-10 * * *"} = 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day</li>
 	 * <li>{@code "0 0 9-17 * * MON-FRI"} = on the hour nine-to-five weekdays</li>
 	 * <li>{@code "0 0 0 25 12 ?"} = every Christmas Day at midnight</li>
 	 * <li>{@code "0 0 0 L * *"} = last day of the month at midnight</li>
@@ -159,13 +159,13 @@ private CronExpression(CronField seconds, CronField minutes, CronField hours,
 	 * <li>{@code "0 0 0 ? * MON#1"} = the first Monday in the month at midnight</li>
 	 * </ul>
 	 *
-	 * <p>The following macros are also supported:
+	 * <p>The following macros are also supported.
 	 * <ul>
-	 * <li>{@code "@yearly"} (or {@code "@annually"}) to run un once a year, i.e. {@code "0 0 0 1 1 *"},</li>
-	 * <li>{@code "@monthly"} to run once a month, i.e. {@code "0 0 0 1 * *"},</li>
-	 * <li>{@code "@weekly"} to run once a week, i.e. {@code "0 0 0 * * 0"},</li>
-	 * <li>{@code "@daily"} (or {@code "@midnight"}) to run once a day, i.e. {@code "0 0 0 * * *"},</li>
-	 * <li>{@code "@hourly"} to run once an hour, i.e. {@code "0 0 * * * *"}.</li>
+	 * <li>{@code "@yearly"} (or {@code "@annually"}) to run un once a year, i.e. {@code "0 0 0 1 1 *"}</li>
+	 * <li>{@code "@monthly"} to run once a month, i.e. {@code "0 0 0 1 * *"}</li>
+	 * <li>{@code "@weekly"} to run once a week, i.e. {@code "0 0 0 * * 0"}</li>
+	 * <li>{@code "@daily"} (or {@code "@midnight"}) to run once a day, i.e. {@code "0 0 0 * * *"}</li>
+	 * <li>{@code "@hourly"} to run once an hour, i.e. {@code "0 0 * * * *"}</li>
 	 * </ul>
 	 * @param expression the expression string to parse
 	 * @return the parsed {@code CronExpression} object

spring-core/src/main/java/org/springframework/aot/generate/ValueCodeGeneratorDelegates.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -47,19 +47,19 @@
 public abstract class ValueCodeGeneratorDelegates {
 
 	/**
-	 * Return the {@link Delegate} implementations for common value types.
-	 * These are:
+	 * A list of {@link Delegate} implementations for the following common value
+	 * types.
 	 * <ul>
-	 * <li>Primitive types,</li>
-	 * <li>String,</li>
-	 * <li>Charset,</li>
-	 * <li>Enum,</li>
-	 * <li>Class,</li>
-	 * <li>{@link ResolvableType},</li>
-	 * <li>Array,</li>
-	 * <li>List via {@code List.of},</li>
-	 * <li>Set via {@code Set.of} and support of {@link LinkedHashSet},</li>
-	 * <li>Map via {@code Map.of} or {@code Map.ofEntries}.</li>
+	 * <li>Primitive types</li>
+	 * <li>String</li>
+	 * <li>Charset</li>
+	 * <li>Enum</li>
+	 * <li>Class</li>
+	 * <li>{@link ResolvableType}</li>
+	 * <li>Array</li>
+	 * <li>List via {@code List.of}</li>
+	 * <li>Set via {@code Set.of} and support for {@link LinkedHashSet}</li>
+	 * <li>Map via {@code Map.of} or {@code Map.ofEntries}</li>
 	 * </ul>
 	 * Those implementations do not require the {@link ValueCodeGenerator} to be
 	 * {@linkplain ValueCodeGenerator#scoped(GeneratedMethods) scoped}.

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

@@ -23,7 +23,6 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
-import java.util.StringJoiner;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -123,9 +122,7 @@ public Set<MemberCategory> getMemberCategories() {
 
 	@Override
 	public String toString() {
-		return new StringJoiner(", ", TypeHint.class.getSimpleName() + "[", "]")
-				.add("type=" + this.type)
-				.toString();
+		return TypeHint.class.getSimpleName() + "[type=" + this.type + "]";
 	}
 
 	/**

spring-core/src/main/java/org/springframework/core/ResolvableType.java

@@ -1169,7 +1169,8 @@ public static ResolvableType forClassWithGenerics(Class<?> clazz, ResolvableType
 		Assert.notNull(clazz, "Class must not be null");
 		Assert.notNull(generics, "Generics array must not be null");
 		TypeVariable<?>[] variables = clazz.getTypeParameters();
-		Assert.isTrue(variables.length == generics.length, () -> "Mismatched number of generics specified for " + clazz.toGenericString());
+		Assert.isTrue(variables.length == generics.length,
+				() -> "Mismatched number of generics specified for " + clazz.toGenericString());
 
 		Type[] arguments = new Type[generics.length];
 		for (int i = 0; i < generics.length; i++) {

spring-core/src/main/java/org/springframework/util/ClassUtils.java

@@ -1019,10 +1019,10 @@ public static String getDescriptiveType(@Nullable Object value) {
 		}
 		Class<?> clazz = value.getClass();
 		if (Proxy.isProxyClass(clazz)) {
-			String prefix = clazz.getName() + " implementing ";
+			String prefix = clazz.getTypeName() + " implementing ";
 			StringJoiner result = new StringJoiner(",", prefix, "");
 			for (Class<?> ifc : clazz.getInterfaces()) {
-				result.add(ifc.getName());
+				result.add(ifc.getTypeName());
 			}
 			return result.toString();
 		}

spring-core/src/main/java/org/springframework/util/PlaceholderParser.java

@@ -46,13 +46,13 @@
  * a given key can involve the resolution of nested placeholders. Default values
  * can also have placeholders.
  *
- * <p>For situations where the syntax of a valid placeholder match a String that
+ * <p>For situations where the syntax of a valid placeholder matches a String that
  * must be rendered as is, the placeholder can be escaped using an {@code escape}
  * character. For instance {@code \${name}} resolves as {@code ${name}}.
  *
  * <p>The prefix, suffix, separator, and escape characters are configurable. Only
- * the prefix and suffix are mandatory and the support of default values or
- * escaping are conditional on providing a non-null value for them.
+ * the prefix and suffix are mandatory, and the support for default values or
+ * escaping is conditional on providing non-null values for them.
  *
  * <p>This parser makes sure to resolves placeholders as lazily as possible.
  *
@@ -64,7 +64,11 @@ final class PlaceholderParser {
 	private static final Log logger = LogFactory.getLog(PlaceholderParser.class);
 
 	private static final Map<String, String> wellKnownSimplePrefixes = Map.of(
-			"}", "{", "]", "[", ")", "(");
+			"}", "{",
+			"]", "[",
+			")", "("
+		);
+
 
 	private final String prefix;
 
@@ -80,17 +84,17 @@ final class PlaceholderParser {
 	@Nullable
 	private final Character escape;
 
+
 	/**
 	 * Create an instance using the specified input for the parser.
-	 *
 	 * @param prefix the prefix that denotes the start of a placeholder
 	 * @param suffix the suffix that denotes the end of a placeholder
 	 * @param ignoreUnresolvablePlaceholders whether unresolvable placeholders
 	 * should be ignored ({@code true}) or cause an exception ({@code false})
 	 * @param separator the separating character between the placeholder
 	 * variable and the associated default value, if any
 	 * @param escape the character to use at the beginning of a placeholder
-	 * to escape it and render it as is
+	 * prefix or separator to escape it and render it as is
 	 */
 	PlaceholderParser(String prefix, String suffix, boolean ignoreUnresolvablePlaceholders,
 			@Nullable String separator, @Nullable Character escape) {
@@ -109,7 +113,7 @@ final class PlaceholderParser {
 	}
 
 	/**
-	 * Replaces all placeholders of format {@code ${name}} with the value returned
+	 * Replace all placeholders of format {@code ${name}} with the value returned
 	 * from the supplied {@link PlaceholderResolver}.
 	 * @param value the value containing the placeholders to be replaced
 	 * @param placeholderResolver the {@code PlaceholderResolver} to use for replacement
@@ -138,8 +142,7 @@ private List<Part> parse(String value, boolean inPlaceholder) {
 		LinkedList<Part> parts = new LinkedList<>();
 		int startIndex = nextStartPrefix(value, 0);
 		if (startIndex == -1) {
-			Part part = inPlaceholder ? createSimplePlaceholderPart(value)
-					: new TextPart(value);
+			Part part = (inPlaceholder ? createSimplePlaceholderPart(value) : new TextPart(value));
 			parts.add(part);
 			return parts;
 		}
@@ -168,13 +171,13 @@ else if (isEscaped(value, startIndex)) { // Not a valid index, accumulate and sk
 		}
 		// Add rest of text if necessary
 		addText(value, position, value.length(), parts);
-		return inPlaceholder ? List.of(createNestedPlaceholderPart(value, parts)) : parts;
+		return (inPlaceholder ? List.of(createNestedPlaceholderPart(value, parts)) : parts);
 	}
 
 	private SimplePlaceholderPart createSimplePlaceholderPart(String text) {
 		String[] keyAndDefault = splitKeyAndDefault(text);
-		return (keyAndDefault != null) ? new SimplePlaceholderPart(text, keyAndDefault[0], keyAndDefault[1])
-				: new SimplePlaceholderPart(text, text, null);
+		return ((keyAndDefault != null) ? new SimplePlaceholderPart(text, keyAndDefault[0], keyAndDefault[1]) :
+				new SimplePlaceholderPart(text, text, null));
 	}
 
 	private NestedPlaceholderPart createNestedPlaceholderPart(String text, List<Part> parts) {
@@ -291,7 +294,7 @@ private boolean isEscaped(String value, int index) {
 	}
 
 	/**
-	 * Provide the necessary to handle and resolve underlying placeholders.
+	 * Provide the necessary context to handle and resolve underlying placeholders.
 	 */
 	static class PartResolutionContext implements PlaceholderResolver {
 
@@ -308,6 +311,7 @@ static class PartResolutionContext implements PlaceholderResolver {
 		@Nullable
 		private Set<String> visitedPlaceholders;
 
+
 		PartResolutionContext(PlaceholderResolver resolver, String prefix, String suffix,
 				boolean ignoreUnresolvablePlaceholders, Function<String, List<Part>> parser) {
 			this.prefix = prefix;