[jboss-svn-commits] JBL Code SVN: r23967 - labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers.

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

Author: beve
Date: 2008-11-19 09:59:00 -0500 (Wed, 19 Nov 2008)
New Revision: 23967

Modified:
   labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposer.java
   labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposerImpl.java
Log:
Updating javadocs


Modified: labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposer.java
===================================================================
--- labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposer.java	2008-11-19 14:50:52 UTC (rev 23966)
+++ labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposer.java	2008-11-19 14:59:00 UTC (rev 23967)
@@ -22,14 +22,13 @@
 
 import java.util.Properties;
 
-import javax.jms.JMSException;
 import javax.jms.Session;
 
 import org.jboss.esb.api.message.Message;
 import org.jboss.esb.api.message.MessageProcessingException;
 
 /**
- * JMS Message Composer.
+ * A JMSMessageComposer composes JMS Messages using the contents a an ESBMessage.
  *
  * @author <a href="mailto:dbevenius at jboss.com">Daniel Bevenius</a>
  *
@@ -37,12 +36,12 @@
 public interface JmsMessageComposer
 {
     /**
-     * Decompose the ESB Message object payload and uses the payload to create a
-     * new instance of T.
+     * Composes/creates a JMS Message object using the content on the passed-in
+     * ESB Message Object.
      *
-     * @param message The ESB message object instance.
-     * @param t The class parameter
-     * @return Object Any Object.
+     * @param message   The ESB message object instance.
+     * @param session   The JMS Session object needed to create various types of JMS Messages.
+     * @return Message  The new JMS Message Object.
      *
      * @throws MessageProcessingException If an error occurs while decomposeing.
      */
@@ -51,13 +50,14 @@
     /**
      * Add all of the properties to the outbound JMS Message.
      *
-     * @param esbMessage    The ESB Message.
-     * @throws JMSException Error extracting properties.
+     * @param properties    The properties to add to the outbound JMS Message.
+     * @param toJmsMessage  The outbound JMS Message object.
+     * @throws MessageProcessingException If an error occurs while setting on of the properites on the outbound JMS Message object.
      */
     void addEsbProperties(final Properties properties, final javax.jms.Message toJmsMessage) throws MessageProcessingException;
 
     /**
-     * Allows a MessageComposer implementation receive configuration information.
+     * Allows a JMSMessageComposer implementation receive configuration information.
      *
      * @param properties The properties.
      */

Modified: labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposerImpl.java
===================================================================
--- labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposerImpl.java	2008-11-19 14:50:52 UTC (rev 23966)
+++ labs/jbossesb/workspace/skeagh/routing/jms/src/main/java/org/jboss/esb/jms/composers/JmsMessageComposerImpl.java	2008-11-19 14:59:00 UTC (rev 23967)
@@ -43,7 +43,7 @@
 import org.jboss.esb.api.message.MessageProcessingException;
 
 /**
- * JMS Message Composer implementation.
+ * JMSMessageComposer implementation.
  *
  * @author <a href="mailto:dbevenius at redhat.com">Daniel Bevenius</a>
  *