Fix typos in code and documentation

See gh-31734

Author: marcwrobel

buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/Upgrade.java

@@ -20,7 +20,7 @@
 import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
 
 /**
- * An upgrade to change a {@link Library} to use a new version}.
+ * An upgrade to change a {@link Library} to use a new version.
  *
  * @author Andy Wilkinson
  */

buildSrc/src/main/java/org/springframework/boot/build/testing/TestResultsOverview.java

@@ -29,8 +29,7 @@
 import org.gradle.tooling.events.OperationCompletionListener;
 
 /**
- * {@link BuildService} that provides an overview of all of the test failures in the
- * build.
+ * {@link BuildService} that provides an overview of all the test failures in the build.
  *
  * @author Andy Wilkinson
  */

buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/version/DependencyVersionTests.java

@@ -53,12 +53,12 @@ void parseWhenVersionWithCombinedPatchAndQualifierShouldReturnCombinedPatchAndQu
 	}
 
 	@Test
-	void parseWhenCalendarVersionShouldReturnArticatVersionDependencyVersion() {
+	void parseWhenCalendarVersionShouldReturnArtifactVersionDependencyVersion() {
 		assertThat(DependencyVersion.parse("2020.0.0")).isInstanceOf(CalendarVersionDependencyVersion.class);
 	}
 
 	@Test
-	void parseWhenCalendarVersionWithModifierShouldReturnArticatVersionDependencyVersion() {
+	void parseWhenCalendarVersionWithModifierShouldReturnArtifactVersionDependencyVersion() {
 		assertThat(DependencyVersion.parse("2020.0.0-M1")).isInstanceOf(CalendarVersionDependencyVersion.class);
 	}
 

buildSrc/src/test/resources/plugin.xml

@@ -805,7 +805,7 @@ required to use this feature.</description>
           <type>long</type>
           <required>false</required>
           <editable>true</editable>
-          <description>The number of milli-seconds to wait between each attempt to check if the spring
+          <description>The number of milliseconds to wait between each attempt to check if the spring
 application is ready.</description>
         </parameter>
         <parameter>
@@ -880,7 +880,7 @@ application.</description>
           <type>int</type>
           <required>false</required>
           <editable>true</editable>
-          <description>The port to use to lookup the platform MBeanServer if the application has been
+          <description>The port to use to look up the platform MBeanServer if the application has been
 forked.</description>
         </parameter>
         <parameter>

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java

@@ -25,9 +25,9 @@
 import org.springframework.context.annotation.Conditional;
 
 /**
- * {@link Conditional @Conditional} that checks whether or not a default health indicator
- * is enabled. Matches if the value of the {@code management.health.<name>.enabled}
- * property is {@code true}. Otherwise, matches if the value of the
+ * {@link Conditional @Conditional} that checks whether a default health indicator is
+ * enabled. Matches if the value of the {@code management.health.<name>.enabled} property
+ * is {@code true}. Otherwise, matches if the value of the
  * {@code management.health.defaults.enabled} property is {@code true} or if it is not
  * configured.
  *

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java

@@ -44,8 +44,8 @@ public abstract class HealthProperties {
 	private Show showComponents;
 
 	/**
-	 * Roles used to determine whether or not a user is authorized to be shown details.
-	 * When empty, all authenticated users are authorized.
+	 * Roles used to determine whether a user is authorized to be shown details. When
+	 * empty, all authenticated users are authorized.
 	 */
 	private Set<String> roles = new HashSet<>();
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java

@@ -25,8 +25,8 @@
 import org.springframework.context.annotation.Conditional;
 
 /**
- * {@link Conditional @Conditional} that checks whether or not an info contributor is
- * enabled. Matches if the value of the {@code management.info.<name>.enabled} property is
+ * {@link Conditional @Conditional} that checks whether an info contributor is enabled.
+ * Matches if the value of the {@code management.info.<name>.enabled} property is
  * {@code true}. Otherwise, use the specific {@link #fallback() fallback} method.
  *
  * @author Stephane Nicoll

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ConditionalOnEnabledMetricsExport.java

@@ -25,11 +25,11 @@
 import org.springframework.context.annotation.Conditional;
 
 /**
- * {@link Conditional @Conditional} that checks whether or not a metrics exporter is
- * enabled. If the {@code management.metrics.export.<name>.enabled} property is configured
- * then its value is used to determine if it matches. Otherwise, matches if the value of
- * the {@code management.metrics.export.defaults.enabled} property is {@code true} or if
- * it is not configured.
+ * {@link Conditional @Conditional} that checks whether a metrics exporter is enabled. If
+ * the {@code management.metrics.export.<name>.enabled} property is configured then its
+ * value is used to determine if it matches. Otherwise, matches if the value of the
+ * {@code management.metrics.export.defaults.enabled} property is {@code true} or if it is
+ * not configured.
  *
  * @author Chris Bono
  * @since 2.4.0

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java

@@ -66,7 +66,7 @@ public class GangliaProperties {
 	private GMetric.UDPAddressingMode addressingMode = GMetric.UDPAddressingMode.MULTICAST;
 
 	/**
-	 * Time to live for metrics on Ganglia. Set the multi-cast Time-To-Live to be one
+	 * Time to live for metrics on Ganglia. Set the multicast Time-To-Live to be one
 	 * greater than the number of hops (routers) between the hosts.
 	 */
 	private Integer timeToLive = 1;

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java

@@ -142,7 +142,7 @@ public <T> T resolveArgument(Class<T> argumentType) {
 	}
 
 	/**
-	 * Returns whether or not the context is capable of resolving an argument of the given
+	 * Returns whether the context is capable of resolving an argument of the given
 	 * {@code type}. Note that, even when {@code true} is returned,
 	 * {@link #resolveArgument argument resolution} will return {@code null} if no
 	 * argument of the required type is available.

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Producible.java

@@ -49,9 +49,9 @@ public interface Producible<E extends Enum<E> & Producible<E>> {
 
 	/**
 	 * Return if this enum value should be used as the default value when an accept header
-	 * of &#42;&#47;&#42; is provided, or if the accept header is missing. Only one value
-	 * can be marked as default. If no value is marked, then the value with the highest
-	 * {@link Enum#ordinal() ordinal} is used as the default.
+	 * of &#42;&#47;&#42; is provided, or if the {@code Accept} header is missing. Only
+	 * one value can be marked as default. If no value is marked, then the value with the
+	 * highest {@link Enum#ordinal() ordinal} is used as the default.
 	 * @return if this value should be used as the default value
 	 * @since 2.5.6
 	 */

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/Link.java

@@ -52,7 +52,7 @@ public String getHref() {
 	}
 
 	/**
-	 * Returns whether or not the {@link #getHref() href} is templated.
+	 * Returns whether the {@link #getHref() href} is templated.
 	 * @return {@code true} if the href is templated, otherwise {@code false}
 	 */
 	public boolean isTemplated() {

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java

@@ -22,7 +22,7 @@
  * Strategy interface used to contribute {@link Health} to the results returned from the
  * reactive variant of the {@link HealthEndpoint}.
  * <p>
- * This is non blocking contract that is meant to be used in a reactive application. See
+ * This is non-blocking contract that is meant to be used in a reactive application. See
  * {@link HealthIndicator} for the traditional contract.
  *
  * @author Stephane Nicoll

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java

@@ -84,9 +84,9 @@ void metricRecordedWithoutMainAppClassTagAndAdditionalTags() {
 		Tags tags = Tags.of("foo", "bar");
 		this.listener = new StartupTimeMetricsListener(this.registry, "started", "ready", tags);
 		this.listener.onApplicationEvent(new ApplicationReadyEvent(application, null, null, Duration.ofSeconds(2)));
-		TimeGauge applicationReadyGague = this.registry.find("ready").timeGauge();
-		assertThat(applicationReadyGague).isNotNull();
-		assertThat(applicationReadyGague.getId().getTags()).containsExactlyElementsOf(tags);
+		TimeGauge applicationReadyGauge = this.registry.find("ready").timeGauge();
+		assertThat(applicationReadyGauge).isNotNull();
+		assertThat(applicationReadyGauge.getId().getTags()).containsExactlyElementsOf(tags);
 	}
 
 	@Test

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java

@@ -80,14 +80,13 @@
 
 	/**
 	 * The annotation type decorating a bean that should be checked. The condition matches
-	 * when all of the annotations specified are defined on beans in the
-	 * {@link BeanFactory}.
+	 * when all the annotations specified are defined on beans in the {@link BeanFactory}.
 	 * @return the class-level annotation types to check
 	 */
 	Class<? extends Annotation>[] annotation() default {};
 
 	/**
-	 * The names of beans to check. The condition matches when all of the bean names
+	 * The names of beans to check. The condition matches when all the bean names
 	 * specified are contained in the {@link BeanFactory}.
 	 * @return the names of beans to check
 	 */

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java

@@ -345,7 +345,7 @@ public class FlywayProperties {
 	private String oracleKerberosCacheFile;
 
 	/**
-	 * Location of the Oracle Wallet, used to sign-in to the database automatically.
+	 * Location of the Oracle Wallet, used to sign in to the database automatically.
 	 * Requires Flyway Teams.
 	 */
 	private String oracleWalletLocation;

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java

@@ -695,7 +695,7 @@ public static class Streams {
 		private String applicationId;
 
 		/**
-		 * Whether or not to auto-start the streams factory bean.
+		 * Whether to auto-start the streams factory bean.
 		 */
 		private boolean autoStartup = true;
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java

@@ -140,7 +140,7 @@ public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManager
 	protected abstract Map<String, Object> getVendorProperties();
 
 	/**
-	 * Customize vendor properties before they are used. Allows for post processing (for
+	 * Customize vendor properties before they are used. Allows for post-processing (for
 	 * example to configure JTA specific settings).
 	 * @param vendorProperties the vendor properties to customize
 	 */

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ConditionalOnEnabledResourceChain.java

@@ -25,10 +25,9 @@
 import org.springframework.context.annotation.Conditional;
 
 /**
- * {@link Conditional @Conditional} that checks whether or not the Spring resource
- * handling chain is enabled. Matches if
- * {@link WebProperties.Resources.Chain#getEnabled()} is {@code true} or if
- * {@code webjars-locator-core} is on the classpath.
+ * {@link Conditional @Conditional} that checks whether the Spring resource handling chain
+ * is enabled. Matches if {@link WebProperties.Resources.Chain#getEnabled()} is
+ * {@code true} or if {@code webjars-locator-core} is on the classpath.
  *
  * @author Stephane Nicoll
  * @since 1.3.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/OnEnabledResourceChainCondition.java

@@ -27,8 +27,7 @@
 import org.springframework.util.ClassUtils;
 
 /**
- * {@link Condition} that checks whether or not the Spring resource handling chain is
- * enabled.
+ * {@link Condition} that checks whether the Spring resource handling chain is enabled.
  *
  * @author Stephane Nicoll
  * @author Phillip Webb

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/neo4j/Neo4jAutoConfigurationTests.java

@@ -141,7 +141,7 @@ void determineServerUriWithDeprecatedPropertyShouldOverrideDefault() {
 
 	@Test
 	@Deprecated
-	void determineServerUriWithCustoUriShouldTakePrecedenceOverDeprecatedProperty() {
+	void determineServerUriWithCustomUriShouldTakePrecedenceOverDeprecatedProperty() {
 		URI customUri = URI.create("bolt://localhost:4242");
 		URI anotherCustomURI = URI.create("bolt://localhost:2424");
 		Neo4jProperties properties = new Neo4jProperties();

spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/ProjectGenerationRequest.java

@@ -105,9 +105,8 @@ void setOutput(String output) {
 	}
 
 	/**
-	 * Whether or not the project archive should be extracted in the output location. If
-	 * the {@link #getOutput() output} ends with "/", the project is extracted
-	 * automatically.
+	 * Whether the project archive should be extracted in the output location. If the
+	 * {@link #getOutput() output} ends with "/", the project is extracted automatically.
 	 * @return {@code true} if the archive should be extracted, otherwise {@code false}
 	 */
 	boolean isExtract() {
@@ -242,7 +241,7 @@ void setFormat(String format) {
 	}
 
 	/**
-	 * Whether or not the type should be detected based on the build and format value.
+	 * Whether the type should be detected based on the build and format value.
 	 * @return {@code true} if type detection will be performed, otherwise {@code false}
 	 */
 	boolean isDetectType() {

spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/run/SpringApplicationRunner.java

@@ -96,7 +96,7 @@ public void compileAndRun() throws Exception {
 				stop();
 				Class<?>[] compiledSources = compile();
 				monitorForChanges();
-				// Run in new thread to ensure that the context classloader is setup
+				// Run in new thread to ensure that the context classloader is set up
 				this.runThread = new RunThread(compiledSources);
 				this.runThread.start();
 				this.runThread.join();

spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java

@@ -143,7 +143,7 @@ public static boolean hasAtLeastOneInterface(ClassNode classNode, String... type
 	 * optionally removing it from the block at the same time.
 	 * @param block a block statement (class definition)
 	 * @param name the name to look for
-	 * @param remove whether or not the extracted closure should be removed
+	 * @param remove whether the extracted closure should be removed
 	 * @return a beans Closure if one can be found, null otherwise
 	 */
 	public static ClosureExpression getClosure(BlockStatement block, String name, boolean remove) {

spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyCustomizer.java

@@ -105,8 +105,8 @@ protected boolean canAdd() {
 	}
 
 	/**
-	 * Create a nested {@link DependencyCustomizer} that only applies if all of the
-	 * specified class names are not on the class path.
+	 * Create a nested {@link DependencyCustomizer} that only applies if all the specified
+	 * class names are not on the class path.
 	 * @param classNames the class names to test
 	 * @return a nested {@link DependencyCustomizer}
 	 */

spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java

@@ -327,7 +327,7 @@ private void cleanupCaches() {
 	}
 
 	private void cleanupKnownCaches() {
-		// Whilst not strictly necessary it helps to cleanup soft reference caches
+		// Whilst not strictly necessary it helps to clean up soft reference caches
 		// early rather than waiting for memory limits to be reached
 		ResolvableType.clearCache();
 		cleanCachedIntrospectionResultsCache();

spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/server/RestartServerTests.java

@@ -89,7 +89,7 @@ void updateSetsJarLastModified(@TempDir File directory) throws Exception {
 	@Test
 	void updateReplacesLocalFilesWhenPossible(@TempDir File directory) throws Exception {
 		// This is critical for Cloud Foundry support where the application is
-		// run exploded and resources can be found from the servlet root (outside of the
+		// run exploded and resources can be found from the servlet root (outside the
 		// classloader)
 		File classFile = new File(directory, "ClassA.class");
 		FileCopyUtils.copy("abc".getBytes(), classFile);

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCaptureRule.java

@@ -29,7 +29,7 @@
 import static org.hamcrest.Matchers.allOf;
 
 /**
- * JUnit {@code @Rule} to capture output from System.out and System.err.
+ * JUnit {@code @Rule} to capture output from {@code System.out} and {@code System.err}.
  * <p>
  * To use add as a {@link Rule @Rule}:
  *

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/client/TestRestTemplate.java

@@ -56,7 +56,7 @@
 
 /**
  * Convenient alternative of {@link RestTemplate} that is suitable for integration tests.
- * {@code TestRestTemplate} is fault tolerant. This means that 4xx and 5xx do not result
+ * {@code TestRestTemplate} is fault-tolerant. This means that 4xx and 5xx do not result
  * in an exception being thrown and can instead be detected via the {@link ResponseEntity
  * response entity} and its {@link ResponseEntity#getStatusCode() status code}.
  * <p>
@@ -641,35 +641,35 @@ public void delete(URI url) {
 	}
 
 	/**
-	 * Return the value of the Allow header for the given URI.
+	 * Return the value of the {@code Allow} header for the given URI.
 	 * <p>
 	 * URI Template variables are expanded using the given URI variables, if any.
 	 * @param url the URL
 	 * @param urlVariables the variables to expand in the template
-	 * @return the value of the allow header
+	 * @return the value of the {@code Allow} header
 	 * @see RestTemplate#optionsForAllow(java.lang.String, java.lang.Object[])
 	 */
 	public Set<HttpMethod> optionsForAllow(String url, Object... urlVariables) {
 		return this.restTemplate.optionsForAllow(url, urlVariables);
 	}
 
 	/**
-	 * Return the value of the Allow header for the given URI.
+	 * Return the value of the {@code Allow} header for the given URI.
 	 * <p>
 	 * URI Template variables are expanded using the given map.
 	 * @param url the URL
 	 * @param urlVariables the variables to expand in the template
-	 * @return the value of the allow header
+	 * @return the value of the {@code Allow} header
 	 * @see RestTemplate#optionsForAllow(java.lang.String, java.util.Map)
 	 */
 	public Set<HttpMethod> optionsForAllow(String url, Map<String, ?> urlVariables) {
 		return this.restTemplate.optionsForAllow(url, urlVariables);
 	}
 
 	/**
-	 * Return the value of the Allow header for the given URL.
+	 * Return the value of the {@code Allow} header for the given URL.
 	 * @param url the URL
-	 * @return the value of the allow header
+	 * @return the value of the {@code Allow} header
 	 * @see RestTemplate#optionsForAllow(java.net.URI)
 	 */
 	public Set<HttpMethod> optionsForAllow(URI url) {

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/ImageArchive.java

@@ -98,7 +98,7 @@ public ImageConfig getImageConfig() {
 	}
 
 	/**
-	 * Return the create data of the archive.
+	 * Return the create date of the archive.
 	 * @return the create date
 	 */
 	public Instant getCreateDate() {

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/VolumeName.java

@@ -72,7 +72,7 @@ public static VolumeName random(String prefix) {
 	 * Factory method to create a new {@link VolumeName} with a random name.
 	 * @param prefix the prefix to use with the random name
 	 * @param randomLength the number of chars in the random part of the name
-	 * @return a randomly volume reference
+	 * @return a randomly named volume reference
 	 */
 	public static VolumeName random(String prefix, int randomLength) {
 		return of(RandomString.generate(prefix, randomLength));