svn commit: r1185302 - /camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java

[dkulp]

Author: dkulp
Date: Mon Oct 17 17:38:04 2011
New Revision: 1185302

URL: http://svn.apache.org/viewvc?rev=1185302&view=rev
Log:
Add some javadocs to note streaming issues

Modified:
    
camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java

Modified: 
camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java?rev=1185302&r1=1185301&r2=1185302&view=diff
==============================================================================
--- 
camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java
 (original)
+++ 
camel/trunk/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfPayload.java
 Mon Oct 17 17:38:04 2011
@@ -119,7 +119,10 @@ public class CxfPayload<T> {
     }
 
     /**
-     * Gets the body as a List of source objects
+     * Gets the body as a List of source objects.   If possible, the Source 
objects
+     * will likely be StaxSource or similar that allows streaming.   If you 
plan to 
+     * modify or use the Source, be careful that the result is still usable by
+     * the Camel runtime.
      * @return
      */
     public List<Source> getBodySources() {
@@ -130,6 +133,13 @@ public class CxfPayload<T> {
         return headers;
     }
     
+    /**
+     * Returns the contents as a String
+     * Important notes:
+     *   1) This requires the message to be fully loaded breaking the streaming
+     *   2) For large messages, the result can be a VERY large String and 
require
+     *   large amounts of memory.
+     */
     public String toString() {
         XmlConverter converter = new XmlConverter();
         StringBuilder buf = new StringBuilder();