activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rajdav...@apache.org
Subject svn commit: r520288 - /activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
Date Tue, 20 Mar 2007 05:44:49 GMT
Author: rajdavies
Date: Mon Mar 19 22:44:49 2007
New Revision: 520288

URL: http://svn.apache.org/viewvc?view=rev&rev=520288
Log:
tided up the javadocs

Modified:
    activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java

Modified: activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java?view=diff&rev=520288&r1=520287&r2=520288
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java (original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java Mon Mar 19
22:44:49 2007
@@ -22,46 +22,59 @@
  * Represents the base interface of an exchange
  *
  * @version $Revision$
+ * @param <M> message or payload type
+ * @param <R> message or payload type for a response (for request/response exchange)
+ * @param <F> fault type
  */
 public interface Exchange<M,R,F> {
 
     /**
      * Accesses a specific header
+     * @param name 
+     * @return object header associated with the name
      */
     Object getHeader(String name);
 
     /**
      * Sets a header on the exchange
+     * @param name of the header 
+     * @param value to associate with the name
      */
     void setHeader(String name, Object value);
 
     /**
      * Returns all of the headers associated with the request
+     * @return all the headers in a Map
      */
     Map<String,Object> getHeaders();
 
     /**
      * Returns the request message
+     * @return the message
      */
     M getRequest();
 
     /**
      * Returns the response message
+     * @return the response
      */
     R getResponse();
 
     /**
      * Returns the fault message
+     * @return the fault
      */
     F getFault();
 
     /**
      * Returns the exception associated with this exchange
+     * @return the exception (or null if no faults)
      */
     Exception getException();
 
     /**
      * Sets the exception associated with this exchange
+     * @param e 
      */
     void setException(Exception e);
 



Mime
View raw message