Fix javadoc checkstyle issues

Fix checkstyle violations for javadoc. Issue: SPR-16968
2018-06-20 18:45:54 -07:00
parent 032096d699
commit e0480f75ac
928 changed files with 3729 additions and 2686 deletions
--- a/spring-jms/src/main/java/org/springframework/jms/annotation/EnableJms.java
+++ b/spring-jms/src/main/java/org/springframework/jms/annotation/EnableJms.java
@@ -152,17 +152,17 @@ import org.springframework.context.annotation.Import;
 * configuration:
 *
 * <pre class="code">
- * {@code <beans>
+ * &lt;beans&gt;
 *
- *     <jms:annotation-driven container-factory="myJmsListenerContainerFactory"/>
+ *     &lt;jms:annotation-driven container-factory="myJmsListenerContainerFactory"/&gt;
 *
- *     <bean id="myJmsListenerContainerFactory" class="org.springframework.jms.config.DefaultJmsListenerContainerFactory">
+ *     &lt;bean id="myJmsListenerContainerFactory" class="org.springframework.jms.config.DefaultJmsListenerContainerFactory"&gt;
 *           // factory settings
- *     </bean>
+ *     &lt;/bean&gt;
 *
- *     <bean id="myService" class="com.acme.foo.MyService"/>
+ *     &lt;bean id="myService" class="com.acme.foo.MyService"/&gt;
 *
- * </beans>
+ * &lt;/beans&gt;
 * }</pre>
 *
 * It is also possible to specify a custom {@link org.springframework.jms.config.JmsListenerEndpointRegistry
@@ -204,25 +204,25 @@ import org.springframework.context.annotation.Import;
 * For reference, the example above can be compared to the following Spring XML
 * configuration:
 * <pre class="code">
- * {@code <beans>
+ * &lt;beans&gt;
 *
- *     <jms:annotation-driven registry="myJmsListenerEndpointRegistry"
+ *     &lt;jms:annotation-driven registry="myJmsListenerEndpointRegistry"
 *         handler-method-factory="myJmsHandlerMethodFactory"/&gt;
 *
- *     <bean id="myJmsListenerEndpointRegistry"
- *           class="org.springframework.jms.config.JmsListenerEndpointRegistry">
+ *     &lt;bean id="myJmsListenerEndpointRegistry"
+ *           class="org.springframework.jms.config.JmsListenerEndpointRegistry"&gt;
 *           // registry configuration
- *     </bean>
+ *     &lt;/bean&gt;
 *
- *     <bean id="myJmsHandlerMethodFactory"
- *           class="org.springframework.messaging.handler.support.DefaultJmsHandlerMethodFactory">
- *         <property name="validator" ref="myValidator"/>
- *     </bean>
+ *     &lt;bean id="myJmsHandlerMethodFactory"
+ *           class="org.springframework.messaging.handler.support.DefaultJmsHandlerMethodFactory"&gt;
+ *         &lt;property name="validator" ref="myValidator"/&gt;
+ *     &lt;/bean&gt;
 *
- *     <bean id="myService" class="com.acme.foo.MyService"/>
+ *     &lt;bean id="myService" class="com.acme.foo.MyService"/&gt;
 *
- * </beans>
- * }</pre>
+ * &lt;/beans&gt;
+ * </pre>
 *
 * Implementing {@code JmsListenerConfigurer} also allows for fine-grained
 * control over endpoints registration via the {@code JmsListenerEndpointRegistrar}.
--- a/spring-jms/src/main/java/org/springframework/jms/config/AbstractJmsListenerContainerFactory.java
+++ b/spring-jms/src/main/java/org/springframework/jms/config/AbstractJmsListenerContainerFactory.java
@@ -33,6 +33,7 @@ import org.springframework.util.ErrorHandler;
 *
 * @author Stephane Nicoll
 * @since 4.1
+ * @param <C> the container type
 * @see AbstractMessageListenerContainer
 */
 public abstract class AbstractJmsListenerContainerFactory<C extends AbstractMessageListenerContainer>
--- a/spring-jms/src/main/java/org/springframework/jms/config/AbstractJmsListenerEndpoint.java
+++ b/spring-jms/src/main/java/org/springframework/jms/config/AbstractJmsListenerEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -25,7 +25,7 @@ import org.springframework.jms.listener.endpoint.JmsMessageEndpointManager;
 import org.springframework.lang.Nullable;

 /**
- * Base model for a JMS listener endpoint
+ * Base model for a JMS listener endpoint.
 *
 * @author Stephane Nicoll
 * @author Juergen Hoeller
--- a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerContainerFactory.java
+++ b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerContainerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -24,6 +24,7 @@ import org.springframework.jms.listener.MessageListenerContainer;
 *
 * @author Stephane Nicoll
 * @since 4.1
+ * @param <C> the container type
 * @see JmsListenerEndpoint
 */
 public interface JmsListenerContainerFactory<C extends MessageListenerContainer> {
--- a/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java
+++ b/spring-jms/src/main/java/org/springframework/jms/config/JmsListenerEndpointRegistry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -44,7 +44,7 @@ import org.springframework.util.Assert;
 * lifecycle of the listener containers, in particular within the lifecycle
 * of the application context.
 *
- * <p>Contrary to {@link MessageListenerContainer}s created manually, listener
+ * <p>Contrary to {@link MessageListenerContainer MessageListenerContainers} created manually, listener
 * containers managed by registry are not beans in the application context and
 * are not candidates for autowiring. Use {@link #getListenerContainers()} if
 * you need to access this registry's listener containers for management purposes.
@@ -103,8 +103,8 @@ public class JmsListenerEndpointRegistry implements DisposableBean, SmartLifecyc

 	/**
 	 * Return the ids of the managed {@link MessageListenerContainer} instance(s).
-	 * @see #getListenerContainer(String)
 	 * @since 4.2.3
+	 * @see #getListenerContainer(String)
 	 */
 	public Set<String> getListenerContainerIds() {
 		return Collections.unmodifiableSet(this.listenerContainers.keySet());
--- a/spring-jms/src/main/java/org/springframework/jms/connection/ChainedExceptionListener.java
+++ b/spring-jms/src/main/java/org/springframework/jms/connection/ChainedExceptionListener.java
@@ -32,7 +32,7 @@ import org.springframework.util.Assert;
 */
 public class ChainedExceptionListener implements ExceptionListener {

-	/** List of ExceptionListeners */
+	/** List of ExceptionListeners. */
 	private final List<ExceptionListener> delegates = new ArrayList<>(2);


--- a/spring-jms/src/main/java/org/springframework/jms/connection/SingleConnectionFactory.java
+++ b/spring-jms/src/main/java/org/springframework/jms/connection/SingleConnectionFactory.java
@@ -94,22 +94,22 @@ public class SingleConnectionFactory implements ConnectionFactory, QueueConnecti

 	private boolean reconnectOnException = false;

-	/** The target Connection */
+	/** The target Connection. */
 	@Nullable
 	private Connection connection;

-	/** A hint whether to create a queue or topic connection */
+	/** A hint whether to create a queue or topic connection. */
 	@Nullable
 	private Boolean pubSubMode;

-	/** An internal aggregator allowing for per-connection ExceptionListeners */
+	/** An internal aggregator allowing for per-connection ExceptionListeners. */
 	@Nullable
 	private AggregatedExceptionListener aggregatedExceptionListener;

-	/** Whether the shared Connection has been started */
+	/** Whether the shared Connection has been started. */
 	private int startedCount = 0;

-	/** Synchronization monitor for the shared Connection */
+	/** Synchronization monitor for the shared Connection. */
 	private final Object connectionMonitor = new Object();


--- a/spring-jms/src/main/java/org/springframework/jms/core/BrowserCallback.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/BrowserCallback.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -31,6 +31,7 @@ import org.springframework.lang.Nullable;
 *
 * @author Juergen Hoeller
 * @since 2.5.1
+ * @param <T> the result type
 * @see JmsTemplate#browse(BrowserCallback)
 * @see JmsTemplate#browseSelected(String, BrowserCallback)
 */
--- a/spring-jms/src/main/java/org/springframework/jms/core/JmsMessageOperations.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/JmsMessageOperations.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -30,7 +30,7 @@ import org.springframework.messaging.core.MessageSendingOperations;
 /**
 * A specialization of {@link MessageSendingOperations}, {@link MessageReceivingOperations}
 * and {@link MessageRequestReplyOperations} for JMS related operations that allow to specify
- * a destination name rather than the actual {@link javax.jms.Destination}
+ * a destination name rather than the actual {@link javax.jms.Destination}.
 *
 * @author Stephane Nicoll
 * @since 4.1
--- a/spring-jms/src/main/java/org/springframework/jms/core/JmsTemplate.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/JmsTemplate.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -88,7 +88,7 @@ import org.springframework.util.Assert;
 */
 public class JmsTemplate extends JmsDestinationAccessor implements JmsOperations {

-	/** Internal ResourceFactory adapter for interacting with ConnectionFactoryUtils */
+	/** Internal ResourceFactory adapter for interacting with ConnectionFactoryUtils. */
 	private final JmsTemplateResourceFactory transactionalResourceFactory = new JmsTemplateResourceFactory();


@@ -368,11 +368,11 @@ public class JmsTemplate extends JmsDestinationAccessor implements JmsOperations
 	/**
 	 * Set the {@link QosSettings} to use when sending a message.
 	 * @param settings the deliveryMode, priority, and timeToLive settings to use
+	 * @since 5.0
 	 * @see #setExplicitQosEnabled(boolean)
 	 * @see #setDeliveryMode(int)
 	 * @see #setPriority(int)
 	 * @see #setTimeToLive(long)
-	 * @since 5.0
 	 */
 	public void setQosSettings(QosSettings settings) {
 		Assert.notNull(settings, "Settings must not be null");
--- a/spring-jms/src/main/java/org/springframework/jms/core/ProducerCallback.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/ProducerCallback.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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,6 +34,7 @@ import org.springframework.lang.Nullable;
 *
 * @author Mark Pollack
 * @since 1.1
+ * @param <T> the result type
 * @see JmsTemplate#execute(ProducerCallback)
 * @see JmsTemplate#execute(javax.jms.Destination, ProducerCallback)
 * @see JmsTemplate#execute(String, ProducerCallback)
--- a/spring-jms/src/main/java/org/springframework/jms/core/SessionCallback.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/SessionCallback.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -29,6 +29,7 @@ import org.springframework.lang.Nullable;
 *
 * @author Mark Pollack
 * @since 1.1
+ * @param <T> the result type
 * @see JmsTemplate#execute(SessionCallback)
 */
@FunctionalInterface
--- a/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java
+++ b/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -43,7 +43,7 @@ import org.springframework.lang.Nullable;
 */
 public abstract class JmsGatewaySupport implements InitializingBean {

-	/** Logger available to subclasses */
+	/** Logger available to subclasses. */
 	protected final Log logger = LogFactory.getLog(getClass());

 	@Nullable
--- a/spring-jms/src/main/java/org/springframework/jms/listener/SessionAwareMessageListener.java
+++ b/spring-jms/src/main/java/org/springframework/jms/listener/SessionAwareMessageListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -35,6 +35,7 @@ import javax.jms.Session;
 *
 * @author Juergen Hoeller
 * @since 2.0
+ * @param <M> the message type
 * @see AbstractMessageListenerContainer#setMessageListener
 * @see DefaultMessageListenerContainer
 * @see SimpleMessageListenerContainer
--- a/spring-jms/src/main/java/org/springframework/jms/listener/adapter/AbstractAdaptableMessageListener.java
+++ b/spring-jms/src/main/java/org/springframework/jms/listener/adapter/AbstractAdaptableMessageListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -57,7 +57,7 @@ import org.springframework.util.Assert;
 public abstract class AbstractAdaptableMessageListener
 		implements MessageListener, SessionAwareMessageListener<Message> {

-	/** Logger available to subclasses */
+	/** Logger available to subclasses. */
 	protected final Log logger = LogFactory.getLog(getClass());

 	@Nullable
--- a/spring-jms/src/main/java/org/springframework/jms/listener/adapter/JmsResponse.java
+++ b/spring-jms/src/main/java/org/springframework/jms/listener/adapter/JmsResponse.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -49,9 +49,9 @@ import org.springframework.util.Assert;
 *
 * @author Stephane Nicoll
 * @since 4.2
+ * @param <T> the type of the response
 * @see org.springframework.jms.annotation.JmsListener
 * @see org.springframework.messaging.handler.annotation.SendTo
- * @param <T> the type of the response
 */
 public class JmsResponse<T> {

@@ -61,7 +61,7 @@ public class JmsResponse<T> {


 	/**
-	 * Create a new instance
+	 * Create a new {@link JmsResponse} instance.
 	 * @param response the content of the result
 	 * @param destination the destination
 	 */
--- a/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/DefaultJmsActivationSpecFactory.java
+++ b/spring-jms/src/main/java/org/springframework/jms/listener/endpoint/DefaultJmsActivationSpecFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -62,7 +62,7 @@ public class DefaultJmsActivationSpecFactory extends StandardJmsActivationSpecFa
 	private static final String ACTIVATION_SPEC_IMPL_SUFFIX = "ActivationSpecImpl";


-	/** Logger available to subclasses */
+	/** Logger available to subclasses. */
 	protected final Log logger = LogFactory.getLog(getClass());


--- 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
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -40,7 +40,7 @@ import org.springframework.lang.Nullable;
 */
 public class JmsActivationSpecConfig {

-	/** Constants instance for javax.jms.Session */
+	/** Constants instance for {@code javax.jms.Session}. */
 	private static final Constants sessionConstants = new Constants(Session.class);


--- a/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java
+++ b/spring-jms/src/main/java/org/springframework/jms/support/JmsAccessor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -47,11 +47,11 @@ import org.springframework.util.Assert;
 */
 public abstract class JmsAccessor implements InitializingBean {

-	/** Constants instance for javax.jms.Session */
+	/** Constants instance for {@code javax.jms.Session}. */
 	private static final Constants sessionConstants = new Constants(Session.class);


-	/** Logger available to subclasses */
+	/** Logger available to subclasses. */
 	protected final Log logger = LogFactory.getLog(getClass());

 	@Nullable
--- a/spring-jms/src/main/java/org/springframework/jms/support/converter/MappingJackson2MessageConverter.java
+++ b/spring-jms/src/main/java/org/springframework/jms/support/converter/MappingJackson2MessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -267,8 +267,8 @@ public class MappingJackson2MessageConverter implements SmartMessageConverter, B
 	 * @return the resulting message
 	 * @throws JMSException if thrown by JMS methods
 	 * @throws IOException in case of I/O errors
-	 * @see Session#createBytesMessage
 	 * @since 4.3
+	 * @see Session#createBytesMessage
 	 */
 	protected TextMessage mapToTextMessage(Object object, Session session, ObjectWriter objectWriter)
 			throws JMSException, IOException {
--- a/spring-jms/src/main/java/org/springframework/jms/support/converter/MessageType.java
+++ b/spring-jms/src/main/java/org/springframework/jms/support/converter/MessageType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -27,6 +27,24 @@ package org.springframework.jms.support.converter;
 */
 public enum MessageType {

-	TEXT, BYTES, MAP, OBJECT
+	/**
+	 * A {@link javax.jms.TextMessage}.
+	 */
+	TEXT,
+
+	/**
+	 * A {@link javax.jms.BytesMessage}.
+	 */
+	BYTES,
+
+	/**
+	 * A {@link javax.jms.MapMessage}.
+	 */
+	MAP,
+
+	/**
+	 * A {@link javax.jms.ObjectMessage}.
+	 */
+	OBJECT

 }
--- a/spring-jms/src/main/java/org/springframework/jms/support/converter/MessagingMessageConverter.java
+++ b/spring-jms/src/main/java/org/springframework/jms/support/converter/MessagingMessageConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -134,8 +134,8 @@ public class MessagingMessageConverter implements MessageConverter, Initializing
 	 * Create a JMS message for the specified payload and conversionHint.
 	 * The conversion hint is an extra object passed to the {@link MessageConverter},
 	 * e.g. the associated {@code MethodParameter} (may be {@code null}}.
-	 * @see MessageConverter#toMessage(Object, Session)
 	 * @since 4.3
+	 * @see MessageConverter#toMessage(Object, Session)
 	 */
 	protected javax.jms.Message createMessageForPayload(
 			Object payload, Session session, @Nullable Object conversionHint) throws JMSException {