You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2015/10/08 23:34:58 UTC
qpid-jms git commit: NO-JIRA fix some additional javadocs
Repository: qpid-jms
Updated Branches:
refs/heads/master 3fb96f273 -> f259db7ee
NO-JIRA fix some additional javadocs
Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/f259db7e
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/f259db7e
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/f259db7e
Branch: refs/heads/master
Commit: f259db7ee556e9d9b3c0d46b382b6d6b57023c9d
Parents: 3fb96f2
Author: Timothy Bish <ta...@gmail.com>
Authored: Thu Oct 8 17:34:51 2015 -0400
Committer: Timothy Bish <ta...@gmail.com>
Committed: Thu Oct 8 17:34:51 2015 -0400
----------------------------------------------------------------------
.../org/apache/qpid/jms/JmsMessageConsumer.java | 23 +-------------------
.../org/apache/qpid/jms/JmsQueueBrowser.java | 6 ++++-
.../org/apache/qpid/jms/JmsQueueReceiver.java | 2 +-
.../org/apache/qpid/jms/jndi/JNDIStorable.java | 3 +++
.../apache/qpid/jms/jndi/ReadOnlyContext.java | 8 +++++--
.../selector/filter/ArithmeticExpression.java | 9 +++++---
.../jms/transports/netty/NettyTcpTransport.java | 2 ++
7 files changed, 24 insertions(+), 29 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
index e90c6c8..8d75093 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
@@ -65,32 +65,11 @@ public class JmsMessageConsumer implements MessageConsumer, JmsMessageAvailableC
protected final AtomicBoolean delivered = new AtomicBoolean();
protected final AtomicReference<Exception> failureCause = new AtomicReference<>();
- /**
- * Create a non-durable MessageConsumer
- *
- * @param consumerId
- * @param session
- * @param destination
- * @param selector
- * @param noLocal
- * @throws JMSException
- */
protected JmsMessageConsumer(JmsConsumerId consumerId, JmsSession session, JmsDestination destination,
String selector, boolean noLocal) throws JMSException {
this(consumerId, session, destination, null, selector, noLocal);
}
- /**
- * Create a MessageConsumer which could be durable.
- *
- * @param consumerId
- * @param session
- * @param destination
- * @param name
- * @param selector
- * @param noLocal
- * @throws JMSException
- */
protected JmsMessageConsumer(JmsConsumerId consumerId, JmsSession session, JmsDestination destination,
String name, String selector, boolean noLocal) throws JMSException {
this.session = session;
@@ -171,7 +150,7 @@ public class JmsMessageConsumer implements MessageConsumer, JmsMessageAvailableC
* Called to initiate shutdown of Producer resources and request that the remote
* peer remove the registered producer.
*
- * @throws JMSException
+ * @throws JMSException if an error occurs during the consumer close operation.
*/
protected void doClose() throws JMSException {
shutdown();
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/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 d301d33..1bb1ac6 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
@@ -70,9 +70,13 @@ public class JmsQueueBrowser implements QueueBrowser, Enumeration<Message> {
* Constructor for an JmsQueueBrowser - used internally
*
* @param session
+ * The Session that owns this instance.
* @param destination
+ * The Destination that will be browsed.
* @param selector
- * @throws javax.jms.JMSException
+ * The selector string used to filter the browsed message.
+ *
+ * @throws javax.jms.JMSException if an error occurs while creating this instance.
*/
protected JmsQueueBrowser(JmsSession session, JmsDestination destination, String selector) throws JMSException {
this.session = session;
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueReceiver.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueReceiver.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueReceiver.java
index 59c0b0b..e2b3596 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueReceiver.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsQueueReceiver.java
@@ -40,7 +40,7 @@ public class JmsQueueReceiver extends JmsMessageConsumer implements QueueReceive
* @param selector
* The selector used to filter messages for this receiver.
*
- * @throws JMSException
+ * @throws JMSException if an error occurs during the creation of the QueueReceiver.
*/
protected JmsQueueReceiver(JmsConsumerId id, JmsSession session, JmsDestination dest, String selector) throws JMSException {
super(id, session, dest, selector, false);
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/JNDIStorable.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/JNDIStorable.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/JNDIStorable.java
index 20edd95..507fbce 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/JNDIStorable.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/jndi/JNDIStorable.java
@@ -38,6 +38,8 @@ public abstract class JNDIStorable implements Referenceable, Externalizable {
* Set the properties that will represent the instance in JNDI
*
* @param props
+ * The properties to use when building the new isntance.
+ *
* @return a new, unmodifiable, map containing any unused properties, or empty if none were.
*/
protected abstract Map<String, String> buildFromProperties(Map<String, String> props);
@@ -46,6 +48,7 @@ public abstract class JNDIStorable implements Referenceable, Externalizable {
* Initialize the instance from properties stored in JNDI
*
* @param props
+ * The properties to use when initializing the new instance.
*/
protected abstract void populateProperties(Map<String, String> props);
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/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 c42fbf3..26341c7 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
@@ -132,9 +132,13 @@ public class ReadOnlyContext implements Context, Serializable {
* lopped off).
*
* @param name
+ * the name of the context to bind.
* @param value
- * @return
- * @throws javax.naming.NamingException
+ * the value to be bound.
+ *
+ * @return a map populated from the previous and current context.
+ *
+ * @throws javax.naming.NamingException if an error occurs during the bind.
*/
protected Map<String, Object> internalBind(String name, Object value) throws NamingException {
assert name != null && name.length() > 0;
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java
index 8538aea..e0d87cd 100755
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java
@@ -185,9 +185,12 @@ public abstract class ArithmeticExpression extends BinaryExpression {
}
/**
- * @param lvalue
- * @param rvalue
- * @return
+ * Perform the evaluation.
+ *
+ * @param lvalue the LHS of the evaluation.
+ * @param rvalue the RHS of the evaluation.
+ *
+ * @return the result of the evaluation.
*/
protected abstract Object evaluate(Object lvalue, Object rvalue);
http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f259db7e/qpid-jms-client/src/main/java/org/apache/qpid/jms/transports/netty/NettyTcpTransport.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/transports/netty/NettyTcpTransport.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/transports/netty/NettyTcpTransport.java
index 7b02238..cbb88f5 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/transports/netty/NettyTcpTransport.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/transports/netty/NettyTcpTransport.java
@@ -278,7 +278,9 @@ public class NettyTcpTransport implements Transport {
/**
* Called when the transport connection failed and an error should be returned.
+ *
* @param cause
+ * An IOException that describes the cause of the failed connection.
*/
protected void connectionFailed(IOException cause) {
failureCause = IOExceptionSupport.create(cause);
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org