From 9a439b47914a880f5536d18ec15ed57a74ffaedc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Sun, 9 Oct 2016 17:32:35 +0300 Subject: [PATCH] javadoc: Fix doclint reference errors --- .../store/file/JDBCSequentialFileFactoryDriver.java | 5 ++--- .../jms/client/ActiveMQConnectionFactory.java | 2 -- .../amqp/converter/message/OutboundTransformer.java | 4 +++- .../activemq/artemis/core/paging/PagingManager.java | 2 +- .../activemq/artemis/core/paging/PagingStore.java | 2 +- .../activemq/artemis/core/server/ActiveMQServer.java | 2 +- .../activemq/transport/amqp/client/AmqpMessage.java | 12 ++++++------ 7 files changed, 14 insertions(+), 15 deletions(-) diff --git a/artemis-jdbc-store/src/main/java/org/apache/activemq/artemis/jdbc/store/file/JDBCSequentialFileFactoryDriver.java b/artemis-jdbc-store/src/main/java/org/apache/activemq/artemis/jdbc/store/file/JDBCSequentialFileFactoryDriver.java index 2110173c8e..00f73b380c 100644 --- a/artemis-jdbc-store/src/main/java/org/apache/activemq/artemis/jdbc/store/file/JDBCSequentialFileFactoryDriver.java +++ b/artemis-jdbc-store/src/main/java/org/apache/activemq/artemis/jdbc/store/file/JDBCSequentialFileFactoryDriver.java @@ -94,7 +94,6 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver { * Opens the supplied file. If the file does not exist in the database it will create a new one. * * @param file - * @return * @throws SQLException */ public void openFile(JDBCSequentialFile file) throws SQLException { @@ -216,7 +215,7 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver { * @param file * @param data * @return - * @throws Exception + * @throws SQLException */ public synchronized int writeToFile(JDBCSequentialFile file, byte[] data) throws SQLException { try { @@ -238,7 +237,7 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver { * @param file * @param bytes * @return - * @throws Exception + * @throws SQLException */ public synchronized int readFromFile(JDBCSequentialFile file, ByteBuffer bytes) throws SQLException { connection.setAutoCommit(false); diff --git a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/ActiveMQConnectionFactory.java b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/ActiveMQConnectionFactory.java index 3a16cbde51..4f6528b496 100644 --- a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/ActiveMQConnectionFactory.java +++ b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/ActiveMQConnectionFactory.java @@ -652,7 +652,6 @@ public class ActiveMQConnectionFactory implements ConnectionFactoryOptions, Exte /** * @param interceptorList a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method. - * @return this */ public void setIncomingInterceptorList(String interceptorList) { checkWrite(); @@ -665,7 +664,6 @@ public class ActiveMQConnectionFactory implements ConnectionFactoryOptions, Exte /** * @param interceptorList a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method. - * @return this */ public void setOutgoingInterceptorList(String interceptorList) { serverLocator.setOutgoingInterceptorList(interceptorList); diff --git a/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/OutboundTransformer.java b/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/OutboundTransformer.java index f15490f047..51135135db 100644 --- a/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/OutboundTransformer.java +++ b/artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/OutboundTransformer.java @@ -43,8 +43,10 @@ public abstract class OutboundTransformer { * * @return the message format key of the encoded message. * - * @throws Exception + * @throws JMSException * if an error occurs during message transformation + * @throws UnsupportedEncodingException + * if an error occurs during message encoding */ public abstract long transform(ServerJMSMessage message, WritableBuffer buffer) throws JMSException, UnsupportedEncodingException; diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java index 5505412254..15b2701c3a 100644 --- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java +++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java @@ -27,7 +27,7 @@ import org.apache.activemq.artemis.core.settings.HierarchicalRepositoryChangeLis * 
  *
  * +--------------+      1  +----------------+       N +--------------+       N +--------+       1 +-------------------+
- * | {@link org.apache.activemq.artemis.core.postoffice.PostOffice} |-------> |{@link PagingManager}|-------> |{@link PagingStore} | ------> | {@link org.apache.activemq.artemis.core.paging.impl.Page}  | ------> | {@link SequentialFile} |
+ * | {@link org.apache.activemq.artemis.core.postoffice.PostOffice} |-------> |{@link PagingManager}|-------> |{@link PagingStore} | ------> | {@link org.apache.activemq.artemis.core.paging.impl.Page}  | ------> | {@link org.apache.activemq.artemis.core.io.SequentialFile} |
  * +--------------+         +----------------+         +--------------+         +--------+         +-------------------+
  * |                  1 ^
  * |                    |
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingStore.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingStore.java
index 3ae7f75414..5ead1a2497 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingStore.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingStore.java
@@ -166,7 +166,7 @@ public interface PagingStore extends ActiveMQComponent {
    /**
     * Sends the pages with given IDs to the {@link ReplicationManager}.
     * 

-    * Sending is done here to avoid exposing the internal {@link SequentialFile}s.
+    * Sending is done here to avoid exposing the internal {@link org.apache.activemq.artemis.core.io.SequentialFile}s.
     *
     * @param replicator
     * @param pageIds
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
index 588c17c3c6..477f839aa6 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
@@ -279,7 +279,7 @@ public interface ActiveMQServer extends ActiveMQComponent {
     * @param name
     * @param filterString
     * @param durable
-    * @throws ActiveMQInvalidTransientQueueUseException if the shared queue already exists with a different {@code address} or {@code filter}
+    * @throws org.apache.activemq.artemis.api.core.ActiveMQInvalidTransientQueueUseException if the shared queue already exists with a different {@code address} or {@code filterString}
     * @throws NullPointerException                      if {@code address} is {@code null}
     */
    void createSharedQueue(final SimpleString address,
diff --git a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpMessage.java b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpMessage.java
index 3ca17a62eb..f7a9364ffb 100644
--- a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpMessage.java
+++ b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpMessage.java
@@ -150,7 +150,7 @@ public class AmqpMessage {
    /**
     * Accepts the message marking it as consumed on the remote peer.
     *
-    * @param session The session that is used to manage acceptance of the message.
+    * @param txnSession The session that is used to manage acceptance of the message.
     * @throws Exception if an error occurs during the accept.
     */
    public void accept(AmqpSession txnSession) throws Exception {
@@ -160,7 +160,7 @@ public class AmqpMessage {
    /**
     * Accepts the message marking it as consumed on the remote peer.
     *
-    * @param session
+    * @param txnSession
     *      The session that is used to manage acceptance of the message.
     *
     * @throws Exception if an error occurs during the accept.
@@ -354,7 +354,7 @@ public class AmqpMessage {
    /**
     * Sets the GroupId property on an outbound message using the provided String
     *
-    * @param messageId the String Group ID value to set.
+    * @param groupId the String Group ID value to set.
     */
    public void setGroupId(String groupId) {
       checkReadOnly();
@@ -505,7 +505,7 @@ public class AmqpMessage {
     * Sets a byte array value into the body of an outgoing Message, throws
     * an exception if this is an incoming message instance.
     *
-    * @param value the byte array value to store in the Message body.
+    * @param bytes the byte array value to store in the Message body.
     * @throws IllegalStateException if the message is read only.
     */
    public void setBytes(byte[] bytes) throws IllegalStateException {
@@ -515,10 +515,10 @@ public class AmqpMessage {
    }
 
    /**
-    * Sets a byte array value into the body of an outgoing Message, throws
+    * Sets a described type into the body of an outgoing Message, throws
     * an exception if this is an incoming message instance.
     *
-    * @param value the byte array value to store in the Message body.
+    * @param described the described type value to store in the Message body.
     * @throws IllegalStateException if the message is read only.
     */
    public void setDescribedType(DescribedType described) throws IllegalStateException {