Author: davsclaus
Date: Fri Mar 12 08:16:44 2010
New Revision: 922174
URL: http://svn.apache.org/viewvc?rev=922174&view=rev
Log:
Added more javadoc about getHeaders and how to walk it to ensure keys are in
original case
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java?rev=922174&r1=922173&r2=922174&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java Fri Mar
12 08:16:44 2010
@@ -135,7 +135,13 @@ public interface Message {
boolean removeHeaders(String pattern);
/**
- * Returns all of the headers associated with the message
+ * Returns all of the headers associated with the message.
+ * <p/>
+ * See {...@link org.apache.camel.impl.DefaultMessage DefaultMessage} for
how headers
+ * is represented in Camel using a {...@link
org.apache.camel.util.CaseInsensitiveMap CaseInsensitiveMap}.
+ * <p/>
+ * If you want to walk the returned Map and fetch all the keys and values,
you should use
+ * the {...@link java.util.Map#entrySet()} method, which ensure you get
the keys in the original case.
*
* @return all the headers in a Map
*/
