Add comments support in U.toXml(map).

Author: javadev

src/main/java/com/github/underscore/lodash/U.java

@@ -2074,6 +2074,8 @@ public static void writeXml(Map map, String name, XmlStringBuilder builder, bool
                         value = (String) entry.getValue();
                     }
                     elems.add(new XmlStringBuilderWithoutHeader(ident).append(escape(value)));
+                } else if ("#comment".equals(escape(String.valueOf(entry.getKey())))) {
+                    addComment(entry, ident, index, entries, elems);
                 } else if (entry.getValue() instanceof List && !((List) entry.getValue()).isEmpty()) {
                     XmlStringBuilder localBuilder = new XmlStringBuilderWithoutHeader(ident);
                     XmlArray.writeXml((List) entry.getValue(), localBuilder,
@@ -2114,6 +2116,27 @@ public static void writeXml(Map map, String name, XmlStringBuilder builder, bool
                 builder.append("</").append(name).append(">");
             }
         }
+
+        private static void addComment(Map.Entry entry, int ident, int index, List<Map.Entry> entries,
+                List<XmlStringBuilder> elems) {
+            if (entry.getValue() instanceof List) {
+                for (Iterator iterator = ((List) entry.getValue()).iterator(); iterator.hasNext(); ) {
+                    XmlStringBuilder localBuilder = new XmlStringBuilderWithoutHeader(ident)
+                            .fillSpaces().append("<!--").append((String) iterator.next()).append("-->");
+                    if (iterator.hasNext() || index < entries.size() - 1) {
+                        localBuilder.newLine();
+                    }
+                    elems.add(localBuilder);
+                }
+            } else {
+                XmlStringBuilder localBuilder = new XmlStringBuilderWithoutHeader(ident)
+                        .fillSpaces().append("<!--").append((String) entry.getValue()).append("-->");
+                if (index < entries.size() - 1) {
+                    localBuilder.newLine();
+                }
+                elems.add(localBuilder);
+            }
+        }
     }
 
     public static class XmlValue {

src/test/java/com/github/underscore/lodash/StringTest.java

@@ -1598,6 +1598,34 @@ public void toXmlFromJson7() {
                 U.toXml((Map<String, Object>) U.fromJson(json)));
     }
 
+    @SuppressWarnings("unchecked")
+    @Test
+    public void toXmlFromJson8() {
+        final String json = "{\n  \"element\": {\n    \"#comment\": \" comment &&\"\n  }\n}";
+        assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+                + "<element>\n  <!-- comment &&-->\n</element>",
+                U.toXml((Map<String, Object>) U.fromJson(json)));
+        final String json2 = "{\n  \"element\": {\n    \"#comment\": \" comment \",\n    \"id\": \"1\"\n  }\n}";
+        assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+                + "<element>\n  <!-- comment -->\n  <id>1</id>\n</element>",
+                U.toXml((Map<String, Object>) U.fromJson(json2)));
+    }
+
+    @SuppressWarnings("unchecked")
+    @Test
+    public void toXmlFromJson9() {
+        final String json = "{\n  \"element\": {\n    \"#comment\": [\n      \" comment1 \",\n"
+                + "      \" comment2 \"\n    ]\n  }\n}";
+        assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+                + "<element>\n  <!-- comment1 -->\n  <!-- comment2 -->\n</element>",
+                U.toXml((Map<String, Object>) U.fromJson(json)));
+        final String json2 = "{\n  \"element\": {\n    \"#comment\": [\n      \" comment1 \",\n"
+                + "      \" comment2 \"\n    ]\n,    \"id\": \"1\"\n  }\n}";
+        assertEquals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+                + "<element>\n  <!-- comment1 -->\n  <!-- comment2 -->\n  <id>1</id>\n</element>",
+                U.toXml((Map<String, Object>) U.fromJson(json2)));
+    }
+
     @SuppressWarnings("unchecked")
     @Test
     public void toXml() {