svn commit: r758910 - /cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java

[er...@apache.org]

Author: ericjohnson
Date: Thu Mar 26 22:51:14 2009
New Revision: 758910

URL: http://svn.apache.org/viewvc?rev=758910&view=rev
Log:
added some javadoc

Modified:
    cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java

Modified: cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java
URL: http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java?rev=758910&r1=758909&r2=758910&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/message/Message.java Thu Mar 26 22:51:14 2009
@@ -25,6 +25,10 @@
 import org.apache.cxf.interceptor.InterceptorChain;
 import org.apache.cxf.transport.Destination;
 
+/**
+ * The base interface for all all message implementations. 
+ * All message objects passed to interceptors use this interface.
+ */
 public interface Message extends StringMap {
     
     String TRANSPORT = "org.apache.cxf.transport";    
@@ -70,6 +74,13 @@
     String getId();
     void setId(String id);
     
+    /**
+     * Returns a live copy of the messages interceptor chain. This is 
+     * useful when an interceptor wants to modify the interceptor chain on the 
+     * fly.
+     * 
+     * @return the interceptor chain used to process the message
+     */
     InterceptorChain getInterceptorChain();
     void setInterceptorChain(InterceptorChain chain);
 
@@ -116,6 +127,12 @@
      */
     <T> void removeContent(Class<T> format);
     
-    
+    /**
+     * Queries the Message object's metadata for a specific property.
+     * 
+     * @param key the Message interface's property strings that 
+     * correlates to the desired property 
+     * @return the property's value
+     */
     Object getContextualProperty(String key);   
 }