[Jboss-cvs] JBossAS SVN: r57015 - branches/Branch_4_0/messaging/src/main/org/jboss/mq/server

[jboss-cvs-commits at lists.jboss.org]

Author: adrian at jboss.org
Date: 2006-09-20 12:03:46 -0400 (Wed, 20 Sep 2006)
New Revision: 57015

Modified:
   branches/Branch_4_0/messaging/src/main/org/jboss/mq/server/BasicQueue.java
Log:
Fix a typo and javadoc fixes.

Modified: branches/Branch_4_0/messaging/src/main/org/jboss/mq/server/BasicQueue.java
===================================================================
--- branches/Branch_4_0/messaging/src/main/org/jboss/mq/server/BasicQueue.java	2006-09-20 16:03:44 UTC (rev 57014)
+++ branches/Branch_4_0/messaging/src/main/org/jboss/mq/server/BasicQueue.java	2006-09-20 16:03:46 UTC (rev 57015)
@@ -128,6 +128,7 @@
     * @param server the destination manager
     * @param description a description to uniquely identify the queue
     * @param parameters the basic queue parameters
+    * @throws JMSException for any error
     */
    public BasicQueue(JMSDestinationManager server, String description, BasicQueueParameters parameters)
       throws JMSException
@@ -200,6 +201,7 @@
     * Add a receiver to the queue
     *
     * @param sub the subscription to add
+    * @throws JMSException for any error
     */
    public void addReceiver(Subscription sub) throws JMSException
    {
@@ -260,6 +262,7 @@
     * Add a subscription from the queue
     *
     * @param sub the subscription to add
+    * @throws JMSException for any error
     */
    public void addSubscriber(Subscription sub) throws JMSException
    {
@@ -318,6 +321,8 @@
 
    /**
     * Returns the number of scheduled messages in the queue
+    * 
+    * @return the scheduled message count
     */
    public int getScheduledMessageCount()
    {
@@ -360,7 +365,7 @@
             }
          }
 
-         performOrPerpareAddMessage(mes, txId);
+         performOrPrepareAddMessage(mes, txId);
       }
       catch (Throwable t)
       {
@@ -378,7 +383,7 @@
     * @param txId the transaction id
     * @throws Exception for any error
     */
-   protected void performOrPerpareAddMessage(MessageReference mes, Tx txId) throws Exception
+   protected void performOrPrepareAddMessage(MessageReference mes, Tx txId) throws Exception
    {
       TxManager txManager = server.getPersistenceManager().getTxManager();
       
@@ -422,11 +427,11 @@
          }
          else if (type == Tx.ADD)
          {
-            performOrPerpareAddMessage(mes, txid);
+            performOrPrepareAddMessage(mes, txid);
          }
          else if (type == Tx.REMOVE)
          {
-            performOrPerpareAcknowledgeMessage(mes, txid);
+            performOrPrepareAcknowledgeMessage(mes, txid);
          }
          else
          {
@@ -474,6 +479,7 @@
     *
     * @param selector the selector to apply, pass null for
     *                 all messages
+    * @return the messages
     * @throws JMSException for any error
     */
    public SpyMessage[] browse(String selector) throws JMSException
@@ -516,8 +522,9 @@
    /**
     * Receive a message from the queue
     *
-    * @param the subscription requiring a message
+    * @param sub the subscription requiring a message
     * @param wait whether to wait for a message
+    * @return the message
     * @throws JMSException for any error
     */
    public SpyMessage receive(Subscription sub, boolean wait) throws JMSException
@@ -596,7 +603,7 @@
     * Acknowledge a message
     *
     * @param item the acknowledgement request
-    * @param txid the transaction
+    * @param txId the transaction
     * @throws JMSException for any error
     */
    public void acknowledge(AcknowledgementRequest item, Tx txId) throws JMSException
@@ -644,7 +651,7 @@
             SpyJMSException.rethrowAsJMSException("Error during ACK ref=" + m, t);
          }
 
-         performOrPerpareAcknowledgeMessage(m, txId);
+         performOrPrepareAcknowledgeMessage(m, txId);
       }
 
       synchronized (receivers)
@@ -663,7 +670,7 @@
     * @param txId the transaction id
     * @throws Exception for any error
     */
-   protected void performOrPerpareAcknowledgeMessage(MessageReference mes, Tx txId) throws JMSException
+   protected void performOrPrepareAcknowledgeMessage(MessageReference mes, Tx txId) throws JMSException
    {
       TxManager txManager = server.getPersistenceManager().getTxManager();