From e76fbcb29089930715d0321910ab4f9a47c67472 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Tue, 12 Jul 2022 15:53:53 +0200 Subject: [PATCH] Fix and improve Javadoc in spring-jms See gh-28800 --- .../org/springframework/jms/config/JmsListenerEndpoint.java | 2 +- .../jms/config/JmsListenerEndpointRegistry.java | 4 ++-- .../connection/UserCredentialsConnectionFactoryAdapter.java | 2 +- .../jms/listener/AbstractMessageListenerContainer.java | 2 +- .../jms/listener/DefaultMessageListenerContainer.java | 4 ++-- .../jms/listener/MessageListenerContainer.java | 2 +- .../jms/listener/SubscriptionNameProvider.java | 4 ++-- .../jms/listener/adapter/MessageListenerAdapter.java | 2 +- .../jms/listener/endpoint/JmsActivationSpecConfig.java | 2 +- .../listener/endpoint/StandardJmsActivationSpecFactory.java | 4 ++-- .../java/org/springframework/jms/support/JmsAccessor.java | 6 +++--- .../jms/annotation/AbstractJmsAnnotationDrivenTests.java | 4 ++-- .../java/org/springframework/jms/core/JmsTemplateTests.java | 6 +++--- 13 files changed, 22 insertions(+), 22 deletions(-) diff --git a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpoint.java b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpoint.java index d1c3e10d29..c206018e20 100644 --- a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpoint.java +++ b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpoint.java @@ -34,7 +34,7 @@ public interface JmsListenerEndpoint { String getId(); /** - * Setup the specified message listener container with the model + * Set up the specified message listener container with the model * defined by this endpoint. *

This endpoint must provide the requested missing option(s) of * the specified container to make it usable. Usually, this is about diff --git a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java index 4807958f51..68f6c21a22 100644 --- a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java +++ b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java @@ -121,7 +121,7 @@ public class JmsListenerEndpointRegistry implements DisposableBean, SmartLifecyc /** * Create a message listener container for the given {@link JmsListenerEndpoint}. *

This create the necessary infrastructure to honor that endpoint - * with regards to its configuration. + * with regard to its configuration. *

The {@code startImmediately} flag determines if the container should be * started immediately. * @param endpoint the endpoint to add @@ -153,7 +153,7 @@ public class JmsListenerEndpointRegistry implements DisposableBean, SmartLifecyc /** * Create a message listener container for the given {@link JmsListenerEndpoint}. *

This create the necessary infrastructure to honor that endpoint - * with regards to its configuration. + * with regard to its configuration. * @param endpoint the endpoint to add * @param factory the listener factory to use * @see #registerListenerContainer(JmsListenerEndpoint, JmsListenerContainerFactory, boolean) diff --git a/spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java b/spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java index 1943d753c4..adfe7cd962 100644 --- a/spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java +++ b/spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java @@ -123,7 +123,7 @@ public class UserCredentialsConnectionFactoryAdapter /** - * Set user credententials for this proxy and the current thread. + * Set user credentials for this proxy and the current thread. * The given username and password will be applied to all subsequent * {@code createConnection()} calls on this ConnectionFactory proxy. *

This will override any statically specified user credentials, diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java b/spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java index 534e12285f..e0a841aa21 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java @@ -465,7 +465,7 @@ public abstract class AbstractMessageListenerContainer extends AbstractJmsListen /** * Configure the reply destination type. By default, the configured {@code pubSubDomain} - * value is used (see {@link #isPubSubDomain()}. + * value is used (see {@link #isPubSubDomain()}). *

This setting primarily indicates what type of destination to resolve if dynamic * destinations are enabled. * @param replyPubSubDomain "true" for the Publish/Subscribe domain ({@link Topic Topics}), diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java b/spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java index 856be8c914..5c042ddc00 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java @@ -872,7 +872,7 @@ public class DefaultMessageListenerContainer extends AbstractPollingMessageListe } /** - * This implementations proceeds even after an exception thrown from + * This implementation proceeds even after an exception thrown from * {@code Connection.start()}, relying on listeners to perform * appropriate recovery. */ @@ -887,7 +887,7 @@ public class DefaultMessageListenerContainer extends AbstractPollingMessageListe } /** - * This implementations proceeds even after an exception thrown from + * This implementation proceeds even after an exception thrown from * {@code Connection.stop()}, relying on listeners to perform * appropriate recovery after a restart. */ diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/MessageListenerContainer.java b/spring-jms/src/main/java/org/springframework/jms/listener/MessageListenerContainer.java index 89bfe78daa..26ed83890c 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/MessageListenerContainer.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/MessageListenerContainer.java @@ -33,7 +33,7 @@ import org.springframework.lang.Nullable; public interface MessageListenerContainer extends SmartLifecycle { /** - * Setup the message listener to use. Throws an {@link IllegalArgumentException} + * Set up the message listener to use. Throws an {@link IllegalArgumentException} * if that message listener type is not supported. */ void setupMessageListener(Object messageListener); diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/SubscriptionNameProvider.java b/spring-jms/src/main/java/org/springframework/jms/listener/SubscriptionNameProvider.java index c8622a78c0..f817aac1ee 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/SubscriptionNameProvider.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/SubscriptionNameProvider.java @@ -18,12 +18,12 @@ package org.springframework.jms.listener; /** * Interface to be implemented by message listener objects that suggest a specific - * name for a durable subscription that they might be registered with. Otherwise + * name for a durable subscription that they might be registered with. Otherwise, * the listener class name will be used as a default subscription name. * *

Applies to {@link javax.jms.MessageListener} objects as well as to * {@link SessionAwareMessageListener} objects and plain listener methods - * (as supported by {@link org.springframework.jms.listener.adapter.MessageListenerAdapter}. + * (as supported by {@link org.springframework.jms.listener.adapter.MessageListenerAdapter}). * * @author Juergen Hoeller * @since 2.5.6 diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/adapter/MessageListenerAdapter.java b/spring-jms/src/main/java/org/springframework/jms/listener/adapter/MessageListenerAdapter.java index 2743b70439..f354fd5a7a 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/adapter/MessageListenerAdapter.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/adapter/MessageListenerAdapter.java @@ -36,7 +36,7 @@ import org.springframework.util.ObjectUtils; * Message listener adapter that delegates the handling of messages to target * listener methods via reflection, with flexible message type conversion. * Allows listener methods to operate on message content types, completely - * independent from the JMS API. + * independent of the JMS API. * *

By default, the content of incoming JMS messages gets extracted before * being passed into the target listener method, to let the target method diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/JmsActivationSpecConfig.java b/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/JmsActivationSpecConfig.java index ba2f6da68a..d28208fb4e 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/JmsActivationSpecConfig.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/JmsActivationSpecConfig.java @@ -182,7 +182,7 @@ public class JmsActivationSpecConfig { *

Note that JCA resource adapters generally only support auto and dups-ok * (see Spring's {@link StandardJmsActivationSpecFactory}). ActiveMQ also * supports "SESSION_TRANSACTED" in the form of RA-managed transactions - * (automatically translated by Spring's {@link DefaultJmsActivationSpecFactory}. + * (automatically translated by Spring's {@link DefaultJmsActivationSpecFactory}). * @param constantName the name of the {@link Session} acknowledge mode constant * @see javax.jms.Session#AUTO_ACKNOWLEDGE * @see javax.jms.Session#CLIENT_ACKNOWLEDGE diff --git a/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/StandardJmsActivationSpecFactory.java b/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/StandardJmsActivationSpecFactory.java index 632a125131..26f3efa129 100644 --- a/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/StandardJmsActivationSpecFactory.java +++ b/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/StandardJmsActivationSpecFactory.java @@ -192,8 +192,8 @@ public class StandardJmsActivationSpecFactory implements JmsActivationSpecFactor * case of {@code CLIENT_ACKNOWLEDGE} or {@code SESSION_TRANSACTED} * having been requested. * @param bw the BeanWrapper wrapping the ActivationSpec object - * @param ackMode the configured acknowledge mode - * (according to the constants in {@link javax.jms.Session} + * @param ackMode the configured acknowledgment mode + * (according to the constants in {@link javax.jms.Session}) * @see javax.jms.Session#AUTO_ACKNOWLEDGE * @see javax.jms.Session#DUPS_OK_ACKNOWLEDGE * @see javax.jms.Session#CLIENT_ACKNOWLEDGE diff --git a/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java b/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java index 305fc82498..03f89d28a7 100644 --- a/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java +++ b/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java @@ -100,7 +100,7 @@ public abstract class JmsAccessor implements InitializingBean { * parameters are not taken into account within a locally managed transaction * either, since the accessor operates on an existing JMS Session in this case. *

Setting this flag to "true" will use a short local JMS transaction - * when running outside of a managed transaction, and a synchronized local + * when running outside a managed transaction, and a synchronized local * JMS transaction in case of a managed transaction (other than an XA * transaction) being present. This has the effect of a local JMS * transaction being managed alongside the main transaction (which might @@ -124,7 +124,7 @@ public abstract class JmsAccessor implements InitializingBean { /** * Set the JMS acknowledgement mode by the name of the corresponding constant * in the JMS {@link Session} interface, e.g. "CLIENT_ACKNOWLEDGE". - *

If you want to use vendor-specific extensions to the acknowledgment mode, + *

If you want to use vendor-specific extensions to the acknowledgement mode, * use {@link #setSessionAcknowledgeMode(int)} instead. * @param constantName the name of the {@link Session} acknowledge mode constant * @see javax.jms.Session#AUTO_ACKNOWLEDGE @@ -140,7 +140,7 @@ public abstract class JmsAccessor implements InitializingBean { * Set the JMS acknowledgement mode that is used when creating a JMS * {@link Session} to send a message. *

Default is {@link Session#AUTO_ACKNOWLEDGE}. - *

Vendor-specific extensions to the acknowledgment mode can be set here as well. + *

Vendor-specific extensions to the acknowledgement mode can be set here as well. *

Note that inside an EJB, the parameters to the * {@code create(Queue/Topic)Session(boolean transacted, int acknowledgeMode)} method * are not taken into account. Depending on the transaction context in the EJB, diff --git a/spring-jms/src/test/java/org/springframework/jms/annotation/AbstractJmsAnnotationDrivenTests.java b/spring-jms/src/test/java/org/springframework/jms/annotation/AbstractJmsAnnotationDrivenTests.java index 0bd41eb7ee..eb96ae9325 100644 --- a/spring-jms/src/test/java/org/springframework/jms/annotation/AbstractJmsAnnotationDrivenTests.java +++ b/spring-jms/src/test/java/org/springframework/jms/annotation/AbstractJmsAnnotationDrivenTests.java @@ -113,9 +113,9 @@ abstract class AbstractJmsAnnotationDrivenTests { } /** - * Test for {@link CustomBean} and an manually endpoint registered + * Test for {@link CustomBean} and an endpoint manually registered * with "myCustomEndpointId". The custom endpoint does not provide - * any factory so it's registered with the default one + * any factory, so it's registered with the default one */ protected void testCustomConfiguration(ApplicationContext context) { JmsListenerContainerTestFactory defaultFactory = diff --git a/spring-jms/src/test/java/org/springframework/jms/core/JmsTemplateTests.java b/spring-jms/src/test/java/org/springframework/jms/core/JmsTemplateTests.java index 34bf543bdd..14364dfb38 100644 --- a/spring-jms/src/test/java/org/springframework/jms/core/JmsTemplateTests.java +++ b/spring-jms/src/test/java/org/springframework/jms/core/JmsTemplateTests.java @@ -270,7 +270,7 @@ class JmsTemplateTests { /** * Test sending to a destination using the method - * send(String d, MessageCreator messageCreator) + * {@code send(String d, MessageCreator messageCreator)} */ @Test void testSendDestinationName() throws Exception { @@ -279,7 +279,7 @@ class JmsTemplateTests { /** * Test sending to a destination using the method - * send(Destination d, MessageCreator messageCreator) using QOS parameters. + * {@code send(Destination d, MessageCreator messageCreator)} using QOS parameters. */ @Test void testSendDestinationWithQOS() throws Exception { @@ -288,7 +288,7 @@ class JmsTemplateTests { /** * Test sending to a destination using the method - * send(String d, MessageCreator messageCreator) using QOS parameters. + * {@code send(String d, MessageCreator messageCreator)} using QOS parameters. */ @Test void testSendDestinationNameWithQOS() throws Exception {