You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ro...@apache.org on 2015/02/25 13:20:54 UTC
[3/5] qpid-jms git commit: fix more javadoc errors when using running
release profile using Java 8
fix more javadoc errors when using running release profile using Java 8
Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/3a26fcc8
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/3a26fcc8
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/3a26fcc8
Branch: refs/heads/master
Commit: 3a26fcc883a834caf2d59113d85dba528d5d1ffd
Parents: c1c6012
Author: Robert Gemmell <ro...@apache.org>
Authored: Wed Feb 25 11:37:19 2015 +0000
Committer: Robert Gemmell <ro...@apache.org>
Committed: Wed Feb 25 12:09:26 2015 +0000
----------------------------------------------------------------------
.../main/java/org/apache/qpid/jms/JmsQueueBrowser.java | 13 ++++++-------
.../java/org/apache/qpid/jms/jndi/ReadOnlyContext.java | 4 +---
.../provider/amqp/message/AmqpJmsMessageFacade.java | 2 +-
.../jms/provider/amqp/message/AmqpMessageIdHelper.java | 10 +++++-----
.../qpid/jms/provider/failover/FailoverProvider.java | 4 ++--
.../java/org/apache/qpid/jms/util/IdGenerator.java | 2 +-
.../java/org/apache/qpid/jms/util/MessageQueue.java | 2 +-
.../java/org/apache/qpid/jms/util/PropertyUtil.java | 4 ++--
8 files changed, 19 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueBrowser.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueBrowser.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueBrowser.java
index 6d150e2..21810bf 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueBrowser.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueBrowser.java
@@ -33,19 +33,19 @@ import org.slf4j.LoggerFactory;
/**
* A client uses a <CODE>QueueBrowser</CODE> object to look at messages on a queue without
* removing them.
- * <p/>
- * <p/>
+ * <p>
+ * <p>
* The <CODE>getEnumeration</CODE> method returns a <CODE>
* java.util.Enumeration</CODE> that is used to scan the queue's messages. It may be an
* enumeration of the entire content of a queue, or it may contain only the messages matching a
* message selector.
- * <p/>
- * <p/>
+ * <p>
+ * <p>
* Messages may be arriving and expiring while the scan is done. The JMS API does not require
* the content of an enumeration to be a static snapshot of queue content. Whether these changes
* are visible or not depends on the JMS provider.
- * <p/>
- * <p/>
+ * <p>
+ * <p>
* A <CODE>QueueBrowser</CODE> can be created from either a <CODE>Session
* </CODE> or a <CODE>QueueSession</CODE>.
*
@@ -73,7 +73,6 @@ public class JmsQueueBrowser implements QueueBrowser, Enumeration<Message> {
* Constructor for an JmsQueueBrowser - used internally
*
* @param session
- * @param id
* @param destination
* @param selector
* @throws javax.jms.JMSException
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/ReadOnlyContext.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/ReadOnlyContext.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/ReadOnlyContext.java
index b4455ed..c42fbf3 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/ReadOnlyContext.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/ReadOnlyContext.java
@@ -41,18 +41,16 @@ import javax.naming.spi.NamingManager;
/**
* A read-only Context
- * <p/>
+ * <p>
* This version assumes it and all its sub-context are read-only and any attempt
* to modify (e.g. through bind) will result in an
* OperationNotSupportedException. Each Context in the tree builds a cache of
* the entries in all sub-contexts to optimize the performance of lookup.
- * </p>
* <p>
* This implementation is intended to optimize the performance of lookup(String)
* to about the level of a HashMap get. It has been observed that the scheme
* resolution phase performed by the JVM takes considerably longer, so for
* optimum performance lookups should be coded like:
- * </p>
* <code>
* Context componentContext = (Context)new InitialContext().lookup("java:comp");
* String envEntry = (String) componentContext.lookup("env/myEntry");
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpJmsMessageFacade.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpJmsMessageFacade.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpJmsMessageFacade.java
index 1c06093..9ee57eb 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpJmsMessageFacade.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpJmsMessageFacade.java
@@ -618,7 +618,7 @@ public class AmqpJmsMessageFacade implements JmsMessageFacade {
* means to clear the ttl field rather than set it to anything.
*
* @param ttl
- * the value to use, in range 0 <= x <= 2^32 - 1
+ * the value to use, in range {@literal 0 <= x <= 2^32 - 1}
*
* @throws MessageFormatException
*/
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpMessageIdHelper.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpMessageIdHelper.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpMessageIdHelper.java
index 9801661..f6f0b5f 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpMessageIdHelper.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/message/AmqpMessageIdHelper.java
@@ -34,12 +34,12 @@ import org.apache.qpid.proton.amqp.UnsignedLong;
* <p>AMQP messages allow for 4 types of message-id/correlation-id: message-id-string, message-id-binary,
* message-id-uuid, or message-id-ulong. In order to accept or return a string representation of these
* for interoperability with other AMQP clients, the following encoding can be used after removing or
- * before adding the "ID:" prefix used for a JMSMessageID value<br/>
+ * before adding the "ID:" prefix used for a JMSMessageID value:<br>
*
- * "AMQP_BINARY:<hex representation of binary content>"<br/>
- * "AMQP_UUID:<string representation of uuid>"<br/>
- * "AMQP_ULONG:<string representation of ulong>"<br/>
- * "AMQP_STRING:<string>"<br/>
+ * {@literal "AMQP_BINARY:<hex representation of binary content>"}<br>
+ * {@literal "AMQP_UUID:<string representation of uuid>"}<br>
+ * {@literal "AMQP_ULONG:<string representation of ulong>"}<br>
+ * {@literal "AMQP_STRING:<string>"}<br>
*
* <p>The AMQP_STRING encoding exists only for escaping message-id-string values that happen to begin
* with one of the encoding prefixes (including AMQP_STRING itself). It MUST NOT be used otherwise.
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/failover/FailoverProvider.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/failover/FailoverProvider.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/failover/FailoverProvider.java
index d1ee92f..4ee8bf3 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/failover/FailoverProvider.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/failover/FailoverProvider.java
@@ -806,7 +806,7 @@ public class FailoverProvider extends DefaultProviderListener implements Provide
/**
* Gets the current setting controlling how many Connect / Reconnect attempts must occur
- * before a warn message is logged. A value of {@code <= 0} indicates that there will be
+ * before a warn message is logged. A value of {@literal <= 0} indicates that there will be
* no warn message logged regardless of how many reconnect attempts occur.
*
* @return the current number of connection attempts before warn logging is triggered.
@@ -820,7 +820,7 @@ public class FailoverProvider extends DefaultProviderListener implements Provide
* is logged indicating that the transport is not connected. This can be useful when the
* client is running inside some container or service as it gives an indication of some
* problem with the client connection that might not otherwise be visible. To disable the
- * log messages this value should be set to a value @{code attempts <= 0}
+ * log messages this value should be set to a value {@literal <= 0}
*
* @param warnAfterReconnectAttempts
* The number of failed connection attempts that must happen before a warning is logged.
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/IdGenerator.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/IdGenerator.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/IdGenerator.java
index f07b5b4..5d7453e 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/IdGenerator.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/IdGenerator.java
@@ -209,7 +209,7 @@ public class IdGenerator {
*
* @param id1
* @param id2
- * @return 0 if equal else a positive if id1 is > id2 ...
+ * @return 0 if equal else a positive if {@literal id1 > id2} ...
*/
public static int compare(String id1, String id2) {
int result = -1;
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/MessageQueue.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/MessageQueue.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/MessageQueue.java
index a44faf6..11a19a4 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/MessageQueue.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/MessageQueue.java
@@ -57,7 +57,7 @@ public interface MessageQueue {
* Used to get an enqueued message. The amount of time this method blocks is
* based on the timeout value. - if timeout==-1 then it blocks until a
* message is received. - if timeout==0 then it it tries to not block at
- * all, it returns a message if it is available - if timeout>0 then it
+ * all, it returns a message if it is available - if {@literal timeout > 0} then it
* blocks up to timeout amount of time. Expired messages will consumed by
* this method.
*
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3a26fcc8/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/PropertyUtil.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/PropertyUtil.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/PropertyUtil.java
index e4aef66..8ee2d40 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/PropertyUtil.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/util/PropertyUtil.java
@@ -139,7 +139,7 @@ public class PropertyUtil {
}
/**
- * Get properties from a URI and return them in a new Map<String, String> instance.
+ * Get properties from a URI and return them in a new {@code Map<String, String>} instance.
*
* If the URI is null or the query string of the URI is null an empty Map is returned.
*
@@ -160,7 +160,7 @@ public class PropertyUtil {
/**
* Parse properties from a named resource -eg. a URI or a simple name e.g.
- * foo?name="fred"&size=2
+ * {@literal foo?name="fred"&size=2}
*
* @param uri
* the URI whose parameters are to be parsed.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org