Fix and improve Javadoc in spring-jms

See gh-28800
This commit is contained in:
Marc Wrobel 2022-07-12 15:53:53 +02:00 committed by Sam Brannen
parent 82ca27e46f
commit e76fbcb290
13 changed files with 22 additions and 22 deletions

View File

@ -121,7 +121,7 @@ public class JmsListenerEndpointRegistry implements DisposableBean, SmartLifecyc
/** /**
* Create a message listener container for the given {@link JmsListenerEndpoint}. * Create a message listener container for the given {@link JmsListenerEndpoint}.
* <p>This create the necessary infrastructure to honor that endpoint * <p>This create the necessary infrastructure to honor that endpoint
* with regards to its configuration. * with regard to its configuration.
* <p>The {@code startImmediately} flag determines if the container should be * <p>The {@code startImmediately} flag determines if the container should be
* started immediately. * started immediately.
* @param endpoint the endpoint to add * @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}. * Create a message listener container for the given {@link JmsListenerEndpoint}.
* <p>This create the necessary infrastructure to honor that endpoint * <p>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 endpoint the endpoint to add
* @param factory the listener factory to use * @param factory the listener factory to use
* @see #registerListenerContainer(JmsListenerEndpoint, JmsListenerContainerFactory, boolean) * @see #registerListenerContainer(JmsListenerEndpoint, JmsListenerContainerFactory, boolean)

View File

@ -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 * The given username and password will be applied to all subsequent
* {@code createConnection()} calls on this ConnectionFactory proxy. * {@code createConnection()} calls on this ConnectionFactory proxy.
* <p>This will override any statically specified user credentials, * <p>This will override any statically specified user credentials,

View File

@ -465,7 +465,7 @@ public abstract class AbstractMessageListenerContainer extends AbstractJmsListen
/** /**
* Configure the reply destination type. By default, the configured {@code pubSubDomain} * Configure the reply destination type. By default, the configured {@code pubSubDomain}
* value is used (see {@link #isPubSubDomain()}. * value is used (see {@link #isPubSubDomain()}).
* <p>This setting primarily indicates what type of destination to resolve if dynamic * <p>This setting primarily indicates what type of destination to resolve if dynamic
* destinations are enabled. * destinations are enabled.
* @param replyPubSubDomain "true" for the Publish/Subscribe domain ({@link Topic Topics}), * @param replyPubSubDomain "true" for the Publish/Subscribe domain ({@link Topic Topics}),

View File

@ -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 * {@code Connection.start()}, relying on listeners to perform
* appropriate recovery. * 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 * {@code Connection.stop()}, relying on listeners to perform
* appropriate recovery after a restart. * appropriate recovery after a restart.
*/ */

View File

