Merge pull request #27940 from dreis2211

* pr/27940:
  Polish

Closes gh-27940
pull/28078/head
Stephane Nicoll 3 years ago
commit 01cf19702b

@ -57,7 +57,7 @@ import org.springframework.boot.build.toolchain.ToolchainPlugin;
* plugin is applied:
*
* <ul>
* <li>The project is configered with source and target compatibility of 1.8
* <li>The project is configured with source and target compatibility of 1.8
* <li>{@link SpringJavaFormatPlugin Spring Java Format}, {@link CheckstylePlugin
* Checkstyle}, {@link TestFailuresPlugin Test Failures}, and {@link TestRetryPlugin Test
* Retry} plugins are applied

@ -502,7 +502,7 @@ public class ConfigurationPropertiesReportEndpoint implements ApplicationContext
AnnotatedMethod setter = findSetter(beanDesc, writer);
// If there's a setter, we assume it's OK to report on the value,
// similarly, if there's no setter but the package names match, we assume
// that its a nested class used solely for binding to config props, so it
// that it is a nested class used solely for binding to config props, so it
// should be kosher. Lists and Maps are also auto-detected by default since
// that's what the metadata generator does. This filter is not used if there
// is JSON metadata for the property, so it's mainly for user-defined beans.

@ -27,7 +27,7 @@ package org.springframework.boot.actuate.endpoint;
public interface SanitizingFunction {
/**
* Apply the sanitiing function to the given data.
* Apply the sanitizing function to the given data.
* @param data the data to sanitize
* @return the sanitized data or the original instance is no sanitization is applied
*/

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -34,7 +34,7 @@ public interface OperationInvokerAdvisor {
* @param operationType the operation type
* @param parameters the operation parameters
* @param invoker the invoker to advise
* @return an potentially new operation invoker with support for additional features
* @return a potentially new operation invoker with support for additional features
*/
OperationInvoker apply(EndpointId endpointId, OperationType operationType, OperationParameters parameters,
OperationInvoker invoker);

@ -194,7 +194,7 @@ public class EnvironmentEndpoint {
}
/**
* Apply sanitiation to the given name and value.
* Apply sanitization to the given name and value.
* @param key the name to sanitize
* @param value the value to sanitize
* @return the sanitized value

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -19,7 +19,7 @@ package org.springframework.boot.actuate.health;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
/**
* An component that contributes data to results returned from the {@link HealthEndpoint}.
* A component that contributes data to results returned from the {@link HealthEndpoint}.
*
* @author Phillip Webb
* @since 2.2.0

@ -57,7 +57,7 @@ public class RabbitConnectionFactoryBeanConfigurer {
/**
* Configure the specified rabbit connection factory bean. The factory bean can be
* further tuned and default settings can be overridden. It is the repsonsiblity of
* further tuned and default settings can be overridden. It is the responsibility of
* the caller to invoke {@link RabbitConnectionFactoryBean#afterPropertiesSet()}
* though.
* @param factory the {@link RabbitConnectionFactoryBean} instance to configure

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -20,7 +20,7 @@ import org.springframework.http.server.ServerHttpRequest;
import org.springframework.util.Assert;
/**
* {@link AccessManager} that checks for the presence of a HTTP header secret.
* {@link AccessManager} that checks for the presence of an HTTP header secret.
*
* @author Rob Winch
* @author Phillip Webb

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -34,7 +34,7 @@ public class HttpStatusHandler implements Handler {
private final HttpStatus status;
/**
* Create a new {@link HttpStatusHandler} instance that will respond with a HTTP OK
* Create a new {@link HttpStatusHandler} instance that will respond with an HTTP OK
* 200 status.
*/
public HttpStatusHandler() {

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -23,7 +23,7 @@ import java.util.Set;
import org.springframework.util.ClassUtils;
/**
* Utility to determine if an Java agent based reloader (e.g. JRebel) is being used.
* Utility to determine if a Java agent based reloader (e.g. JRebel) is being used.
*
* @author Phillip Webb
* @since 1.3.0

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -29,7 +29,7 @@ import org.springframework.http.server.ServerHttpResponse;
import org.springframework.util.Assert;
/**
* A HTTP server that can be used to upload updated {@link ClassLoaderFiles} and trigger
* An HTTP server that can be used to upload updated {@link ClassLoaderFiles} and trigger
* restarts.
*
* @author Phillip Webb

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -15,6 +15,6 @@
*/
/**
* Classes to deal with payloads sent over a HTTP tunnel.
* Classes to deal with payloads sent over an HTTP tunnel.
*/
package org.springframework.boot.devtools.tunnel.payload;

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -354,7 +354,7 @@ public class HttpTunnelServer {
}
/**
* Encapsulates a HTTP request/response pair.
* Encapsulates an HTTP request/response pair.
*/
protected static class HttpConnection {
@ -446,7 +446,7 @@ public class HttpTunnelServer {
}
/**
* Send a HTTP status response.
* Send an HTTP status response.
* @param status the status to send
* @throws IOException in case of I/O errors
*/

@ -947,7 +947,7 @@ Metrics are published under the `spring.integration.` meter name.
[[actuator.metrics.supported.kafka]]
==== Kafka Metrics
Auto-configuration registers a `MicrometerConsumerListener` and `MicrometerProducerListener` for the auto-configured consumer factory and producer factory, respectively.
It alsos registers a `KafkaStreamsMicrometerListener` for `StreamsBuilderFactoryBean`.
It also registers a `KafkaStreamsMicrometerListener` for `StreamsBuilderFactoryBean`.
For more detail, see the {spring-kafka-docs}#micrometer-native[Micrometer Native Metrics] section of the Spring Kafka documentation.

@ -1,6 +1,6 @@
[[web.servlet]]
== Servlet Web Applications
If you're looking to build servlet-based web applications, you can take advantange of Spring Boot's auto-configuration for Spring MVC or Jersey.
If you're looking to build servlet-based web applications, you can take advantage of Spring Boot's auto-configuration for Spring MVC or Jersey.
[[web.servlet.spring-mvc]]
=== The "`Spring Web MVC Framework`"

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -46,7 +46,7 @@ public class TestEntityManager {
}
/**
* Make an instance managed and persistent then return it's ID. Delegates to
* Make an instance managed and persistent then return its ID. Delegates to
* {@link EntityManager#persist(Object)} then {@link #getId(Object)}.
* <p>
* Helpful when setting up test data in a test: <pre class="code">
@ -61,7 +61,7 @@ public class TestEntityManager {
}
/**
* Make an instance managed and persistent then return it's ID. Delegates to
* Make an instance managed and persistent then return its ID. Delegates to
* {@link EntityManager#persist(Object)} then {@link #getId(Object, Class)}.
* <p>
* Helpful when setting up test data in a test: <pre class="code">

@ -17,7 +17,7 @@
package org.springframework.boot.buildpack.platform.build;
/**
* Strategy inerface used to resolve a {@link BuildpackReference} to a {@link Buildpack}.
* Strategy interface used to resolve a {@link BuildpackReference} to a {@link Buildpack}.
*
* @author Scott Frederick
* @author Phillip Webb

@ -27,7 +27,7 @@ import org.springframework.boot.buildpack.platform.io.Content;
import org.springframework.boot.buildpack.platform.io.Owner;
/**
* An short lived builder that is created for each {@link Lifecycle} run.
* A short lived builder that is created for each {@link Lifecycle} run.
*
* @author Phillip Webb
* @author Scott Frederick

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -66,7 +66,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP GET operation.
* Perform an HTTP GET operation.
* @param uri the destination URI
* @return the operation response
*/
@ -76,7 +76,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI
* @return the operation response
*/
@ -86,7 +86,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI
* @param registryAuth registry authentication credentials
* @return the operation response
@ -97,7 +97,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI
* @param contentType the content type to write
* @param writer a content writer
@ -109,7 +109,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP PUT operation.
* Perform an HTTP PUT operation.
* @param uri the destination URI
* @param contentType the content type to write
* @param writer a content writer
@ -121,7 +121,7 @@ abstract class HttpClientTransport implements HttpTransport {
}
/**
* Perform a HTTP DELETE operation.
* Perform an HTTP DELETE operation.
* @param uri the destination URI
* @return the operation response
*/

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -37,7 +37,7 @@ import org.springframework.boot.buildpack.platform.system.Environment;
public interface HttpTransport {
/**
* Perform a HTTP GET operation.
* Perform an HTTP GET operation.
* @param uri the destination URI (excluding any host/port)
* @return the operation response
* @throws IOException on IO error
@ -45,7 +45,7 @@ public interface HttpTransport {
Response get(URI uri) throws IOException;
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI (excluding any host/port)
* @return the operation response
* @throws IOException on IO error
@ -53,7 +53,7 @@ public interface HttpTransport {
Response post(URI uri) throws IOException;
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI (excluding any host/port)
* @param registryAuth registry authentication credentials
* @return the operation response
@ -62,7 +62,7 @@ public interface HttpTransport {
Response post(URI uri, String registryAuth) throws IOException;
/**
* Perform a HTTP POST operation.
* Perform an HTTP POST operation.
* @param uri the destination URI (excluding any host/port)
* @param contentType the content type to write
* @param writer a content writer
@ -72,7 +72,7 @@ public interface HttpTransport {
Response post(URI uri, String contentType, IOConsumer<OutputStream> writer) throws IOException;
/**
* Perform a HTTP PUT operation.
* Perform an HTTP PUT operation.
* @param uri the destination URI (excluding any host/port)
* @param contentType the content type to write
* @param writer a content writer
@ -82,7 +82,7 @@ public interface HttpTransport {
Response put(URI uri, String contentType, IOConsumer<OutputStream> writer) throws IOException;
/**
* Perform a HTTP DELETE operation.
* Perform an HTTP DELETE operation.
* @param uri the destination URI (excluding any host/port)
* @return the operation response
* @throws IOException on IO error

@ -110,7 +110,7 @@ class LombokMetadataGenerationTests extends AbstractMetadataGenerationTests {
// For some reason the annotation processor resolves a type for SimpleLombokPojo
// that is resolved (compiled) and the source annotations are gone. Because we
// don't see the @Data annotation anymore, no field is harvested. What is crazy is
// that a sample project works fine so this seem to be related to the unit test
// that a sample project works fine so this seems to be related to the unit test
// environment for some reason. assertThat(metadata,
// containsProperty("config.third.value"));
assertThat(metadata).has(Metadata.withProperty("config.fourth"));

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -19,7 +19,7 @@ package org.springframework.boot.configurationsample.endpoint;
import org.springframework.boot.configurationsample.Endpoint;
/**
* An endpoint with a upper camel case id.
* An endpoint with an upper camel case id.
*
* @author Stephane Nicoll
*/

@ -392,7 +392,7 @@ include::../gradle/packaging/boot-build-image-docker-host.gradle[tags=docker-hos
include::../gradle/packaging/boot-build-image-docker-host.gradle.kts[tags=docker-host]
----
If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.buiderRegistry` properties as shown in the following example:
If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.builderRegistry` properties as shown in the following example:
[source,groovy,indent=0,subs="verbatim,attributes",role="primary"]
.Groovy

@ -55,7 +55,7 @@ import org.springframework.boot.loader.tools.Libraries;
import org.springframework.util.StringUtils;
/**
* Package an application into a OCI image using a buildpack.
* Package an application into an OCI image using a buildpack.
*
* @author Phillip Webb
* @author Scott Frederick

@ -175,7 +175,7 @@ public interface BootstrapRegistry {
SINGLETON,
/**
* A prototype instance. The {@link InstanceSupplier} will be called whenver an
* A prototype instance. The {@link InstanceSupplier} will be called whenever an
* instance is needed.
*/
PROTOTYPE

@ -221,7 +221,7 @@ class ConfigDataEnvironmentContributor implements Iterable<ConfigDataEnvironment
}
/**
* Create an new {@link ConfigDataEnvironmentContributor} with bound
* Create a new {@link ConfigDataEnvironmentContributor} with bound
* {@link ConfigDataProperties}.
* @param binder the binder to use
* @return a new contributor instance
@ -305,7 +305,7 @@ class ConfigDataEnvironmentContributor implements Iterable<ConfigDataEnvironment
}
/**
* Create a new {@link ConfigDataEnvironmentContributor} instance where a existing
* Create a new {@link ConfigDataEnvironmentContributor} instance where an existing
* child is replaced.
* @param existing the existing node that should be replaced
* @param replacement the replacement node that should be used instead

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -72,7 +72,7 @@ public class ConfigDataResourceNotFoundException extends ConfigDataNotFoundExcep
/**
* Return the original location that was resolved to determine the resource.
* @return the location or {@code null} if no location is availble
* @return the location or {@code null} if no location is available
*/
public ConfigDataLocation getLocation() {
return this.location;

@ -20,7 +20,7 @@ import org.springframework.boot.env.PropertySourceLoader;
import org.springframework.util.StringUtils;
/**
* An reference expanded from the original {@link ConfigDataLocation} that can ultimately
* A reference expanded from the original {@link ConfigDataLocation} that can ultimately
* be resolved to one or more {@link StandardConfigDataResource resources}.
*
* @author Phillip Webb

@ -50,7 +50,7 @@ public class ApplicationEnvironmentPreparedEvent extends SpringApplicationEvent
}
/**
* Return the bootstap context.
* Return the bootstrap context.
* @return the bootstrap context
* @since 2.4.0
*/

@ -51,7 +51,7 @@ public class ApplicationStartingEvent extends SpringApplicationEvent {
}
/**
* Return the bootstap context.
* Return the bootstrap context.
* @return the bootstrap context
* @since 2.4.0
*/

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -66,7 +66,7 @@ class SoftReferenceConfigurationPropertyCache<T> implements ConfigurationPropert
}
/**
* Get an value from the cache, creating it if necessary.
* Get a value from the cache, creating it if necessary.
* @param factory a factory used to create the item if there is no reference to it.
* @param refreshAction action called to refresh the value if it has expired
* @return the value from the cache

@ -30,7 +30,7 @@ import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
/**
* Utility class that can resolve placholder text with the actual {@link DatabaseDriver}
* Utility class that can resolve placeholder text with the actual {@link DatabaseDriver}
* platform.
* <p>
* By default, the name of the platform is the {@link DatabaseDriver#getId ID of the
@ -70,7 +70,7 @@ public class PlatformPlaceholderDatabaseDriverResolver {
}
/**
* Creates a new {@code PlatformPlaceholdDatabaseDriverResolver} that will map the
* Creates a new {@link PlatformPlaceholderDatabaseDriverResolver} that will map the
* given {@code driver} to the given {@code platform}.
* @param driver the driver
* @param platform the platform

@ -15,7 +15,7 @@
*/
/**
* Support for initializaton of an SQL database using a JDBC {@link javax.sql.DataSource
* Support for initialization of an SQL database using a JDBC {@link javax.sql.DataSource
* DataSource}.
*/
package org.springframework.boot.jdbc.init;

@ -15,7 +15,7 @@
*/
/**
* Support for initializaton of an SQL database using an R2DBC
* Support for initialization of an SQL database using an R2DBC
* {@link io.r2dbc.spi.ConnectionFactory ConnectionFactory}.
*/
package org.springframework.boot.r2dbc.init;

@ -15,6 +15,6 @@
*/
/**
* Support for initializaton of an SQL database.
* Support for initialization of an SQL database.
*/
package org.springframework.boot.sql.init;

@ -93,7 +93,7 @@ public class MessageInterpolatorFactory implements ObjectFactory<MessageInterpol
return getFallback(fallback);
}
catch (Exception ex) {
// Swallow an continue
// Swallow and continue
}
}
return null;

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -94,7 +94,7 @@ class TomcatEmbeddedContext extends StandardContext {
* Some older Servlet frameworks (e.g. Struts, BIRT) use the Thread context class
* loader to create servlet instances in this phase. If they do that and then try to
* initialize them later the class loader may have changed, so wrap the call to
* loadOnStartup in what we think its going to be the main webapp classloader at
* loadOnStartup in what we think is going to be the main webapp classloader at
* runtime.
* @param classLoader the class loader to use
* @param code the code to run

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,7 +17,7 @@
package org.springframework.boot.web.server;
/**
* Exceptions thrown by an web server.
* Exceptions thrown by a web server.
*
* @author Phillip Webb
* @since 2.0.0

@ -336,9 +336,9 @@ public class ServletWebServerApplicationContext extends GenericWebApplicationCon
}
/**
* Utility class to store and restore any user defined scopes. This allow scopes to be
* registered in an ApplicationContextInitializer in the same way as they would in a
* classic non-embedded web application context.
* Utility class to store and restore any user defined scopes. This allows scopes to
* be registered in an ApplicationContextInitializer in the same way as they would in
* a classic non-embedded web application context.
*/
public static class ExistingWebApplicationScopes {

@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -109,7 +109,7 @@ public class WebServiceTemplateBuilder {
/**
* Set if a suitable HTTP-based {@link WebServiceMessageSender} should be detected
* based on the classpath. Default is {@code true}.
* @param detectHttpMessageSender if a HTTP-based {@link WebServiceMessageSender}
* @param detectHttpMessageSender if an HTTP-based {@link WebServiceMessageSender}
* should be detected
* @return a new builder instance
* @see HttpWebServiceMessageSenderBuilder

@ -19,7 +19,7 @@ package org.springframework.boot.context.embedded;
import java.io.File;
/**
* An pre-built application that can be launched.
* A pre-built application that can be launched.
*
* @author Andy Wilkinson
*/

Loading…
Cancel
Save