From 92b8e99cbc3af42133f69da7e0d52b949ca8ddf2 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Tue, 12 Jul 2022 12:20:39 +0200 Subject: [PATCH] Fix and improve Javadoc in spring-test Closes gh-28795 --- .../mock/http/client/MockClientHttpRequest.java | 2 +- .../mock/http/server/reactive/MockServerHttpRequest.java | 4 ++-- .../org/springframework/test/context/ActiveProfiles.java | 2 +- .../springframework/test/context/ContextHierarchy.java | 2 +- .../test/context/NestedTestConfiguration.java | 2 +- .../test/context/TestExecutionListeners.java | 4 ++-- .../springframework/test/context/TestPropertySource.java | 4 ++-- .../springframework/test/context/cache/ContextCache.java | 4 ++-- .../AbstractTransactionalJUnit4SpringContextTests.java | 4 ++-- .../test/context/support/AbstractContextLoader.java | 4 ++-- .../support/DependencyInjectionTestExecutionListener.java | 2 +- .../context/support/TestPropertySourceAttributes.java | 4 ++-- .../test/context/support/TestPropertySourceUtils.java | 4 ++-- .../AbstractTransactionalTestNGSpringContextTests.java | 4 ++-- .../test/context/transaction/TestTransaction.java | 4 ++-- .../transaction/TransactionalTestExecutionListener.java | 6 +++--- .../test/context/web/ServletTestExecutionListener.java | 2 +- .../org/springframework/test/web/ModelAndViewAssert.java | 4 ++-- .../web/client/AbstractRequestExpectationManager.java | 6 +++--- .../test/web/client/MockRestServiceServer.java | 2 +- .../test/web/client/RequestExpectationManager.java | 2 +- .../test/web/reactive/server/AbstractMockServerSpec.java | 2 +- .../test/web/reactive/server/ExchangeResult.java | 6 +++--- .../test/web/reactive/server/WebTestClient.java | 6 +++--- .../springframework/test/web/servlet/ResultActions.java | 2 +- .../test/web/servlet/SmartRequestBuilder.java | 2 +- .../test/web/servlet/TestDispatcherServlet.java | 2 +- .../web/servlet/client/AbstractMockMvcServerSpec.java | 4 ++-- .../servlet/request/MockHttpServletRequestBuilder.java | 8 ++++---- .../test/web/servlet/result/ContentResultMatchers.java | 8 ++++---- .../test/web/servlet/setup/StandaloneMockMvcBuilder.java | 2 +- .../test/context/junit/jupiter/DisabledOnMac.java | 2 +- .../test/context/junit/jupiter/EnabledOnMac.java | 2 +- .../test/context/junit/jupiter/event/PublishedEvents.java | 2 +- .../context/junit4/EmbeddedPersonDatabaseTestsConfig.java | 2 +- .../support/BootstrapTestUtilsMergedConfigTests.java | 2 +- .../test/web/reactive/server/MockServerTests.java | 2 +- 37 files changed, 63 insertions(+), 63 deletions(-) diff --git a/spring-test/src/main/java/org/springframework/mock/http/client/MockClientHttpRequest.java b/spring-test/src/main/java/org/springframework/mock/http/client/MockClientHttpRequest.java index 7630ac3a3b..009329e793 100644 --- a/spring-test/src/main/java/org/springframework/mock/http/client/MockClientHttpRequest.java +++ b/spring-test/src/main/java/org/springframework/mock/http/client/MockClientHttpRequest.java @@ -114,7 +114,7 @@ public class MockClientHttpRequest extends MockHttpOutputMessage implements Clie * The default implementation returns the configured * {@link #setResponse(ClientHttpResponse) response}. *

Override this method to execute the request and provide a response, - * potentially different than the configured response. + * potentially different from the configured response. */ protected ClientHttpResponse executeInternal() throws IOException { Assert.state(this.clientHttpResponse != null, "No ClientHttpResponse"); diff --git a/spring-test/src/main/java/org/springframework/mock/http/server/reactive/MockServerHttpRequest.java b/spring-test/src/main/java/org/springframework/mock/http/server/reactive/MockServerHttpRequest.java index 29b39931af..a1bf82124c 100644 --- a/spring-test/src/main/java/org/springframework/mock/http/server/reactive/MockServerHttpRequest.java +++ b/spring-test/src/main/java/org/springframework/mock/http/server/reactive/MockServerHttpRequest.java @@ -235,7 +235,7 @@ public final class MockServerHttpRequest extends AbstractServerHttpRequest { } /** - * Create a builder with a raw HTTP method value value that is outside the + * Create a builder with a raw HTTP method value that is outside the * range of {@link HttpMethod} enum values. * @param httpMethod the HTTP methodValue value * @param uri the URI template for target the URL @@ -254,7 +254,7 @@ public final class MockServerHttpRequest extends AbstractServerHttpRequest { /** * Request builder exposing properties not related to the body. - * @param the builder sub-class + * @param the builder subclass */ public interface BaseBuilder> { diff --git a/spring-test/src/main/java/org/springframework/test/context/ActiveProfiles.java b/spring-test/src/main/java/org/springframework/test/context/ActiveProfiles.java index 343ba5b985..dc5711b7fe 100644 --- a/spring-test/src/main/java/org/springframework/test/context/ActiveProfiles.java +++ b/spring-test/src/main/java/org/springframework/test/context/ActiveProfiles.java @@ -78,7 +78,7 @@ public @interface ActiveProfiles { Class resolver() default ActiveProfilesResolver.class; /** - * Whether or not bean definition profiles from superclasses and enclosing + * Whether bean definition profiles from superclasses and enclosing * classes should be inherited. *

The default value is {@code true}, which means that a test class will * inherit bean definition profiles defined by a test superclass or diff --git a/spring-test/src/main/java/org/springframework/test/context/ContextHierarchy.java b/spring-test/src/main/java/org/springframework/test/context/ContextHierarchy.java index f4cee11b4b..67822fea95 100644 --- a/spring-test/src/main/java/org/springframework/test/context/ContextHierarchy.java +++ b/spring-test/src/main/java/org/springframework/test/context/ContextHierarchy.java @@ -66,7 +66,7 @@ import java.lang.annotation.Target; * {@code SoapWebServiceTests} and {@code RestWebServiceTests} both extend * {@code AbstractWebTests} and define a context hierarchy via {@code @ContextHierarchy}. * The result is that three application contexts will be loaded (one for each - * declaration of {@code @ContextConfiguration}, and the application context + * declaration of {@code @ContextConfiguration}), and the application context * loaded based on the configuration in {@code AbstractWebTests} will be set as * the parent context for each of the contexts loaded for the concrete subclasses. * diff --git a/spring-test/src/main/java/org/springframework/test/context/NestedTestConfiguration.java b/spring-test/src/main/java/org/springframework/test/context/NestedTestConfiguration.java index f9d245f82d..74e7ec91a1 100644 --- a/spring-test/src/main/java/org/springframework/test/context/NestedTestConfiguration.java +++ b/spring-test/src/main/java/org/springframework/test/context/NestedTestConfiguration.java @@ -34,7 +34,7 @@ import org.springframework.lang.Nullable; * enclosing class hierarchies (i.e., for inner test classes). * *

If {@code @NestedTestConfiguration} is not present or - * meta-present on a test class, in its super type hierarchy, or in its + * meta-present on a test class, in its supertype hierarchy, or in its * enclosing class hierarchy, the default enclosing configuration inheritance * mode will be used. A {@code @NestedTestConfiguration} declaration on an * enclosing class for a nested interface will be ignored when searching for the diff --git a/spring-test/src/main/java/org/springframework/test/context/TestExecutionListeners.java b/spring-test/src/main/java/org/springframework/test/context/TestExecutionListeners.java index 56d221439e..0a0349a866 100644 --- a/spring-test/src/main/java/org/springframework/test/context/TestExecutionListeners.java +++ b/spring-test/src/main/java/org/springframework/test/context/TestExecutionListeners.java @@ -78,7 +78,7 @@ public @interface TestExecutionListeners { Class[] listeners() default {}; /** - * Whether or not {@link #listeners TestExecutionListeners} from superclasses + * Whether {@link #listeners TestExecutionListeners} from superclasses * and enclosing classes should be inherited. *

The default value is {@code true}, which means that an annotated class * will inherit the listeners defined by an annotated superclass or @@ -130,7 +130,7 @@ public @interface TestExecutionListeners { /** - * Enumeration of modes that dictate whether or not explicitly + * Enumeration of modes that dictate whether explicitly * declared listeners are merged with the default listeners when * {@code @TestExecutionListeners} is declared on a class that does * not inherit listeners from a superclass or enclosing diff --git a/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java b/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java index cdbdbc472b..4aa313d0e9 100644 --- a/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java +++ b/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java @@ -150,7 +150,7 @@ public @interface TestPropertySource { String[] locations() default {}; /** - * Whether or not test property source {@link #locations} from superclasses + * Whether test property source {@link #locations} from superclasses * and enclosing classes should be inherited. *

The default value is {@code true}, which means that a test class will * inherit property source locations defined by a superclass or @@ -230,7 +230,7 @@ public @interface TestPropertySource { String[] properties() default {}; /** - * Whether or not inlined test {@link #properties} from superclasses and + * Whether inlined test {@link #properties} from superclasses and * enclosing classes should be inherited. *

The default value is {@code true}, which means that a test class will * inherit inlined properties defined by a superclass or enclosing diff --git a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java index d961eaa37e..9987935c1e 100644 --- a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java +++ b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java @@ -36,7 +36,7 @@ import org.springframework.test.context.MergedContextConfiguration; * initialization is complex. Although the initialization of a Spring context * itself is typically very quick, some beans in a context — for example, * an embedded database or a {@code LocalContainerEntityManagerFactoryBean} for - * working with JPA — may take several seconds to initialize. Hence it + * working with JPA — may take several seconds to initialize. Hence, it * often makes sense to perform that initialization only once per test suite or * JVM process. * @@ -155,7 +155,7 @@ public interface ContextCache { void clear(); /** - * Clear hit and miss count statistics for the cache (i.e., reset counters to zero). + * Clear hit-and-miss count statistics for the cache (i.e., reset counters to zero). */ void clearStatistics(); diff --git a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java index 2c50715f26..5b2abc50e3 100644 --- a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java @@ -193,7 +193,7 @@ public abstract class AbstractTransactionalJUnit4SpringContextTests extends Abst } /** - * Convenience method for dropping all of the specified tables. + * Convenience method for dropping all the specified tables. *

Use with caution outside of a transaction! * @param names the names of the tables to drop * @since 3.2 @@ -209,7 +209,7 @@ public abstract class AbstractTransactionalJUnit4SpringContextTests extends Abst *

The script will normally be loaded by classpath. *

Do not use this method to execute DDL if you expect rollback. * @param sqlResourcePath the Spring resource path for the SQL script - * @param continueOnError whether or not to continue without throwing an + * @param continueOnError whether to continue without throwing an * exception in the event of an error * @throws DataAccessException if there is an error executing a statement * @see ResourceDatabasePopulator diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java index d1bcd3cbfc..611eedde25 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java @@ -284,13 +284,13 @@ public abstract class AbstractContextLoader implements SmartContextLoader { } /** - * Determine whether or not default resource locations should be + * Determine whether default resource locations should be * generated if the {@code locations} provided to * {@link #processLocations(Class, String...)} are {@code null} or empty. *

As of Spring 3.1, the semantics of this method have been overloaded * to include detection of either default resource locations or default * configuration classes. Consequently, this method can also be used to - * determine whether or not default configuration classes should be + * determine whether default configuration classes should be * detected if the {@code classes} present in the * {@link ContextConfigurationAttributes configuration attributes} supplied * to {@link #processContextConfiguration(ContextConfigurationAttributes)} diff --git a/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java index f757a363b2..43d6e7afa3 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java @@ -35,7 +35,7 @@ public class DependencyInjectionTestExecutionListener extends AbstractTestExecut /** * Attribute name for a {@link TestContext} attribute which indicates - * whether or not the dependencies of a test instance should be + * whether the dependencies of a test instance should be * reinjected in * {@link #beforeTestMethod(TestContext) beforeTestMethod()}. Note that * dependencies will be injected in diff --git a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceAttributes.java b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceAttributes.java index 84362fcc0f..216bfe80bc 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceAttributes.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceAttributes.java @@ -132,9 +132,9 @@ class TestPropertySourceAttributes { } /** - * Add all of the supplied elements to the provided list, honoring the + * Add all the supplied elements to the provided list, honoring the * {@code prepend} flag. - *

If the {@code prepend} flag is {@code false}, the elements will appended + *

If the {@code prepend} flag is {@code false}, the elements will be appended * to the list. * @param prepend whether the elements should be prepended to the list * @param list the list to which to add the elements diff --git a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java index 5ed7f4aafb..fbd1c4c623 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java @@ -85,7 +85,7 @@ public abstract class TestPropertySourceUtils { for (List> aggregatedAnnotations : findRepeatableAnnotations(testClass, TestPropertySource.class)) { - // Convert all of the merged annotations for the current aggregate + // Convert all the merged annotations for the current aggregate // level to a list of TestPropertySourceAttributes. List aggregatedAttributesList = aggregatedAnnotations.stream().map(TestPropertySourceAttributes::new).collect(Collectors.toList()); @@ -200,7 +200,7 @@ public abstract class TestPropertySourceUtils { * against the {@code Environment}. *

Each properties file will be converted to a {@link ResourcePropertySource} * that will be added to the {@link PropertySources} of the environment with - * highest precedence. + * the highest precedence. * @param environment the environment to update; never {@code null} * @param resourceLoader the {@code ResourceLoader} to use to load each resource; * never {@code null} diff --git a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java index de222110de..40b9aa14e0 100644 --- a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java @@ -177,7 +177,7 @@ public abstract class AbstractTransactionalTestNGSpringContextTests extends Abst } /** - * Convenience method for dropping all of the specified tables. + * Convenience method for dropping all the specified tables. *

Use with caution outside of a transaction! * @param names the names of the tables to drop * @since 3.2 @@ -193,7 +193,7 @@ public abstract class AbstractTransactionalTestNGSpringContextTests extends Abst *

The script will normally be loaded by classpath. *

Do not use this method to execute DDL if you expect rollback. * @param sqlResourcePath the Spring resource path for the SQL script - * @param continueOnError whether or not to continue without throwing an + * @param continueOnError whether to continue without throwing an * exception in the event of an error * @throws DataAccessException if there is an error executing a statement * @see ResourceDatabasePopulator diff --git a/spring-test/src/main/java/org/springframework/test/context/transaction/TestTransaction.java b/spring-test/src/main/java/org/springframework/test/context/transaction/TestTransaction.java index 23ce6fccb3..cec8581392 100644 --- a/spring-test/src/main/java/org/springframework/test/context/transaction/TestTransaction.java +++ b/spring-test/src/main/java/org/springframework/test/context/transaction/TestTransaction.java @@ -80,7 +80,7 @@ public final class TestTransaction { /** * Flag the current test-managed transaction for rollback. *

Invoking this method will not end the current transaction. - * Rather, the value of this flag will be used to determine whether or not + * Rather, the value of this flag will be used to determine whether * the current test-managed transaction should be rolled back or committed * once it is {@linkplain #end ended}. * @throws IllegalStateException if no transaction is active for the current test @@ -96,7 +96,7 @@ public final class TestTransaction { /** * Flag the current test-managed transaction for commit. *

Invoking this method will not end the current transaction. - * Rather, the value of this flag will be used to determine whether or not + * Rather, the value of this flag will be used to determine whether * the current test-managed transaction should be rolled back or committed * once it is {@linkplain #end ended}. * @throws IllegalStateException if no transaction is active for the current test diff --git a/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java index 843619bd25..382897756d 100644 --- a/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java +++ b/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java @@ -97,7 +97,7 @@ import org.springframework.util.StringUtils; * *

Executing Code outside of a Transaction

*

When executing transactional tests, it is sometimes useful to be able to - * execute certain set up or tear down code outside of a + * execute certain set up or tear down code outside a * transaction. {@code TransactionalTestExecutionListener} provides such * support for methods annotated with {@link BeforeTransaction @BeforeTransaction} * or {@link AfterTransaction @AfterTransaction}. As of Spring Framework 4.3, @@ -390,7 +390,7 @@ public class TransactionalTestExecutionListener extends AbstractTestExecutionLis } /** - * Determine whether or not to rollback transactions by default for the + * Determine whether to rollback transactions by default for the * supplied {@linkplain TestContext test context}. *

Supports {@link Rollback @Rollback} or {@link Commit @Commit} at the * class-level. @@ -418,7 +418,7 @@ public class TransactionalTestExecutionListener extends AbstractTestExecutionLis } /** - * Determine whether or not to rollback transactions for the supplied + * Determine whether to rollback transactions for the supplied * {@linkplain TestContext test context} by taking into consideration the * {@linkplain #isDefaultRollback(TestContext) default rollback} flag and a * possible method-level override via the {@link Rollback @Rollback} diff --git a/spring-test/src/main/java/org/springframework/test/context/web/ServletTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/web/ServletTestExecutionListener.java index b981840f9b..0650e0ce5d 100644 --- a/spring-test/src/main/java/org/springframework/test/context/web/ServletTestExecutionListener.java +++ b/spring-test/src/main/java/org/springframework/test/context/web/ServletTestExecutionListener.java @@ -68,7 +68,7 @@ public class ServletTestExecutionListener extends AbstractTestExecutionListener /** * Attribute name for a {@link TestContext} attribute which indicates - * whether or not the {@code ServletTestExecutionListener} should {@linkplain + * whether the {@code ServletTestExecutionListener} should {@linkplain * RequestContextHolder#resetRequestAttributes() reset} Spring Web's * {@code RequestContextHolder} in {@link #afterTestMethod(TestContext)}. *

Permissible values include {@link Boolean#TRUE} and {@link Boolean#FALSE}. diff --git a/spring-test/src/main/java/org/springframework/test/web/ModelAndViewAssert.java b/spring-test/src/main/java/org/springframework/test/web/ModelAndViewAssert.java index f3415671bf..02653350eb 100644 --- a/spring-test/src/main/java/org/springframework/test/web/ModelAndViewAssert.java +++ b/spring-test/src/main/java/org/springframework/test/web/ModelAndViewAssert.java @@ -46,7 +46,7 @@ public abstract class ModelAndViewAssert { /** * Checks whether the model value under the given {@code modelName} - * exists and checks it type, based on the {@code expectedType}. If the + * exists and checks its type, based on the {@code expectedType}. If the * model entry exists and the type matches, the model value is returned. * @param mav the ModelAndView to test against (never {@code null}) * @param modelName name of the object to add to the model (never {@code null}) @@ -81,7 +81,7 @@ public abstract class ModelAndViewAssert { } /** - * Assert whether or not a model attribute is available. + * Assert whether a model attribute is available. * @param mav the ModelAndView to test against (never {@code null}) * @param modelName name of the object to add to the model (never {@code null}) */ diff --git a/spring-test/src/main/java/org/springframework/test/web/client/AbstractRequestExpectationManager.java b/spring-test/src/main/java/org/springframework/test/web/client/AbstractRequestExpectationManager.java index bd57ec72fc..dcd0c855cf 100644 --- a/spring-test/src/main/java/org/springframework/test/web/client/AbstractRequestExpectationManager.java +++ b/spring-test/src/main/java/org/springframework/test/web/client/AbstractRequestExpectationManager.java @@ -42,7 +42,7 @@ import org.springframework.util.Assert; * expectations at the end. * *

Subclasses are responsible for validating each request by matching it to - * to expectations following the order of declaration or not. + * expectations following the order of declaration or not. * * @author Rossen Stoyanchev * @author Juergen Hoeller @@ -203,7 +203,7 @@ public abstract class AbstractRequestExpectationManager implements RequestExpect } /** - * Return an {@code AssertionError} that a sub-class can raise for an + * Return an {@code AssertionError} that a subclass can raise for an * unexpected request. */ protected AssertionError createUnexpectedRequestError(ClientHttpRequest request) { @@ -247,7 +247,7 @@ public abstract class AbstractRequestExpectationManager implements RequestExpect return expectation; } catch (AssertionError error) { - // We're looking to find a match or return null.. + // We're looking to find a match or return null. } } return null; diff --git a/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java b/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java index d3c0cd7b41..4ac02c1841 100644 --- a/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java +++ b/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java @@ -121,7 +121,7 @@ public final class MockRestServiceServer { * Variant of {@link #verify()} that waits for up to the specified time for * all expectations to be fulfilled. This can be useful for tests that * involve asynchronous requests. - * @param timeout how long to wait for all expecations to be met + * @param timeout how long to wait for all expectations to be met * @throws AssertionError if not all expectations are met by the specified * timeout, or if any expectation fails at any time before that. * @since 5.3.4 diff --git a/spring-test/src/main/java/org/springframework/test/web/client/RequestExpectationManager.java b/spring-test/src/main/java/org/springframework/test/web/client/RequestExpectationManager.java index 35a8c68c77..06ad433973 100644 --- a/spring-test/src/main/java/org/springframework/test/web/client/RequestExpectationManager.java +++ b/spring-test/src/main/java/org/springframework/test/web/client/RequestExpectationManager.java @@ -61,7 +61,7 @@ public interface RequestExpectationManager { * Variant of {@link #verify()} that waits for up to the specified time for * all expectations to be fulfilled. This can be useful for tests that * involve asynchronous requests. - * @param timeout how long to wait for all expecations to be met + * @param timeout how long to wait for all expectations to be met * @throws AssertionError if not all expectations are met by the specified * timeout, or if any expectation fails at any time before that. * @since 5.3.4 diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/AbstractMockServerSpec.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/AbstractMockServerSpec.java index 7a438f2fb2..856fe3f715 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/AbstractMockServerSpec.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/AbstractMockServerSpec.java @@ -97,7 +97,7 @@ abstract class AbstractMockServerSpec> } /** - * Sub-classes must create an {@code WebHttpHandlerBuilder} that will then + * Subclasses must create an {@code WebHttpHandlerBuilder} that will then * be used to create the HttpHandler for the mock server. */ protected abstract WebHttpHandlerBuilder initHttpHandlerBuilder(); diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java index e44c3b9f06..544f46e874 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java @@ -44,7 +44,7 @@ import org.springframework.util.MultiValueMap; * {@link WebTestClient}. * *

Note that a decoded response body is not exposed at this level since the - * body may not have been decoded and consumed yet. Sub-types + * body may not have been decoded and consumed yet. Subtypes * {@link EntityExchangeResult} and {@link FluxExchangeResult} provide access * to a decoded response entity and a decoded (but not consumed) response body * respectively. @@ -161,7 +161,7 @@ public class ExchangeResult { * Return the raw request body content written through the request. *

Note: If the request content has not been consumed * for any reason yet, use of this method will trigger consumption. - * @throws IllegalStateException if the request body is not been fully written. + * @throws IllegalStateException if the request body has not been fully written. */ @Nullable public byte[] getRequestBodyContent() { @@ -203,7 +203,7 @@ public class ExchangeResult { * Return the raw request body content written to the response. *

Note: If the response content has not been consumed * yet, use of this method will trigger consumption. - * @throws IllegalStateException if the response is not been fully read. + * @throws IllegalStateException if the response has not been fully read. */ @Nullable public byte[] getResponseBodyContent() { diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java index ece5800cc5..e9e824aeb7 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java @@ -180,7 +180,7 @@ public interface WebTestClient { * There are builder methods to customize the Java config. The resulting * WebFlux application will be tested without an HTTP server using a mock * request and response. - * @param controllers one or more controller instances to tests + * @param controllers one or more controller instances to test * (specified {@code Class} will be turned into instance) * @return chained API to customize server and client config; use * {@link MockServerSpec#configureClient()} to transition to client config @@ -203,7 +203,7 @@ public interface WebTestClient { } /** - * Use this option to setup a server from the Spring configuration of your + * Use this option to set up a server from the Spring configuration of your * application, or some subset of it. Internally the provided configuration * is passed to {@code WebHttpHandlerBuilder} to set up the request * processing chain. The resulting WebFlux application will be tested @@ -796,7 +796,7 @@ public interface WebTestClient { *

If a single {@link Error} or {@link RuntimeException} is thrown, * it will be rethrown. *

If multiple exceptions are thrown, this method will throw an - * {@link AssertionError} whose error message is a summary of all of the + * {@link AssertionError} whose error message is a summary of all the * exceptions. In addition, each exception will be added as a * {@linkplain Throwable#addSuppressed(Throwable) suppressed exception} to * the {@code AssertionError}. diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/ResultActions.java b/spring-test/src/main/java/org/springframework/test/web/servlet/ResultActions.java index 3b99f1b5d0..114858910b 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/ResultActions.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/ResultActions.java @@ -57,7 +57,7 @@ public interface ResultActions { *

If a single {@link Error} or {@link Exception} is thrown, it will * be rethrown. *

If multiple exceptions are thrown, this method will throw an - * {@link AssertionError} whose error message is a summary of all of the + * {@link AssertionError} whose error message is a summary of all the * exceptions. In addition, each exception will be added as a * {@linkplain Throwable#addSuppressed(Throwable) suppressed exception} to * the {@code AssertionError}. diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/SmartRequestBuilder.java b/spring-test/src/main/java/org/springframework/test/web/servlet/SmartRequestBuilder.java index 13e57d2e9f..204012b123 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/SmartRequestBuilder.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/SmartRequestBuilder.java @@ -29,7 +29,7 @@ import org.springframework.mock.web.MockHttpServletRequest; public interface SmartRequestBuilder extends RequestBuilder { /** - * Apply request post processing. Typically that means invoking one or more + * Apply request post-processing. Typically, that means invoking one or more * {@link org.springframework.test.web.servlet.request.RequestPostProcessor org.springframework.test.web.servlet.request.RequestPostProcessors}. * @param request the request to initialize * @return the request to use, either the one passed in or a wrapped one diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/TestDispatcherServlet.java b/spring-test/src/main/java/org/springframework/test/web/servlet/TestDispatcherServlet.java index 8c9a4f9fb7..51c8e8fe37 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/TestDispatcherServlet.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/TestDispatcherServlet.java @@ -41,7 +41,7 @@ import org.springframework.web.servlet.ModelAndView; import org.springframework.web.util.WebUtils; /** - * A sub-class of {@code DispatcherServlet} that saves the result in an + * A subclass of {@code DispatcherServlet} that saves the result in an * {@link MvcResult}. The {@code MvcResult} instance is expected to be available * as the request attribute {@link MockMvc#MVC_RESULT_ATTRIBUTE}. * diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/client/AbstractMockMvcServerSpec.java b/spring-test/src/main/java/org/springframework/test/web/servlet/client/AbstractMockMvcServerSpec.java index 37e4193811..3f799fd0f7 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/client/AbstractMockMvcServerSpec.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/client/AbstractMockMvcServerSpec.java @@ -30,11 +30,11 @@ import org.springframework.test.web.servlet.setup.MockMvcConfigurer; /** * Base class for implementations of {@link MockMvcWebTestClient.MockMvcServerSpec} * that simply delegates to a {@link ConfigurableMockMvcBuilder} supplied by - * the concrete sub-classes. + * the concrete subclasses. * * @author Rossen Stoyanchev * @since 5.3 - * @param the type of the concrete sub-class spec + * @param the type of the concrete subclass spec */ abstract class AbstractMockMvcServerSpec> implements MockMvcWebTestClient.MockMvcServerSpec { diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java b/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java index c4ec1cd917..6bfe5d5cea 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java @@ -306,7 +306,7 @@ public class MockHttpServletRequestBuilder /** * Set the 'Content-Type' header of the request as a raw String value, - * possibly not even well formed (for testing purposes). + * possibly not even well-formed (for testing purposes). * @param contentType the content type * @since 4.1.2 */ @@ -327,8 +327,8 @@ public class MockHttpServletRequestBuilder } /** - * Set the 'Accept' header using raw String values, possibly not even well - * formed (for testing purposes). + * Set the {@code Accept} header using raw String values, possibly not even + * well-formed (for testing purposes). * @param mediaTypes one or more media types; internally joined as * comma-separated String */ @@ -408,7 +408,7 @@ public class MockHttpServletRequestBuilder /** * Append to the query string and also add to the - * {@link #params(MultiValueMap)} request parameters} map. The parameter + * {@link #params(MultiValueMap) request parameters} map. The parameter * name and value are encoded when they are added to the query string. * @param params the parameters to add * @since 5.2.2 diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java b/spring-test/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java index f2d9360107..b5a9ce5f3e 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java @@ -66,8 +66,8 @@ public class ContentResultMatchers { /** * Assert the ServletResponse content type. The given content type must - * fully match including type, sub-type, and parameters. For checking - * only the type and sub-type see {@link #contentTypeCompatibleWith(String)}. + * fully match including type, subtype, and parameters. For checking + * only the type and subtype see {@link #contentTypeCompatibleWith(String)}. */ public ResultMatcher contentType(String contentType) { return contentType(MediaType.parseMediaType(contentType)); @@ -75,8 +75,8 @@ public class ContentResultMatchers { /** * Assert the ServletResponse content type after parsing it as a MediaType. - * The given content type must fully match including type, sub-type, and - * parameters. For checking only the type and sub-type see + * The given content type must fully match including type, subtype, and + * parameters. For checking only the type and subtype see * {@link #contentTypeCompatibleWith(MediaType)}. */ public ResultMatcher contentType(MediaType contentType) { diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java index 1675a49403..90fc2694d9 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java @@ -446,7 +446,7 @@ public class StandaloneMockMvcBuilder extends AbstractMockMvcBuildercomposed annotation for {@link DisabledIf @DisabledIf} that * disables a test class or test method if the current operating system is - * Mac OS. + * macOS. * * @author Sam Brannen * @since 5.0 diff --git a/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledOnMac.java b/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledOnMac.java index 1f40a902f5..aad34adabf 100644 --- a/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledOnMac.java +++ b/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/EnabledOnMac.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; /** * Demo composed annotation for {@link EnabledIf @EnabledIf} that * enables a test class or test method if the current operating system is - * Mac OS. + * macOS. * * @author Sam Brannen * @since 5.0 diff --git a/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/event/PublishedEvents.java b/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/event/PublishedEvents.java index b5e43aac1e..19c8abe07a 100644 --- a/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/event/PublishedEvents.java +++ b/spring-test/src/test/java/org/springframework/test/context/junit/jupiter/event/PublishedEvents.java @@ -58,7 +58,7 @@ public interface PublishedEvents { /** * Further constrain the event type for downstream assertions. * - * @param subType the sub type + * @param subType the subtype * @return will never be {@literal null} */ TypedPublishedEvents ofSubType(Class subType); diff --git a/spring-test/src/test/java/org/springframework/test/context/junit4/EmbeddedPersonDatabaseTestsConfig.java b/spring-test/src/test/java/org/springframework/test/context/junit4/EmbeddedPersonDatabaseTestsConfig.java index f709883b03..6edbb78f92 100644 --- a/spring-test/src/test/java/org/springframework/test/context/junit4/EmbeddedPersonDatabaseTestsConfig.java +++ b/spring-test/src/test/java/org/springframework/test/context/junit4/EmbeddedPersonDatabaseTestsConfig.java @@ -25,7 +25,7 @@ import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; import org.springframework.transaction.PlatformTransactionManager; /** - * Shared configuration for tests that need an embedded database pre-loaded + * Shared configuration for tests that need an embedded database preloaded * with the schema for the 'person' table. * * @author Sam Brannen diff --git a/spring-test/src/test/java/org/springframework/test/context/support/BootstrapTestUtilsMergedConfigTests.java b/spring-test/src/test/java/org/springframework/test/context/support/BootstrapTestUtilsMergedConfigTests.java index 6165ec1aee..b221a0b335 100644 --- a/spring-test/src/test/java/org/springframework/test/context/support/BootstrapTestUtilsMergedConfigTests.java +++ b/spring-test/src/test/java/org/springframework/test/context/support/BootstrapTestUtilsMergedConfigTests.java @@ -290,7 +290,7 @@ class BootstrapTestUtilsMergedConfigTests extends AbstractContextConfigurationUt MergedContextConfiguration parent = mergedConfig.getParent(); assertThat(parent).as("parent config").isNotNull(); // The following does not work -- at least not in Eclipse. - // asssertThat(parent.getClasses())... + // assertThat(parent.getClasses())... // So we use AssertionsForClassTypes directly. AssertionsForClassTypes.assertThat(parent.getClasses()).containsExactly(FooConfig.class); diff --git a/spring-test/src/test/java/org/springframework/test/web/reactive/server/MockServerTests.java b/spring-test/src/test/java/org/springframework/test/web/reactive/server/MockServerTests.java index 7b423d92c8..0e87e7e3cc 100644 --- a/spring-test/src/test/java/org/springframework/test/web/reactive/server/MockServerTests.java +++ b/spring-test/src/test/java/org/springframework/test/web/reactive/server/MockServerTests.java @@ -152,7 +152,7 @@ public class MockServerTests { .expectStatus().isOk() .returnResult(String.class); - // Get the raw content without consuming the response body flux.. + // Get the raw content without consuming the response body flux. byte[] bytes = result.getResponseBodyContent(); assertThat(bytes).isNotNull();