[jboss-svn-commits] JBL Code SVN: r6271 - labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format

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

Author: mark.little at jboss.com
Date: 2006-09-18 10:31:10 -0400 (Mon, 18 Sep 2006)
New Revision: 6271

Modified:
   labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessageFactory.java
   labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessagePlugin.java
Log:
added more javadocs.

Modified: labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessageFactory.java
===================================================================
--- labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessageFactory.java	2006-09-18 14:05:48 UTC (rev 6270)
+++ labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessageFactory.java	2006-09-18 14:31:10 UTC (rev 6271)
@@ -38,10 +38,27 @@
 
 public abstract class MessageFactory
 {
-	public abstract Message getMessage (); // returns some default implementation.
-	public abstract Message getMessage (URI type);  // returns a message of a specific type.
-	public abstract Message getMessage (Message msg, URI type);  // convert a message from one form to another.
+	/**
+	 * @return some default implementation.
+	 */
 	
+	public abstract Message getMessage ();
+	
+	/**
+	 * @param type the unique identifier representing the type of this message.
+	 * @return the message, or <code>null</code> if no suitable plugin is available.
+	 */
+	
+	public abstract Message getMessage (URI type);
+	
+	/**
+	 * @param msg the message to convert.
+	 * @param type the type of the message we want to convert to.
+	 * @return a translated message, or <code>null</code> if no suitable plugin is available.
+	 */
+	
+	public abstract Message getMessage (Message msg, URI type);
+	
 	public static MessageFactory getInstance ()
 	{
 		return theFactory;

Modified: labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessagePlugin.java
===================================================================
--- labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessagePlugin.java	2006-09-18 14:05:48 UTC (rev 6270)
+++ labs/jbossesb/workspace/rearchitecture/product/core/rosetta/src/org/jboss/soa/esb/message/format/MessagePlugin.java	2006-09-18 14:31:10 UTC (rev 6271)
@@ -26,7 +26,9 @@
  */
 
 /**
- * Used to plug in new message formats dynamically.
+ * Used to plug in new message formats dynamically. Each plugin is responsible for
+ * returning a message implementation that knows how to serialize its state in a
+ * specific manner, e.g., XML or ASN.1.
  *  
  * @author Mark Little
  *
@@ -36,6 +38,15 @@
 {
 	public static final String MESSAGE_PLUGIN = "org.jboss.soa.esb.message.format.plugin";
 	
+	/**
+	 * @return the message instance.
+	 */
+	
 	public Message getMessage ();
+	
+	/**
+	 * @return the unique identifier for this message plugin.
+	 */
+	
 	public URI getType ();
 }