From 634739dc190b427c708bf290c4b7633e8d3554e0 Mon Sep 17 00:00:00 2001
From: Oleg Zhurakousky <ozhurakousky@vmware.com>
Date: Fri, 12 Mar 2010 03:49:31 +0000
Subject: [PATCH] INT-575, Added Javadoc

---
 .../transformer/ObjectToMapTransformer.java      | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/org.springframework.integration/src/main/java/org/springframework/integration/transformer/ObjectToMapTransformer.java b/org.springframework.integration/src/main/java/org/springframework/integration/transformer/ObjectToMapTransformer.java
index d4140bcabb..a8720d2d7f 100644
--- a/org.springframework.integration/src/main/java/org/springframework/integration/transformer/ObjectToMapTransformer.java
+++ b/org.springframework.integration/src/main/java/org/springframework/integration/transformer/ObjectToMapTransformer.java
@@ -20,6 +20,22 @@ import java.util.Map;
 
 
 /**
+ * Will transform an object graph into a flat Map where keys are valid SpEL expressions
+ * and values are of java.lang.* type. This means that this transformer will recursively navigate 
+ * through the Object graph until the value could be java.lang.*
+ * It supports Collections, Maps and Arrays which means it will flatten Object's attributes that are defined as such:<br>
+ * 
+ * private Map<String, Map<String, Object>> testMapInMapData;<br>
+ * private List<String> departments;<br>
+ * private String[] akaNames;<br>
+ * private Map<String, List<String>> mapWithListData;<br>
+ * 
+ * The resulting Map structure will look similar to this:<br>
+ * 
+ * person.address.mapWithListData['mapWithListTestData'][1]=blah<br>
+ * departments[0]=HR<br>
+ * person.lname=Case
+ * 
  * @author Oleg Zhurakousky
  * @since 2.0
  */