[jbpm-commits] JBoss JBPM SVN: r6692 - jbpm3/branches/jbpm-3.2-soa/enterprise-jee5/src/main/java/org/jbpm/jms.

[do-not-reply at jboss.org]

Author: bradsdavis
Date: 2010-09-28 08:21:22 -0400 (Tue, 28 Sep 2010)
New Revision: 6692

Modified:
   jbpm3/branches/jbpm-3.2-soa/enterprise-jee5/src/main/java/org/jbpm/jms/JmsUtil.java
Log:
Commented the JMSUtil.

Modified: jbpm3/branches/jbpm-3.2-soa/enterprise-jee5/src/main/java/org/jbpm/jms/JmsUtil.java
===================================================================
--- jbpm3/branches/jbpm-3.2-soa/enterprise-jee5/src/main/java/org/jbpm/jms/JmsUtil.java	2010-09-28 12:18:27 UTC (rev 6691)
+++ jbpm3/branches/jbpm-3.2-soa/enterprise-jee5/src/main/java/org/jbpm/jms/JmsUtil.java	2010-09-28 12:21:22 UTC (rev 6692)
@@ -8,6 +8,12 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
+/**
+ * Utility for handling common JMS tasks.
+ * 
+ * @author Brad Davis
+ *
+ */
 public class JmsUtil {
 
 	private static final Log log = LogFactory.getLog(JmsUtil.class);
@@ -15,6 +21,10 @@
 		//seal
 	}
 	
+	/**
+	 * Call within the finally block to cleanup message producers.
+	 * @param producer
+	 */
 	public static void closeSilently(MessageProducer producer)
 	{
 		if(producer!=null) {
@@ -26,6 +36,10 @@
 		}
 	}
 	
+	/**
+	 * Call within the finally block to cleanup JMS sessions.
+	 * @param session
+	 */
 	public static void closeSilently(Session session)
 	{
 		if(session!=null) {
@@ -37,6 +51,10 @@
 		}
 	}
 	
+	/**
+	 * Call within the finally block to cleanup JMS connections.
+	 * @param connection
+	 */
 	public static void closeSilently(Connection connection)
 	{
 		if(connection!=null) {