root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Fix typos in code and documentation 

See gh-31734
This commit is contained in:
Marc Wrobel 2022-07-14 15:10:20 +02:00 committed by Phillip Webb
parent 4bcec6e0ee
commit dbfc6bded4
59 changed files with 102 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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
*/

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

@ -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
*/

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

@ -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);
}

4
buildSrc/src/test/resources/plugin.xml
View File

@ -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>

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

@ -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.<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.
*

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

@ -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<>();

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

@ -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.<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

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

@ -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.<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

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

@ -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;

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

@ -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.

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

@ -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
*/

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

@ -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() {

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

@ -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}.
* <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

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

@ -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

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

@ -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<? 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
*/

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

@ -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;

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

@ -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;

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

@ -140,7 +140,7 @@ public abstract class JpaBaseConfiguration implements BeanFactoryAware {
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
*/

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

@ -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

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

@ -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

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

@ -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();

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

@ -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() {

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

@ -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();

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

@ -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) {

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

@ -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}
*/

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

@ -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();

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

@ -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);

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

@ -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}.
* <p>
* To use add as a {@link Rule @Rule}:
*

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

@ -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}.
* <p>
@ -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.
* <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) {
@ -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.
* <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) {
@ -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<HttpMethod> optionsForAllow(URI url) {

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

@ -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() {

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

@ -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));

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONArray.java
View File

@ -632,13 +632,13 @@ public class JSONArray {
}
/**
* Encodes this array as a human readable JSON string for debugging, such as: <pre>
* Encodes this array as a human-readable JSON string for debugging, such as: <pre>
* [
* 94043,
* 90210
* ]</pre>
* @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 {

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONObject.java
View File

@ -708,7 +708,7 @@ public class JSONObject {
}
/**
* Encodes this object as a human readable JSON string for debugging, such as: <pre>
* Encodes this object as a human-readable JSON string for debugging, such as: <pre>
* {
* "query": "Pizza",
* "locations": [

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONStringer.java
View File

@ -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 {

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/json-shade/java/org/springframework/boot/configurationprocessor/json/JSONTokener.java
View File

@ -34,7 +34,7 @@ package org.springframework.boot.configurationprocessor.json;
* <p>
* 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:
* <ul>
* <li>End of line comments starting with {@code //} or {@code #} and ending with a

4
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java
View File

@ -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 {

4
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Digest.java
View File

@ -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 {

2
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/FileUtils.java
View File

@ -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

8
spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Packager.java
View File

@ -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) {

4
spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/ExecutableArchiveLauncher.java
View File

@ -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<Archive> archives) throws Exception {

2
spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
View File

@ -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).
*/

4
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/BuildImageMojo.java
View File

@ -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);

2
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java
View File

@ -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")

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/DefaultPropertiesPropertySource.java
View File

@ -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}

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java
View File

@ -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
*/

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java
View File

@ -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;
/**

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataEnvironmentContributor.java
View File

@ -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.
* <p>
* Contributors may provide a set of imports that should be processed and ultimately
* turned into children. There are two distinct import phases:

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/event/EventPublishingRunListener.java
View File

@ -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()) {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java
View File

@ -62,7 +62,7 @@ public enum DatabaseDriver {
"SELECT COUNT(*) FROM INFORMATION_SCHEMA.SYSTEM_USERS"),
/**
* SQL Lite.
* SQLite.
*/
SQLITE("SQLite", "org.sqlite.JDBC"),

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/r2dbc/EmbeddedDatabaseConnection.java
View File

@ -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

6
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/system/ApplicationTemp.java
View File

@ -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();

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/jetty/JettyServletWebServerFactory.java
View File

@ -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<JettyServerCustomizer> 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);
}

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/server/AbstractServletWebServerFactory.java
View File

@ -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() {

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/WithPublicObjectToObjectMethod.java
View File

@ -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

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/BinderTests.java
View File

@ -76,7 +76,7 @@ class BinderTests {
}
@Test
void creatWhenSourcesIsNullIterableShouldThrowException() {
void createWhenSourcesIsNullIterableShouldThrowException() {
assertThatIllegalArgumentException().isThrownBy(() -> new Binder((Iterable<ConfigurationPropertySource>) null))
.withMessageContaining("Sources must not be null");
}

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/ConfigurationPropertyNameTests.java
View File

@ -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);
}

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DatabaseDriverClassNameTests.java
View File

@ -56,7 +56,7 @@ class DatabaseDriverClassNameTests {
}
private List<String> 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<String> interfaceNames = new ArrayList<>();
for (String name : classReader.getInterfaces()) {

2
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/AnnotationConfigServletWebServerApplicationContextTests.java
View File

@ -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();
}

4
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java
View File

@ -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();