From dbfc6bded42c9d220952ded1edcdae161798d67d Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Thu, 14 Jul 2022 15:10:20 +0200 Subject: [PATCH] Fix typos in code and documentation See gh-31734 --- .../boot/build/bom/bomr/Upgrade.java | 2 +- .../boot/build/testing/TestResultsOverview.java | 3 +-- .../bom/bomr/version/DependencyVersionTests.java | 4 ++-- buildSrc/src/test/resources/plugin.xml | 4 ++-- .../ConditionalOnEnabledHealthIndicator.java | 6 +++--- .../autoconfigure/health/HealthProperties.java | 4 ++-- .../info/ConditionalOnEnabledInfoContributor.java | 4 ++-- .../export/ConditionalOnEnabledMetricsExport.java | 10 +++++----- .../metrics/export/ganglia/GangliaProperties.java | 2 +- .../boot/actuate/endpoint/InvocationContext.java | 2 +- .../boot/actuate/endpoint/Producible.java | 6 +++--- .../boot/actuate/endpoint/web/Link.java | 2 +- .../actuate/health/ReactiveHealthIndicator.java | 2 +- .../startup/StartupTimeMetricsListenerTests.java | 6 +++--- .../autoconfigure/condition/ConditionalOnBean.java | 5 ++--- .../autoconfigure/flyway/FlywayProperties.java | 2 +- .../boot/autoconfigure/kafka/KafkaProperties.java | 2 +- .../orm/jpa/JpaBaseConfiguration.java | 2 +- .../web/ConditionalOnEnabledResourceChain.java | 7 +++---- .../web/OnEnabledResourceChainCondition.java | 3 +-- .../neo4j/Neo4jAutoConfigurationTests.java | 2 +- .../cli/command/init/ProjectGenerationRequest.java | 7 +++---- .../cli/command/run/SpringApplicationRunner.java | 2 +- .../boot/cli/compiler/AstUtils.java | 2 +- .../boot/cli/compiler/DependencyCustomizer.java | 4 ++-- .../boot/devtools/restart/Restarter.java | 2 +- .../restart/server/RestartServerTests.java | 2 +- .../boot/test/system/OutputCaptureRule.java | 2 +- .../boot/test/web/client/TestRestTemplate.java | 14 +++++++------- .../platform/docker/type/ImageArchive.java | 2 +- .../buildpack/platform/docker/type/VolumeName.java | 2 +- .../configurationprocessor/json/JSONArray.java | 4 ++-- .../configurationprocessor/json/JSONObject.java | 2 +- .../configurationprocessor/json/JSONStringer.java | 2 +- .../configurationprocessor/json/JSONTokener.java | 2 +- .../boot/loader/tools/AbstractJarWriter.java | 4 ++-- .../springframework/boot/loader/tools/Digest.java | 4 ++-- .../boot/loader/tools/FileUtils.java | 2 +- .../boot/loader/tools/Packager.java | 8 ++++---- .../boot/loader/ExecutableArchiveLauncher.java | 4 ++-- .../boot/loader/PropertiesLauncher.java | 2 +- .../springframework/boot/maven/BuildImageMojo.java | 4 ++-- .../org/springframework/boot/maven/StopMojo.java | 2 +- .../boot/DefaultPropertiesPropertySource.java | 4 ++-- .../boot/builder/SpringApplicationBuilder.java | 4 ++-- .../CloudFoundryVcapEnvironmentPostProcessor.java | 2 +- .../config/ConfigDataEnvironmentContributor.java | 4 ++-- .../context/event/EventPublishingRunListener.java | 2 +- .../springframework/boot/jdbc/DatabaseDriver.java | 2 +- .../boot/r2dbc/EmbeddedDatabaseConnection.java | 2 +- .../boot/system/ApplicationTemp.java | 6 +++--- .../jetty/JettyServletWebServerFactory.java | 8 ++++---- .../server/AbstractServletWebServerFactory.java | 2 +- .../properties/WithPublicObjectToObjectMethod.java | 2 +- .../boot/context/properties/bind/BinderTests.java | 2 +- .../source/ConfigurationPropertyNameTests.java | 2 +- .../boot/jdbc/DatabaseDriverClassNameTests.java | 2 +- ...figServletWebServerApplicationContextTests.java | 2 +- .../ServletWebServerApplicationContextTests.java | 4 ++-- 59 files changed, 102 insertions(+), 107 deletions(-) diff --git a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/Upgrade.java b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/Upgrade.java index e0457fe8f4..a155985a7d 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/Upgrade.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/Upgrade.java @@ -20,7 +20,7 @@ import org.springframework.boot.build.bom.Library; 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 */ diff --git a/buildSrc/src/main/java/org/springframework/boot/build/testing/TestResultsOverview.java b/buildSrc/src/main/java/org/springframework/boot/build/testing/TestResultsOverview.java index 8c2487f311..738fe92c71 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/testing/TestResultsOverview.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/testing/TestResultsOverview.java @@ -29,8 +29,7 @@ import org.gradle.tooling.events.FinishEvent; 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 */ diff --git a/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/version/DependencyVersionTests.java b/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/version/DependencyVersionTests.java index c8852b9e08..597f8b53a0 100644 --- a/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/version/DependencyVersionTests.java +++ b/buildSrc/src/test/java/org/springframework/boot/build/bom/bomr/version/DependencyVersionTests.java @@ -53,12 +53,12 @@ class DependencyVersionTests { } @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); } diff --git a/buildSrc/src/test/resources/plugin.xml b/buildSrc/src/test/resources/plugin.xml index 8e21135e71..bf2a6c92d2 100644 --- a/buildSrc/src/test/resources/plugin.xml +++ b/buildSrc/src/test/resources/plugin.xml @@ -805,7 +805,7 @@ required to use this feature. long false true - The number of milli-seconds to wait between each attempt to check if the spring + The number of milliseconds to wait between each attempt to check if the spring application is ready. @@ -880,7 +880,7 @@ application. int false true - The port to use to lookup the platform MBeanServer if the application has been + The port to use to look up the platform MBeanServer if the application has been forked. diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java index c3e5b8beef..680b379b42 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java @@ -25,9 +25,9 @@ import java.lang.annotation.Target; 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..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..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. * diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java index 8603f79aa5..860f4b0cd9 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java +++ b/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 roles = new HashSet<>(); diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java index bc0ddc8a79..74b8fd9836 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java @@ -25,8 +25,8 @@ import java.lang.annotation.Target; 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..enabled} property is + * {@link Conditional @Conditional} that checks whether an info contributor is enabled. + * Matches if the value of the {@code management.info..enabled} property is * {@code true}. Otherwise, use the specific {@link #fallback() fallback} method. * * @author Stephane Nicoll diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ConditionalOnEnabledMetricsExport.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ConditionalOnEnabledMetricsExport.java index 041f3db2fc..8220f2cf68 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ConditionalOnEnabledMetricsExport.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ConditionalOnEnabledMetricsExport.java @@ -25,11 +25,11 @@ import java.lang.annotation.Target; 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..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..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 diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java index 224d581182..aa863981cd 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java +++ b/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; diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java index dc90f50110..98905ec2f7 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java @@ -142,7 +142,7 @@ public class InvocationContext { } /** - * 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. diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Producible.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Producible.java index 32bdf8927f..605dd51060 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Producible.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Producible.java @@ -49,9 +49,9 @@ public interface Producible & Producible> { /** * Return if this enum value should be used as the default value when an accept header - * of */* 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 */* 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 */ diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/Link.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/Link.java index e4d5000b15..4c618b06e0 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/Link.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/Link.java @@ -52,7 +52,7 @@ public class Link { } /** - * 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() { diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java index 03ee4000cb..dff7575235 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java @@ -22,7 +22,7 @@ import reactor.core.publisher.Mono; * Strategy interface used to contribute {@link Health} to the results returned from the * reactive variant of the {@link HealthEndpoint}. *

- * 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 diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java index 34763a6fbc..75df5ee1de 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/startup/StartupTimeMetricsListenerTests.java @@ -84,9 +84,9 @@ class StartupTimeMetricsListenerTests { 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 diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java index 7d5ca163a1..2225771ebc 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java @@ -80,14 +80,13 @@ public @interface ConditionalOnBean { /** * 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[] 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 */ diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java index e640d47f45..3c834bd276 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java +++ b/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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java index 60595c000d..f485cb74e2 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java @@ -695,7 +695,7 @@ public class KafkaProperties { 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; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java index 8526773988..5b77de90a9 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java @@ -140,7 +140,7 @@ public abstract class JpaBaseConfiguration implements BeanFactoryAware { protected abstract Map 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 */ diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ConditionalOnEnabledResourceChain.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ConditionalOnEnabledResourceChain.java index f2637f5334..e09a468f31 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ConditionalOnEnabledResourceChain.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ConditionalOnEnabledResourceChain.java @@ -25,10 +25,9 @@ import java.lang.annotation.Target; 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 diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/OnEnabledResourceChainCondition.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/OnEnabledResourceChainCondition.java index 65d3564fcc..9112e929ac 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/OnEnabledResourceChainCondition.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/OnEnabledResourceChainCondition.java @@ -27,8 +27,7 @@ import org.springframework.core.type.AnnotatedTypeMetadata; 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 diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/neo4j/Neo4jAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/neo4j/Neo4jAutoConfigurationTests.java index 6903ff4ca1..53da528090 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/neo4j/Neo4jAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/neo4j/Neo4jAutoConfigurationTests.java @@ -141,7 +141,7 @@ class Neo4jAutoConfigurationTests { @Test @Deprecated - void determineServerUriWithCustoUriShouldTakePrecedenceOverDeprecatedProperty() { + void determineServerUriWithCustomUriShouldTakePrecedenceOverDeprecatedProperty() { URI customUri = URI.create("bolt://localhost:4242"); URI anotherCustomURI = URI.create("bolt://localhost:2424"); Neo4jProperties properties = new Neo4jProperties(); diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/ProjectGenerationRequest.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/ProjectGenerationRequest.java index f6751f7742..89cb108078 100644 --- a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/ProjectGenerationRequest.java +++ b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/ProjectGenerationRequest.java @@ -105,9 +105,8 @@ class ProjectGenerationRequest { } /** - * 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 @@ class ProjectGenerationRequest { } /** - * 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() { diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/run/SpringApplicationRunner.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/run/SpringApplicationRunner.java index 8444ab694c..bca9fc3c81 100644 --- a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/run/SpringApplicationRunner.java +++ b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/run/SpringApplicationRunner.java @@ -96,7 +96,7 @@ public class SpringApplicationRunner { 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(); diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java index 6b9e221957..34f98b2a4a 100644 --- a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java +++ b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java @@ -143,7 +143,7 @@ public abstract class AstUtils { * 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) { diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyCustomizer.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyCustomizer.java index 982b7ad834..fcd9d44da4 100644 --- a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyCustomizer.java +++ b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyCustomizer.java @@ -105,8 +105,8 @@ public class DependencyCustomizer { } /** - * 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} */ diff --git a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java index 28fff62bc5..a7830a50c5 100644 --- a/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java +++ b/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java @@ -327,7 +327,7 @@ public class Restarter { } 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(); diff --git a/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/server/RestartServerTests.java b/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/server/RestartServerTests.java index 3209d41fc1..049c3cc6e9 100644 --- a/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/server/RestartServerTests.java +++ b/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/server/RestartServerTests.java @@ -89,7 +89,7 @@ class RestartServerTests { @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); diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCaptureRule.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCaptureRule.java index 50536bfa0e..0ffb660173 100644 --- a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCaptureRule.java +++ b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/system/OutputCaptureRule.java @@ -29,7 +29,7 @@ import org.junit.runners.model.Statement; 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}. *

* To use add as a {@link Rule @Rule}: * diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/client/TestRestTemplate.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/client/TestRestTemplate.java index 15193399bb..2fa23c09ab 100644 --- a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/client/TestRestTemplate.java +++ b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/client/TestRestTemplate.java @@ -56,7 +56,7 @@ import org.springframework.web.util.UriTemplateHandler; /** * 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}. *

@@ -641,12 +641,12 @@ public class TestRestTemplate { } /** - * Return the value of the Allow header for the given URI. + * Return the value of the {@code Allow} header for the given URI. *

* 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 optionsForAllow(String url, Object... urlVariables) { @@ -654,12 +654,12 @@ public class TestRestTemplate { } /** - * Return the value of the Allow header for the given URI. + * Return the value of the {@code Allow} header for the given URI. *

* 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 optionsForAllow(String url, Map urlVariables) { @@ -667,9 +667,9 @@ public class TestRestTemplate { } /** - * 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 optionsForAllow(URI url) { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/ImageArchive.java b/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/ImageArchive.java index 01e2225604..2cd6456b92 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/ImageArchive.java +++ b/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 class ImageArchive implements TarArchive { } /** - * Return the create data of the archive. + * Return the create date of the archive. * @return the create date */ public Instant getCreateDate() { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/VolumeName.java b/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/VolumeName.java index 8a01d88a18..8df745aab7 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/VolumeName.java +++ b/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 final class VolumeName { * 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)); diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONArray.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONArray.java index ebd63c4be0..99c511328c 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONArray.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONArray.java @@ -632,13 +632,13 @@ public class JSONArray { } /** - * Encodes this array as a human readable JSON string for debugging, such as:

+	 * Encodes this array as a human-readable JSON string for debugging, such as: 
 	 * [
 	 *     94043,
 	 *     90210
 	 * ]
* @param indentSpaces the number of spaces to indent for each level of nesting. - * @return a human readable JSON string of this array + * @return a human-readable JSON string of this array * @throws JSONException if processing of json failed */ public String toString(int indentSpaces) throws JSONException { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONObject.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONObject.java index b7a34606bb..3f100dc484 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONObject.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONObject.java @@ -708,7 +708,7 @@ public class JSONObject { } /** - * Encodes this object as a human readable JSON string for debugging, such as:
+	 * Encodes this object as a human-readable JSON string for debugging, such as: 
 	 * {
 	 *     "query": "Pizza",
 	 *     "locations": [
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONStringer.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONStringer.java
index 8292d1aa5e..3e62a220c7 100644
--- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONStringer.java
+++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONStringer.java
@@ -64,7 +64,7 @@ public class JSONStringer {
 
 	/**
 	 * Lexical scoping elements within this stringer, necessary to insert the appropriate
-	 * separator characters (ie. commas and colons) and to detect nesting errors.
+	 * separator characters (i.e. commas and colons) and to detect nesting errors.
 	 */
 	enum Scope {
 
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONTokener.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONTokener.java
index d9f12984bf..e55281c706 100644
--- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONTokener.java
+++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONTokener.java
@@ -34,7 +34,7 @@ package org.springframework.boot.configurationprocessor.json;
  * 

* For best interoperability and performance use JSON that complies with RFC 4627, such as * that generated by {@link JSONStringer}. For legacy reasons this parser is lenient, so a - * successful parse does not indicate that the input string was valid JSON. All of the + * successful parse does not indicate that the input string was valid JSON. All the * following syntax errors will be ignored: *

    *
  • End of line comments starting with {@code //} or {@code #} and ending with a diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java index 1be7254e14..340c9e1f9f 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java @@ -375,8 +375,8 @@ public abstract class AbstractJarWriter implements LoaderClassesWriter { } /** - * An {@code UnpackHandler} determines whether or not unpacking is required and - * provides a SHA1 hash if required. + * An {@code UnpackHandler} determines whether unpacking is required and provides a + * SHA-1 hash if required. */ interface UnpackHandler { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Digest.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Digest.java index 4da1899b09..e87204b1ba 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Digest.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Digest.java @@ -32,9 +32,9 @@ final class Digest { } /** - * Return the SHA1 digest from the supplied stream. + * Return the SHA-1 digest from the supplied stream. * @param supplier the stream supplier - * @return the SHA1 digest + * @return the SHA-1 digest * @throws IOException on IO error */ static String sha1(InputStreamSupplier supplier) throws IOException { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java index d68f077aae..8feef780f3 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java @@ -52,7 +52,7 @@ public abstract class FileUtils { } /** - * Generate a SHA.1 Hash for a given file. + * Generate a SHA-1 Hash for a given file. * @param file the file to hash * @return the hash value as a String * @throws IOException if the file cannot be read diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java index 05baa33f84..f03d740d44 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java @@ -163,8 +163,8 @@ public abstract class Packager { } /** - * Sets the {@link File} to use to backup the original source. - * @param backupFile the file to use to backup the original source + * Sets the {@link File} to use to back up the original source. + * @param backupFile the file to use to back up the original source */ protected void setBackupFile(File backupFile) { this.backupFile = backupFile; @@ -320,8 +320,8 @@ public abstract class Packager { } /** - * Return the {@link File} to use to backup the original source. - * @return the file to use to backup the original source + * Return the {@link File} to use to back up the original source. + * @return the file to use to back up the original source */ public final File getBackupFile() { if (this.backupFile != null) { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java b/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java index 07fad13e0b..d57edba416 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java @@ -145,7 +145,7 @@ public abstract class ExecutableArchiveLauncher extends Launcher { protected abstract boolean isNestedArchive(Archive.Entry entry); /** - * Return if post processing needs to be applied to the archives. For back + * Return if post-processing needs to be applied to the archives. For back * compatibility this method returns {@code true}, but subclasses that don't override * {@link #postProcessClassPathArchives(List)} should provide an implementation that * returns {@code false}. @@ -160,7 +160,7 @@ public abstract class ExecutableArchiveLauncher extends Launcher { * Called to post-process archive entries before they are used. Implementations can * add and remove entries. * @param archives the archives - * @throws Exception if the post processing fails + * @throws Exception if the post-processing fails * @see #isPostProcessingClassPathArchives() */ protected void postProcessClassPathArchives(List archives) throws Exception { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java b/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java index a84c01139e..1b4dde6215 100755 --- a/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java @@ -127,7 +127,7 @@ public class PropertiesLauncher extends Launcher { public static final String CONFIG_LOCATION = "loader.config.location"; /** - * Properties key for boolean flag (default false) which if set will cause the + * Properties key for boolean flag (default false) which, if set, will cause the * external configuration properties to be copied to System properties (assuming that * is allowed by Java security). */ diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java index fa8ef92529..c70ef3e8d4 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java @@ -281,8 +281,8 @@ public class BuildImageMojo extends AbstractPackagerMojo { } /** - * Return the {@link File} to use to backup the original source. - * @return the file to use to backup the original source + * Return the {@link File} to use to back up the original source. + * @return the file to use to back up the original source */ private File getBackupFile() { Artifact source = getSourceArtifact(null); diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java index a254a9833c..69d9d9b905 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java @@ -66,7 +66,7 @@ public class StopMojo extends AbstractMojo { private String jmxName; /** - * The port to use to lookup the platform MBeanServer if the application has been + * The port to use to look up the platform MBeanServer if the application has been * forked. */ @Parameter(defaultValue = "9001") diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/DefaultPropertiesPropertySource.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/DefaultPropertiesPropertySource.java index c7c47a1150..c6fe465103 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/DefaultPropertiesPropertySource.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/DefaultPropertiesPropertySource.java @@ -61,8 +61,8 @@ public class DefaultPropertiesPropertySource extends MapPropertySource { } /** - * Create a consume a new {@link DefaultPropertiesPropertySource} instance if the - * provided source is not empty. + * Create a new {@link DefaultPropertiesPropertySource} instance if the provided + * source is not empty. * @param source the {@code Map} source * @param action the action used to consume the * {@link DefaultPropertiesPropertySource} diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java index 2b08f2bae3..f570df3bb6 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java @@ -147,8 +147,8 @@ public class SpringApplicationBuilder { /** * Create an application context (and its parent if specified) with the command line - * args provided. The parent is run first with the same arguments if has not yet been - * started. + * args provided. The parent is run first with the same arguments if it has not yet + * been started. * @param args the command line arguments * @return an application context created from the current state */ diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java index a2ce0a443b..c5ca91ebb0 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java @@ -96,7 +96,7 @@ public class CloudFoundryVcapEnvironmentPostProcessor implements EnvironmentPost private final Log logger; - // Before ConfigFileApplicationListener so values there can use these ones + // Before ConfigFileApplicationListener so values there can use these private int order = ConfigDataEnvironmentPostProcessor.ORDER - 1; /** diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentContributor.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentContributor.java index 6899c8b1a8..c417505730 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentContributor.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentContributor.java @@ -35,8 +35,8 @@ import org.springframework.util.CollectionUtils; /** * A single element that may directly or indirectly contribute configuration data to the - * {@link Environment}. There are several different {@link Kind kinds} of contributor, all - * are immutable and will be replaced with new versions as imports are processed. + * {@link Environment}. There are several {@link Kind kinds} of contributor, all are + * immutable and will be replaced with new versions as imports are processed. *

    * Contributors may provide a set of imports that should be processed and ultimately * turned into children. There are two distinct import phases: diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java index 79d1ec5d95..046ae416f8 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java @@ -125,7 +125,7 @@ public class EventPublishingRunListener implements SpringApplicationRunListener, } else { // An inactive context may not have a multicaster so we use our multicaster to - // call all of the context's listeners instead + // call all the context's listeners instead if (context instanceof AbstractApplicationContext) { for (ApplicationListener listener : ((AbstractApplicationContext) context) .getApplicationListeners()) { diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java index d381e5591a..8331f35bdd 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java @@ -62,7 +62,7 @@ public enum DatabaseDriver { "SELECT COUNT(*) FROM INFORMATION_SCHEMA.SYSTEM_USERS"), /** - * SQL Lite. + * SQLite. */ SQLITE("SQLite", "org.sqlite.JDBC"), diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/r2dbc/EmbeddedDatabaseConnection.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/r2dbc/EmbeddedDatabaseConnection.java index f7f224415e..249eeb2171 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/r2dbc/EmbeddedDatabaseConnection.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/r2dbc/EmbeddedDatabaseConnection.java @@ -25,7 +25,7 @@ import org.springframework.util.Assert; import org.springframework.util.ClassUtils; /** - * Connection details for embedded databases compatible with r2dbc. + * Connection details for embedded databases compatible with R2DBC. * * @author Mark Paluch * @author Stephane Nicoll diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/system/ApplicationTemp.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/system/ApplicationTemp.java index 9be31b9d96..527e6a57a0 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/system/ApplicationTemp.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/system/ApplicationTemp.java @@ -81,9 +81,9 @@ public class ApplicationTemp { } /** - * Return a sub-directory of the application temp. - * @param subDir the sub-directory name - * @return a sub-directory + * Return a subdirectory of the application temp. + * @param subDir the subdirectory name + * @return a subdirectory */ public File getDir(String subDir) { return createDirectory(getPath().resolve(subDir)).toFile(); diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/jetty/JettyServletWebServerFactory.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/jetty/JettyServletWebServerFactory.java index fca6159979..daa8cb8a41 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/jetty/JettyServletWebServerFactory.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/jetty/JettyServletWebServerFactory.java @@ -479,7 +479,7 @@ public class JettyServletWebServerFactory extends AbstractServletWebServerFactor /** * Returns a mutable collection of Jetty {@link JettyServerCustomizer}s that will be - * applied to the {@link Server} before the it is created. + * applied to the {@link Server} before it is created. * @return the {@link JettyServerCustomizer}s */ public Collection getServerCustomizers() { @@ -694,13 +694,13 @@ public class JettyServletWebServerFactory extends AbstractServletWebServerFactor @Override public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { - HttpServletResponse wrappedResponse = new ResposeWrapper(response); + HttpServletResponse wrappedResponse = new ResponseWrapper(response); super.handle(target, baseRequest, request, wrappedResponse); } - class ResposeWrapper extends HttpServletResponseWrapper { + class ResponseWrapper extends HttpServletResponseWrapper { - ResposeWrapper(HttpServletResponse response) { + ResponseWrapper(HttpServletResponse response) { super(response); } diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/AbstractServletWebServerFactory.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/AbstractServletWebServerFactory.java index b866fc27fc..672b9002c0 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/AbstractServletWebServerFactory.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/AbstractServletWebServerFactory.java @@ -277,7 +277,7 @@ public abstract class AbstractServletWebServerFactory extends AbstractConfigurab } /** - * Returns whether or not the JSP servlet should be registered with the web server. + * Returns whether the JSP servlet should be registered with the web server. * @return {@code true} if the servlet should be registered, otherwise {@code false} */ protected boolean shouldRegisterJspServlet() { diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/WithPublicObjectToObjectMethod.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/WithPublicObjectToObjectMethod.java index 06fed65459..c9f7a4edd2 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/WithPublicObjectToObjectMethod.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/WithPublicObjectToObjectMethod.java @@ -19,7 +19,7 @@ package org.springframework.boot.context.properties; import java.util.Optional; /** - * Data object with a pubic method picked up by the {@code ObjectToObjectConverter}. Used + * Data object with a public method picked up by the {@code ObjectToObjectConverter}. Used * in {@link ConfigurationPropertiesTests}. * * @author Phillip Webb diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/BinderTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/BinderTests.java index 388348bf9a..46a53060f1 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/BinderTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/BinderTests.java @@ -76,7 +76,7 @@ class BinderTests { } @Test - void creatWhenSourcesIsNullIterableShouldThrowException() { + void createWhenSourcesIsNullIterableShouldThrowException() { assertThatIllegalArgumentException().isThrownBy(() -> new Binder((Iterable) null)) .withMessageContaining("Sources must not be null"); } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/ConfigurationPropertyNameTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/ConfigurationPropertyNameTests.java index addb9efc57..11ca1d56b3 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/ConfigurationPropertyNameTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/ConfigurationPropertyNameTests.java @@ -718,7 +718,7 @@ class ConfigurationPropertyNameTests { void hashCodeIsStored() { ConfigurationPropertyName name = ConfigurationPropertyName.of("hash.code"); int hashCode = name.hashCode(); - // hasFieldOrPropertyWithValue would lookup for hashCode() + // hasFieldOrPropertyWithValue would look up for hashCode() assertThat(ReflectionTestUtils.getField(name, "hashCode")).isEqualTo(hashCode); } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java index f1e6a1adfb..53844e71dd 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java @@ -56,7 +56,7 @@ class DatabaseDriverClassNameTests { } private List getInterfaceNames(String className) throws IOException { - // Use ASM to avoid unwanted side-effects of loading JDBC drivers + // Use ASM to avoid unwanted side effects of loading JDBC drivers ClassReader classReader = new ClassReader(getClass().getResourceAsStream("/" + className + ".class")); List interfaceNames = new ArrayList<>(); for (String name : classReader.getInterfaces()) { diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/AnnotationConfigServletWebServerApplicationContextTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/AnnotationConfigServletWebServerApplicationContextTests.java index 756fcecba3..6293dd1e63 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/AnnotationConfigServletWebServerApplicationContextTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/AnnotationConfigServletWebServerApplicationContextTests.java @@ -119,7 +119,7 @@ class AnnotationConfigServletWebServerApplicationContextTests { ServletContextAwareEmbeddedConfiguration.class); verifyContext(); // You can't initialize the application context and inject the servlet context - // because of a cycle - we'd like this to be not null but it never will be + // because of a cycle - we'd like this to be not null, but it never will be assertThat(this.context.getBean(ServletContextAwareEmbeddedConfiguration.class).getServletContext()).isNull(); } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java index 60cbafa3ee..418fd529d1 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java @@ -111,7 +111,7 @@ class ServletWebServerApplicationContextTests { addWebServerFactoryBean(); this.context.refresh(); MockServletWebServerFactory factory = getWebServerFactory(); - // Ensure that the context has been setup + // Ensure that the context has been set up assertThat(this.context.getServletContext()).isEqualTo(factory.getServletContext()); then(factory.getServletContext()).should() .setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context); @@ -125,7 +125,7 @@ class ServletWebServerApplicationContextTests { @Test void doesNotRegistersShutdownHook() { // See gh-314 for background. We no longer register the shutdown hook - // since it is really the callers responsibility. The shutdown hook could + // since it is really the caller's responsibility. The shutdown hook could // also be problematic in a classic WAR deployment. addWebServerFactoryBean(); this.context.refresh();