From 46fc28fd1a26f1eed58561e2855761ceeeabc968 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Mon, 12 Dec 2022 15:42:27 +0100 Subject: [PATCH] Clean up Javadoc and source code regarding " ." typos --- .../AopNamespaceHandlerScopeIntegrationTests.java | 4 ++-- .../annotation/EnableCachingIntegrationTests.java | 2 +- ...EnableTransactionManagementIntegrationTests.java | 2 +- .../beans/factory/config/TypedStringValue.java | 2 +- .../spel/support/ReflectionHelperTests.java | 4 ++-- .../converter/MarshallingMessageConverter.java | 2 +- .../messaging/rsocket/RSocketRequester.java | 2 +- .../orm/jpa/support/PersistenceInjectionTests.java | 8 ++++---- .../springframework/http/server/RequestPath.java | 4 ++-- .../springframework/web/client/RestOperations.java | 13 +++++++------ .../support/HandlerMethodReturnValueHandler.java | 4 ++-- .../web/server/session/WebSessionStore.java | 4 ++-- .../org/springframework/web/util/UriBuilder.java | 4 ++-- .../annotation/ResponseEntityExceptionHandler.java | 2 +- .../annotation/ResponseEntityExceptionHandler.java | 2 +- .../handler/WebSocketHandlerDecoratorFactory.java | 4 ++-- 16 files changed, 32 insertions(+), 31 deletions(-) diff --git a/integration-tests/src/test/java/org/springframework/aop/config/AopNamespaceHandlerScopeIntegrationTests.java b/integration-tests/src/test/java/org/springframework/aop/config/AopNamespaceHandlerScopeIntegrationTests.java index b4c1131ea1..5b76d47f4c 100644 --- a/integration-tests/src/test/java/org/springframework/aop/config/AopNamespaceHandlerScopeIntegrationTests.java +++ b/integration-tests/src/test/java/org/springframework/aop/config/AopNamespaceHandlerScopeIntegrationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2019 the original author or authors. + * Copyright 2002-2022 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 @@ import static org.assertj.core.api.Assertions.assertThat; /** * Integration tests for scoped proxy use in conjunction with aop: namespace. - * Deemed an integration test because .web mocks and application contexts are required. + * Deemed an integration test because web mocks and application contexts are required. * * @author Rob Harrop * @author Juergen Hoeller diff --git a/integration-tests/src/test/java/org/springframework/cache/annotation/EnableCachingIntegrationTests.java b/integration-tests/src/test/java/org/springframework/cache/annotation/EnableCachingIntegrationTests.java index 63534df963..41acb6ed5d 100644 --- a/integration-tests/src/test/java/org/springframework/cache/annotation/EnableCachingIntegrationTests.java +++ b/integration-tests/src/test/java/org/springframework/cache/annotation/EnableCachingIntegrationTests.java @@ -61,7 +61,7 @@ class EnableCachingIntegrationTests { ctx.register(Config.class, AspectJCacheConfig.class); // this test is a bit fragile, but gets the job done, proving that an // attempt was made to look up the AJ aspect. It's due to classpath issues - // in .integration-tests that it's not found. + // in integration-tests that it's not found. assertThatException().isThrownBy(ctx::refresh) .withMessageContaining("AspectJCachingConfiguration"); } diff --git a/integration-tests/src/test/java/org/springframework/transaction/annotation/EnableTransactionManagementIntegrationTests.java b/integration-tests/src/test/java/org/springframework/transaction/annotation/EnableTransactionManagementIntegrationTests.java index bf52ef5fde..4ab8cab156 100644 --- a/integration-tests/src/test/java/org/springframework/transaction/annotation/EnableTransactionManagementIntegrationTests.java +++ b/integration-tests/src/test/java/org/springframework/transaction/annotation/EnableTransactionManagementIntegrationTests.java @@ -97,7 +97,7 @@ class EnableTransactionManagementIntegrationTests { ctx.register(Config.class, AspectJTxConfig.class); // this test is a bit fragile, but gets the job done, proving that an // attempt was made to look up the AJ aspect. It's due to classpath issues - // in .integration-tests that it's not found. + // in integration-tests that it's not found. assertThatException() .isThrownBy(ctx::refresh) .withMessageContaining("AspectJJtaTransactionManagementConfiguration"); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java index e1b107d27c..382068dd3e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java @@ -143,7 +143,7 @@ public class TypedStringValue implements BeanMetadataElement { } /** - * Return whether this typed String value carries a target type . + * Return whether this typed String value carries a target type. */ public boolean hasTargetType() { return (this.targetType instanceof Class); diff --git a/spring-expression/src/test/java/org/springframework/expression/spel/support/ReflectionHelperTests.java b/spring-expression/src/test/java/org/springframework/expression/spel/support/ReflectionHelperTests.java index 591ed10037..5b839c7084 100644 --- a/spring-expression/src/test/java/org/springframework/expression/spel/support/ReflectionHelperTests.java +++ b/spring-expression/src/test/java/org/springframework/expression/spel/support/ReflectionHelperTests.java @@ -163,7 +163,7 @@ public class ReflectionHelperTests extends AbstractExpressionTests { checkMatch2(new Class[] {Integer.class, String[].class}, new Class[] {String.class, String[].class}, tc, ArgumentsMatchKind.REQUIRES_CONVERSION); // Passing (Integer, Sub, String[]) on call to (String, Super, String[]) is exact match - checkMatch2(new Class[] {Integer.class, Sub.class, String[].class}, new Class[] {String.class,Super .class, String[].class}, tc, ArgumentsMatchKind.REQUIRES_CONVERSION); + checkMatch2(new Class[] {Integer.class, Sub.class, String[].class}, new Class[] {String.class, Super.class, String[].class}, tc, ArgumentsMatchKind.REQUIRES_CONVERSION); // Passing (String) on call to (String[]) is exact match checkMatch2(new Class[] {String.class}, new Class[] {String[].class}, tc, ArgumentsMatchKind.EXACT); @@ -298,7 +298,7 @@ public class ReflectionHelperTests extends AbstractExpressionTests { assertThat(rpa.read(ctx, t, "property3").getValue()).isEqualTo("doodoo"); // Access through is method - assertThat(rpa .read(ctx, t, "field3").getValue()).isEqualTo(0); + assertThat(rpa.read(ctx, t, "field3").getValue()).isEqualTo(0); assertThat(rpa.read(ctx, t, "property4").getValue()).isEqualTo(false); assertThat(rpa.canRead(ctx, t, "property4")).isTrue(); diff --git a/spring-jms/src/main/java/org/springframework/jms/support/converter/MarshallingMessageConverter.java b/spring-jms/src/main/java/org/springframework/jms/support/converter/MarshallingMessageConverter.java index c3dd8389ae..d13a05b35a 100644 --- a/spring-jms/src/main/java/org/springframework/jms/support/converter/MarshallingMessageConverter.java +++ b/spring-jms/src/main/java/org/springframework/jms/support/converter/MarshallingMessageConverter.java @@ -64,7 +64,7 @@ public class MarshallingMessageConverter implements MessageConverter, Initializi /** * Construct a new {@code MarshallingMessageConverter} with no {@link Marshaller} * or {@link Unmarshaller} set. The marshaller must be set after construction by invoking - * {@link #setMarshaller(Marshaller)} and {@link #setUnmarshaller(Unmarshaller)} . + * {@link #setMarshaller(Marshaller)} and {@link #setUnmarshaller(Unmarshaller)}. */ public MarshallingMessageConverter() { } diff --git a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java index b785ae4dda..36576f28f9 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java @@ -94,7 +94,7 @@ public interface RSocketRequester extends Disposable { * {@code "flight.{code}"} in which case the supplied route variables are * formatted via {@code toString()} and expanded into the template. * If a formatted variable contains a "." it is replaced with the escape - * sequence "%2E" to avoid treating it as separator by the responder . + * sequence "%2E" to avoid treating it as separator by the responder. *

If the connection is set to use composite metadata, the route is * encoded as {@code "message/x.rsocket.routing.v0"}. Otherwise, the route * is encoded according to the mime type for the connection. diff --git a/spring-orm/src/test/java/org/springframework/orm/jpa/support/PersistenceInjectionTests.java b/spring-orm/src/test/java/org/springframework/orm/jpa/support/PersistenceInjectionTests.java index c38924840a..d51505fb1d 100644 --- a/spring-orm/src/test/java/org/springframework/orm/jpa/support/PersistenceInjectionTests.java +++ b/spring-orm/src/test/java/org/springframework/orm/jpa/support/PersistenceInjectionTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2020 the original author or authors. + * Copyright 2002-2022 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. @@ -440,7 +440,7 @@ public class PersistenceInjectionTests extends AbstractEntityManagerFactoryBeanT persistenceContexts.put("", "pc1"); persistenceContexts.put("Person", "pc2"); Map extendedPersistenceContexts = new HashMap<>(); - extendedPersistenceContexts .put("", "pc3"); + extendedPersistenceContexts.put("", "pc3"); ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc2", mockEm2); @@ -480,7 +480,7 @@ public class PersistenceInjectionTests extends AbstractEntityManagerFactoryBeanT persistenceContexts.put("System", "pc1"); persistenceContexts.put("Person", "pc2"); Map extendedPersistenceContexts = new HashMap<>(); - extendedPersistenceContexts .put("System", "pc3"); + extendedPersistenceContexts.put("System", "pc3"); ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc2", mockEm2); @@ -519,7 +519,7 @@ public class PersistenceInjectionTests extends AbstractEntityManagerFactoryBeanT Map persistenceContexts = new HashMap<>(); persistenceContexts.put("System", "pc1"); Map extendedPersistenceContexts = new HashMap<>(); - extendedPersistenceContexts .put("System", "pc2"); + extendedPersistenceContexts.put("System", "pc2"); ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc2", mockEm2); diff --git a/spring-web/src/main/java/org/springframework/http/server/RequestPath.java b/spring-web/src/main/java/org/springframework/http/server/RequestPath.java index 70e2ccae63..e98b9b078b 100644 --- a/spring-web/src/main/java/org/springframework/http/server/RequestPath.java +++ b/spring-web/src/main/java/org/springframework/http/server/RequestPath.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * Copyright 2002-2022 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 interface RequestPath extends PathContainer { /** * The portion of the request path after the context path which is typically - * used for request mapping within the application . + * used for request mapping within the application. */ PathContainer pathWithinApplication(); diff --git a/spring-web/src/main/java/org/springframework/web/client/RestOperations.java b/spring-web/src/main/java/org/springframework/web/client/RestOperations.java index 59ee4c78cc..f25c4f2f89 100644 --- a/spring-web/src/main/java/org/springframework/web/client/RestOperations.java +++ b/spring-web/src/main/java/org/springframework/web/client/RestOperations.java @@ -30,7 +30,8 @@ import org.springframework.lang.Nullable; /** * Interface specifying a basic set of RESTful operations. - * Implemented by {@link RestTemplate}. Not often used directly, but a useful + * + *

Implemented by {@link RestTemplate}. Not often used directly, but a useful * option to enhance testability, as it can easily be mocked or stubbed. * * @author Arjen Poutsma @@ -67,7 +68,7 @@ public interface RestOperations { T getForObject(String url, Class responseType, Map uriVariables) throws RestClientException; /** - * Retrieve a representation by doing a GET on the URL . + * Retrieve a representation by doing a GET on the URL. * The response (if any) is converted and returned. * @param url the URL * @param responseType the type of the return value @@ -78,7 +79,7 @@ public interface RestOperations { /** * Retrieve an entity by doing a GET on the specified URL. - * The response is converted and stored in an {@link ResponseEntity}. + * The response is converted and stored in a {@link ResponseEntity}. *

URI Template variables are expanded using the given URI variables, if any. * @param url the URL * @param responseType the type of the return value @@ -91,7 +92,7 @@ public interface RestOperations { /** * Retrieve a representation by doing a GET on the URI template. - * The response is converted and stored in an {@link ResponseEntity}. + * The response is converted and stored in a {@link ResponseEntity}. *

URI Template variables are expanded using the given map. * @param url the URL * @param responseType the type of the return value @@ -103,8 +104,8 @@ public interface RestOperations { throws RestClientException; /** - * Retrieve a representation by doing a GET on the URL . - * The response is converted and stored in an {@link ResponseEntity}. + * Retrieve a representation by doing a GET on the URL. + * The response is converted and stored in a {@link ResponseEntity}. * @param url the URL * @param responseType the type of the return value * @return the converted object diff --git a/spring-web/src/main/java/org/springframework/web/method/support/HandlerMethodReturnValueHandler.java b/spring-web/src/main/java/org/springframework/web/method/support/HandlerMethodReturnValueHandler.java index 6317abf679..2133effcb3 100644 --- a/spring-web/src/main/java/org/springframework/web/method/support/HandlerMethodReturnValueHandler.java +++ b/spring-web/src/main/java/org/springframework/web/method/support/HandlerMethodReturnValueHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2022 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. @@ -22,7 +22,7 @@ import org.springframework.web.context.request.NativeWebRequest; /** * Strategy interface to handle the value returned from the invocation of a - * handler method . + * handler method. * * @author Arjen Poutsma * @since 3.1 diff --git a/spring-web/src/main/java/org/springframework/web/server/session/WebSessionStore.java b/spring-web/src/main/java/org/springframework/web/server/session/WebSessionStore.java index ca8984f0c0..15eeb12842 100644 --- a/spring-web/src/main/java/org/springframework/web/server/session/WebSessionStore.java +++ b/spring-web/src/main/java/org/springframework/web/server/session/WebSessionStore.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2022 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. @@ -45,7 +45,7 @@ public interface WebSessionStore { * and if it has expired remove the session and return empty. This method * should also update the lastAccessTime of retrieved sessions. * @param sessionId the session to load - * @return the session, or an empty {@code Mono} . + * @return the session, or an empty {@code Mono} */ Mono retrieveSession(String sessionId); diff --git a/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java b/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java index 7a014faae7..70b5040d1f 100644 --- a/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java +++ b/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * Copyright 2002-2022 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. @@ -70,7 +70,7 @@ public interface UriBuilder { UriBuilder port(int port); /** - * Set the URI port . Use this method only when the port needs to be + * Set the URI port. Use this method only when the port needs to be * parameterized with a URI variable. Otherwise use {@link #port(int)}. * Passing {@code null} will clear the port of this builder. * @param port the URI port diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ResponseEntityExceptionHandler.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ResponseEntityExceptionHandler.java index 595d94c95c..f6bb0b5b3f 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ResponseEntityExceptionHandler.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/ResponseEntityExceptionHandler.java @@ -82,7 +82,7 @@ public abstract class ResponseEntityExceptionHandler implements MessageSourceAwa /** - * Handle all exceptions raised within Spring MVC handling of the request . + * Handle all exceptions raised within Spring MVC handling of the request. * @param ex the exception to handle * @param exchange the current request-response */ diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java index b8b4208041..3b310bd68c 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.java @@ -103,7 +103,7 @@ public abstract class ResponseEntityExceptionHandler implements MessageSourceAwa /** - * Handle all exceptions raised within Spring MVC handling of the request . + * Handle all exceptions raised within Spring MVC handling of the request. * @param ex the exception to handle * @param request the current request */ diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketHandlerDecoratorFactory.java b/spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketHandlerDecoratorFactory.java index 8a3cc640f3..0be8400d82 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketHandlerDecoratorFactory.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/handler/WebSocketHandlerDecoratorFactory.java @@ -24,7 +24,7 @@ import org.springframework.web.socket.WebSocketHandler; *

Decoration should be done through sub-classing * {@link org.springframework.web.socket.handler.WebSocketHandlerDecorator * WebSocketHandlerDecorator} to allow any code to traverse decorators and/or - * unwrap the original handler when necessary . + * unwrap the original handler when necessary. * * @author Rossen Stoyanchev * @since 4.1.2 @@ -35,7 +35,7 @@ public interface WebSocketHandlerDecoratorFactory { * Decorate the given WebSocketHandler. * @param handler the handler to be decorated. * @return the same handler or the handler wrapped with a subclass of - * {@code WebSocketHandlerDecorator}. + * {@code WebSocketHandlerDecorator} */ WebSocketHandler decorate(WebSocketHandler handler);