svn commit: r760198 - in /cxf/trunk/api/src/main/java/org/apache/cxf/message: Attachment.java Exchange.java Message.java

[er...@apache.org]

Author: ericjohnson
Date: Mon Mar 30 21:56:25 2009
New Revision: 760198

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

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

Modified: cxf/trunk/api/src/main/java/org/apache/cxf/message/Attachment.java
URL: http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/message/Attachment.java?rev=760198&r1=760197&r2=760198&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/message/Attachment.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/message/Attachment.java Mon Mar 30 21:56:25 2009
@@ -43,7 +43,7 @@
      * serialization of the attachment. If true, it will be serialized
      * as binary data, and not Base64Binary.
      * 
-     * @return true iff this attachment is an XOP package
+     * @return true if this attachment is an XOP package
      */
     boolean isXOP();
 }

Modified: cxf/trunk/api/src/main/java/org/apache/cxf/message/Exchange.java
URL: http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/message/Exchange.java?rev=760198&r1=760197&r2=760198&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/message/Exchange.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/message/Exchange.java Mon Mar 30 21:56:25 2009
@@ -24,9 +24,23 @@
 import org.apache.cxf.transport.Session;
 
 public interface Exchange extends StringMap {
+    
+    /**
+     * Returns the inbound message for the exchange. On the client-side, this 
+     * is the response. On the server-side, this is the request.
+     * 
+     * @return the inboubnd message
+     */
     Message getInMessage();
     void setInMessage(Message m);
     
+    /**
+     * Returns the outbound message for the exchange. On the client-side, this 
+     * is the request. On the server-side, this is the response. During the 
+     * inbound message processing, the outbound message is null.
+     * 
+     * @return the outbound message
+     */
     Message getOutMessage();
     void setOutMessage(Message m);
     
@@ -60,14 +74,18 @@
     void setConduit(Conduit conduit);
     
     /**
+     * Determines if the exchange is one-way.
+     * 
      * @return true if the exchange is known to be a one-way exchange
      */
     boolean isOneWay();
     
     /**
-     * @return true if the frontend will be wait for the response.   Transports
-     * can then optimize themselves to process the response immediately instead 
-     * of using a background thread or similar.
+     * Determines if the exchange requires the frontend to wait for a 
+     * response. Transports can then optimize themselves to process the 
+     * response immediately instead of using a background thread or similar.
+     * 
+     * @return true if the frontend will wait for the response
      */
     boolean isSynchronous();
     void setSynchronous(boolean b);
@@ -78,5 +96,8 @@
      */
     void setOneWay(boolean b);
     
+    /**
+     * {@inheritDoc}
+     */
     void clear();
 }

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=760198&r1=760197&r2=760198&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 Mon Mar 30 21:56:25 2009
@@ -93,6 +93,11 @@
 
     void setExchange(Exchange exchange);
     
+    /**
+     * Retrieve any binary attachments associated with the message.
+     *  
+     * @return a collection containing the attachments
+     */
     Collection<Attachment> getAttachments();
 
     void setAttachments(Collection<Attachment> attachments);