Clean up Javadoc and source code regarding " ." typos

This commit is contained in:
Sam Brannen 2022-12-12 15:42:27 +01:00
parent f8a1dac593
commit 46fc28fd1a
16 changed files with 32 additions and 31 deletions

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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. * 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 Rob Harrop
* @author Juergen Hoeller * @author Juergen Hoeller

View File

@ -61,7 +61,7 @@ class EnableCachingIntegrationTests {
ctx.register(Config.class, AspectJCacheConfig.class); ctx.register(Config.class, AspectJCacheConfig.class);
// this test is a bit fragile, but gets the job done, proving that an // 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 // 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) assertThatException().isThrownBy(ctx::refresh)
.withMessageContaining("AspectJCachingConfiguration"); .withMessageContaining("AspectJCachingConfiguration");
} }

View File

@ -97,7 +97,7 @@ class EnableTransactionManagementIntegrationTests {
ctx.register(Config.class, AspectJTxConfig.class); ctx.register(Config.class, AspectJTxConfig.class);
// this test is a bit fragile, but gets the job done, proving that an // 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 // 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() assertThatException()
.isThrownBy(ctx::refresh) .isThrownBy(ctx::refresh)
.withMessageContaining("AspectJJtaTransactionManagementConfiguration"); .withMessageContaining("AspectJJtaTransactionManagementConfiguration");

View File

@ -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() { public boolean hasTargetType() {
return (this.targetType instanceof Class); return (this.targetType instanceof Class);

View File

@ -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); 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 // 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 // Passing (String) on call to (String[]) is exact match
checkMatch2(new Class<?>[] {String.class}, new Class<?>[] {String[].class}, tc, ArgumentsMatchKind.EXACT); 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"); assertThat(rpa.read(ctx, t, "property3").getValue()).isEqualTo("doodoo");
// Access through is method // 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.read(ctx, t, "property4").getValue()).isEqualTo(false);
assertThat(rpa.canRead(ctx, t, "property4")).isTrue(); assertThat(rpa.canRead(ctx, t, "property4")).isTrue();

View File

@ -64,7 +64,7 @@ public class MarshallingMessageConverter implements MessageConverter, Initializi
/** /**
* Construct a new {@code MarshallingMessageConverter} with no {@link Marshaller} * Construct a new {@code MarshallingMessageConverter} with no {@link Marshaller}
* or {@link Unmarshaller} set. The marshaller must be set after construction by invoking * 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() { public MarshallingMessageConverter() {
} }

View File

@ -94,7 +94,7 @@ public interface RSocketRequester extends Disposable {
* {@code "flight.{code}"} in which case the supplied route variables are * {@code "flight.{code}"} in which case the supplied route variables are
* formatted via {@code toString()} and expanded into the template. * formatted via {@code toString()} and expanded into the template.
* If a formatted variable contains a "." it is replaced with the escape * 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.
* <p>If the connection is set to use composite metadata, the route is * <p>If the connection is set to use composite metadata, the route is
* encoded as {@code "message/x.rsocket.routing.v0"}. Otherwise, the route * encoded as {@code "message/x.rsocket.routing.v0"}. Otherwise, the route
* is encoded according to the mime type for the connection. * is encoded according to the mime type for the connection.

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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("", "pc1");
persistenceContexts.put("Person", "pc2"); persistenceContexts.put("Person", "pc2");
Map<String, String> extendedPersistenceContexts = new HashMap<>(); Map<String, String> extendedPersistenceContexts = new HashMap<>();
extendedPersistenceContexts .put("", "pc3"); extendedPersistenceContexts.put("", "pc3");
ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); ExpectedLookupTemplate jt = new ExpectedLookupTemplate();
jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc1", mockEm);
jt.addObject("java:comp/env/pc2", mockEm2); jt.addObject("java:comp/env/pc2", mockEm2);
@ -480,7 +480,7 @@ public class PersistenceInjectionTests extends AbstractEntityManagerFactoryBeanT
persistenceContexts.put("System", "pc1"); persistenceContexts.put("System", "pc1");
persistenceContexts.put("Person", "pc2"); persistenceContexts.put("Person", "pc2");
Map<String, String> extendedPersistenceContexts = new HashMap<>(); Map<String, String> extendedPersistenceContexts = new HashMap<>();
extendedPersistenceContexts .put("System", "pc3"); extendedPersistenceContexts.put("System", "pc3");
ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); ExpectedLookupTemplate jt = new ExpectedLookupTemplate();
jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc1", mockEm);
jt.addObject("java:comp/env/pc2", mockEm2); jt.addObject("java:comp/env/pc2", mockEm2);
@ -519,7 +519,7 @@ public class PersistenceInjectionTests extends AbstractEntityManagerFactoryBeanT
Map<String, String> persistenceContexts = new HashMap<>(); Map<String, String> persistenceContexts = new HashMap<>();
persistenceContexts.put("System", "pc1"); persistenceContexts.put("System", "pc1");
Map<String, String> extendedPersistenceContexts = new HashMap<>(); Map<String, String> extendedPersistenceContexts = new HashMap<>();
extendedPersistenceContexts .put("System", "pc2"); extendedPersistenceContexts.put("System", "pc2");
ExpectedLookupTemplate jt = new ExpectedLookupTemplate(); ExpectedLookupTemplate jt = new ExpectedLookupTemplate();
jt.addObject("java:comp/env/pc1", mockEm); jt.addObject("java:comp/env/pc1", mockEm);
jt.addObject("java:comp/env/pc2", mockEm2); jt.addObject("java:comp/env/pc2", mockEm2);

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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 * 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(); PathContainer pathWithinApplication();

View File

@ -30,7 +30,8 @@ import org.springframework.lang.Nullable;
/** /**
* Interface specifying a basic set of RESTful operations. * Interface specifying a basic set of RESTful operations.
* Implemented by {@link RestTemplate}. Not often used directly, but a useful *
* <p>Implemented by {@link RestTemplate}. Not often used directly, but a useful
* option to enhance testability, as it can easily be mocked or stubbed. * option to enhance testability, as it can easily be mocked or stubbed.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
@ -67,7 +68,7 @@ public interface RestOperations {
<T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException; <T> T getForObject(String url, Class<T> responseType, Map<String, ?> 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. * The response (if any) is converted and returned.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @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. * 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}.
* <p>URI Template variables are expanded using the given URI variables, if any. * <p>URI Template variables are expanded using the given URI variables, if any.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @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. * 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}.
* <p>URI Template variables are expanded using the given map. * <p>URI Template variables are expanded using the given map.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @param responseType the type of the return value
@ -103,8 +104,8 @@ public interface RestOperations {
throws RestClientException; throws RestClientException;
/** /**
* Retrieve a representation by doing a GET on the URL . * Retrieve a representation by doing a GET on the URL.
* The response is converted and stored in an {@link ResponseEntity}. * The response is converted and stored in a {@link ResponseEntity}.
* @param url the URL * @param url the URL
* @param responseType the type of the return value * @param responseType the type of the return value
* @return the converted object * @return the converted object

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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 * Strategy interface to handle the value returned from the invocation of a
* handler method . * handler method.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
* @since 3.1 * @since 3.1

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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 * and if it has expired remove the session and return empty. This method
* should also update the lastAccessTime of retrieved sessions. * should also update the lastAccessTime of retrieved sessions.
* @param sessionId the session to load * @param sessionId the session to load
* @return the session, or an empty {@code Mono} . * @return the session, or an empty {@code Mono}
*/ */
Mono<WebSession> retrieveSession(String sessionId); Mono<WebSession> retrieveSession(String sessionId);

View File

@ -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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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); 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)}. * parameterized with a URI variable. Otherwise use {@link #port(int)}.
* Passing {@code null} will clear the port of this builder. * Passing {@code null} will clear the port of this builder.
* @param port the URI port * @param port the URI port

View File

@ -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 ex the exception to handle
* @param exchange the current request-response * @param exchange the current request-response
*/ */

View File

@ -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 ex the exception to handle
* @param request the current request * @param request the current request
*/ */

View File

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