@ -18,12 +18,12 @@ package org.springframework.jms.listener;
/** /**
* Interface to be implemented by message listener objects that suggest a specific * 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. * the listener class name will be used as a default subscription name.
* *
* <p>Applies to {@link javax.jms.MessageListener} objects as well as to * <p>Applies to {@link javax.jms.MessageListener} objects as well as to
* {@link SessionAwareMessageListener} objects and plain listener methods * {@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 * @author Juergen Hoeller
* @since 2.5.6 * @since 2.5.6

View File

@ -36,7 +36,7 @@ import org.springframework.util.ObjectUtils;
* Message listener adapter that delegates the handling of messages to target * Message listener adapter that delegates the handling of messages to target
* listener methods via reflection, with flexible message type conversion. * listener methods via reflection, with flexible message type conversion.
* Allows listener methods to operate on message content types, completely * Allows listener methods to operate on message content types, completely
* independent from the JMS API. * independent of the JMS API.
* *
* <p>By default, the content of incoming JMS messages gets extracted before * <p>By default, the content of incoming JMS messages gets extracted before
* being passed into the target listener method, to let the target method * being passed into the target listener method, to let the target method

View File

@ -182,7 +182,7 @@ public class JmsActivationSpecConfig {
* <p>Note that JCA resource adapters generally only support auto and dups-ok * <p>Note that JCA resource adapters generally only support auto and dups-ok
* (see Spring's {@link StandardJmsActivationSpecFactory}). ActiveMQ also * (see Spring's {@link StandardJmsActivationSpecFactory}). ActiveMQ also
* supports "SESSION_TRANSACTED" in the form of RA-managed transactions * 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 * @param constantName the name of the {@link Session} acknowledge mode constant
* @see javax.jms.Session#AUTO_ACKNOWLEDGE * @see javax.jms.Session#AUTO_ACKNOWLEDGE
* @see javax.jms.Session#CLIENT_ACKNOWLEDGE * @see javax.jms.Session#CLIENT_ACKNOWLEDGE

View File

@ -192,8 +192,8 @@ public class StandardJmsActivationSpecFactory implements JmsActivationSpecFactor
* case of {@code CLIENT_ACKNOWLEDGE} or {@code SESSION_TRANSACTED} * case of {@code CLIENT_ACKNOWLEDGE} or {@code SESSION_TRANSACTED}
* having been requested. * having been requested.
* @param bw the BeanWrapper wrapping the ActivationSpec object * @param bw the BeanWrapper wrapping the ActivationSpec object
* @param ackMode the configured acknowledge mode * @param ackMode the configured acknowledgment mode
* (according to the constants in {@link javax.jms.Session} * (according to the constants in {@link javax.jms.Session})
* @see javax.jms.Session#AUTO_ACKNOWLEDGE * @see javax.jms.Session#AUTO_ACKNOWLEDGE
* @see javax.jms.Session#DUPS_OK_ACKNOWLEDGE * @see javax.jms.Session#DUPS_OK_ACKNOWLEDGE
* @see javax.jms.Session#CLIENT_ACKNOWLEDGE * @see javax.jms.Session#CLIENT_ACKNOWLEDGE

View File

@ -100,7 +100,7 @@ public abstract class JmsAccessor implements InitializingBean {
* parameters are not taken into account within a locally managed transaction * parameters are not taken into account within a locally managed transaction
* either, since the accessor operates on an existing JMS Session in this case. * either, since the accessor operates on an existing JMS Session in this case.
* <p>Setting this flag to "true" will use a short local JMS transaction * <p>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 * 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 present. This has the effect of a local JMS
* transaction being managed alongside the main transaction (which might * 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 * Set the JMS acknowledgement mode by the name of the corresponding constant
* in the JMS {@link Session} interface, e.g. "CLIENT_ACKNOWLEDGE". * in the JMS {@link Session} interface, e.g. "CLIENT_ACKNOWLEDGE".
* <p>If you want to use vendor-specific extensions to the acknowledgment mode, * <p>If you want to use vendor-specific extensions to the acknowledgement mode,
* use {@link #setSessionAcknowledgeMode(int)} instead. * use {@link #setSessionAcknowledgeMode(int)} instead.
* @param constantName the name of the {@link Session} acknowledge mode constant * @param constantName the name of the {@link Session} acknowledge mode constant
* @see javax.jms.Session#AUTO_ACKNOWLEDGE * @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 * Set the JMS acknowledgement mode that is used when creating a JMS
* {@link Session} to send a message. * {@link Session} to send a message.
* <p>Default is {@link Session#AUTO_ACKNOWLEDGE}. * <p>Default is {@link Session#AUTO_ACKNOWLEDGE}.
* <p>Vendor-specific extensions to the acknowledgment mode can be set here as well. * <p>Vendor-specific extensions to the acknowledgement mode can be set here as well.
* <p>Note that inside an EJB, the parameters to the * <p>Note that inside an EJB, the parameters to the
* {@code create(Queue/Topic)Session(boolean transacted, int acknowledgeMode)} method * {@code create(Queue/Topic)Session(boolean transacted, int acknowledgeMode)} method
* are not taken into account. Depending on the transaction context in the EJB, * are not taken into account. Depending on the transaction context in the EJB,

View File

@ -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 * 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) { protected void testCustomConfiguration(ApplicationContext context) {
JmsListenerContainerTestFactory defaultFactory = JmsListenerContainerTestFactory defaultFactory =

View File

@ -270,7 +270,7 @@ class JmsTemplateTests {
/** /**
* Test sending to a destination using the method * Test sending to a destination using the method
* send(String d, MessageCreator messageCreator) * {@code send(String d, MessageCreator messageCreator)}
*/ */
@Test @Test
void testSendDestinationName() throws Exception { void testSendDestinationName() throws Exception {
@ -279,7 +279,7 @@ class JmsTemplateTests {
/** /**
* Test sending to a destination using the method * 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 @Test
void testSendDestinationWithQOS() throws Exception { void testSendDestinationWithQOS() throws Exception {
@ -288,7 +288,7 @@ class JmsTemplateTests {
/** /**
* Test sending to a destination using the method * 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 @Test
void testSendDestinationNameWithQOS() throws Exception { void testSendDestinationNameWithQOS() throws Exception {