Skip to content

Commit

Permalink
Added configuration support for type conversion using Map
Browse files Browse the repository at this point in the history
  • Loading branch information
Rahul Kumar committed Aug 3, 2020
1 parent 250f74e commit 61c1a88
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 35 deletions.
25 changes: 10 additions & 15 deletions src/main/java/org/json/XML.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ private static boolean parse(XMLTokener x, JSONObject context, String name, XMLP
String string;
String tagName;
Object token;
String typeCastClass;
XMLXsiTypeConverter<?> xmlXsiTypeConverter;

// Test for and skip past these forms:
// <!-- ... -->
Expand Down Expand Up @@ -341,7 +341,7 @@ private static boolean parse(XMLTokener x, JSONObject context, String name, XMLP
token = null;
jsonObject = new JSONObject();
boolean nilAttributeFound = false;
typeCastClass = null;
xmlXsiTypeConverter = null;
for (;;) {
if (token == null) {
token = x.nextToken();
Expand All @@ -360,9 +360,9 @@ private static boolean parse(XMLTokener x, JSONObject context, String name, XMLP
&& NULL_ATTR.equals(string)
&& Boolean.parseBoolean((String) token)) {
nilAttributeFound = true;
} else if(config.useValueTypeCast
} else if(config.xsiTypeMap != null
&& TYPE_ATTR.equals(string)) {
typeCastClass = (String) token;
xmlXsiTypeConverter = config.xsiTypeMap.get(token);
} else if (!nilAttributeFound) {
jsonObject.accumulate(string,
config.isKeepStrings()
Expand Down Expand Up @@ -401,9 +401,9 @@ private static boolean parse(XMLTokener x, JSONObject context, String name, XMLP
} else if (token instanceof String) {
string = (String) token;
if (string.length() > 0) {
if(typeCastClass != null) {
if(xmlXsiTypeConverter != null) {
jsonObject.accumulate(config.getcDataTagName(),
stringToValue(string, typeCastClass));
stringToValue(string, xmlXsiTypeConverter));
} else {
jsonObject.accumulate(config.getcDataTagName(),
config.isKeepStrings() ? string : stringToValue(string));
Expand Down Expand Up @@ -435,17 +435,12 @@ private static boolean parse(XMLTokener x, JSONObject context, String name, XMLP
/**
* This method tries to convert the given string value to the target object
* @param string String to convert
* @param className target class name
* @param typeConverter value converter to convert string to integer, boolean e.t.c
* @return JSON value of this string or the string
*/
public static Object stringToValue(String string, String className) {
try {
if(className.equals(String.class.getName())) return string;
Class<?> clazz = Class.forName(className);
Method method = clazz.getMethod("valueOf", String.class);
return method.invoke(null, string);
} catch (Exception e){
e.printStackTrace();
public static Object stringToValue(String string, XMLXsiTypeConverter<?> typeConverter) {
if(typeConverter != null) {
return typeConverter.convert(string);
}
return stringToValue(string);
}
Expand Down
20 changes: 11 additions & 9 deletions src/main/java/org/json/XMLParserConfiguration.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ of this software and associated documentation files (the "Software"), to deal
SOFTWARE.
*/

import java.util.Map;


/**
* Configuration object for the XML parser. The configuration is immutable.
* @author AylwardJ
Expand Down Expand Up @@ -57,10 +60,9 @@ public class XMLParserConfiguration {
private boolean convertNilAttributeToNull;

/**
* When parsing the XML into JSON, specifies if values with attribute xsi:type="java.lang.Integer"
* should be kept as attribute(false), or they should be converted to the given type
* This will allow type conversion for values in XML if xsi:type attribute is defined
*/
public boolean useValueTypeCast;
public Map<String, XMLXsiTypeConverter<?>> xsiTypeMap;

/**
* Default parser configuration. Does not keep strings (tries to implicitly convert
Expand Down Expand Up @@ -129,7 +131,7 @@ public XMLParserConfiguration (final boolean keepStrings, final String cDataTagN
*/
@Deprecated
public XMLParserConfiguration (final boolean keepStrings, final String cDataTagName, final boolean convertNilAttributeToNull) {
this(keepStrings, cDataTagName, convertNilAttributeToNull, false);
this(keepStrings, cDataTagName, convertNilAttributeToNull, null);
}

/**
Expand All @@ -140,16 +142,16 @@ public XMLParserConfiguration (final boolean keepStrings, final String cDataTagN
* to use that value as the JSONObject key name to process as CDATA.
* @param convertNilAttributeToNull <code>true</code> to parse values with attribute xsi:nil="true" as null.
* <code>false</code> to parse values with attribute xsi:nil="true" as {"xsi:nil":true}.
* @param useValueTypeCast <code>true</code> to parse values with attribute xsi:type="java.lang.Integer" as
* integer, xsi:type="java.lang.String" as string
* <code>false</code> to parse values with attribute xsi:type="java.lang.Integer" as {"xsi:type":"java.lang.Integer"}.
* @param xsiTypeMap <code>new HashMap<String, XMLXsiTypeConverter<?>>()</code> to parse values with attribute
* xsi:type="integer" as integer, xsi:type="string" as string
* <code>null</code> to use default behaviour.
*/
public XMLParserConfiguration (final boolean keepStrings, final String cDataTagName,
final boolean convertNilAttributeToNull, final boolean useValueTypeCast ) {
final boolean convertNilAttributeToNull, final Map<String, XMLXsiTypeConverter<?>> xsiTypeMap ) {
this.keepStrings = keepStrings;
this.cDataTagName = cDataTagName;
this.convertNilAttributeToNull = convertNilAttributeToNull;
this.useValueTypeCast = useValueTypeCast;
this.xsiTypeMap = xsiTypeMap;
}

/**
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/json/XMLXsiTypeConverter.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package org.json;

public interface XMLXsiTypeConverter<T> {
T convert(String value);
}
35 changes: 24 additions & 11 deletions src/test/java/org/json/junit/XMLTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,16 @@ of this software and associated documentation files (the "Software"), to deal
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringReader;
import java.util.HashMap;
import java.util.Map;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.json.XML;
import org.json.XMLParserConfiguration;
import org.json.XMLXsiTypeConverter;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
Expand Down Expand Up @@ -978,11 +981,10 @@ public void testIssue537CaseSensitiveHexUnEscapeDirect(){
*/
@Test
public void testToJsonWithTypeWhenTypeConversionDisabled() {
final String originalXml = "<root><id xsi:type=\"java.lang.String\">1234</id></root>";
final String expectedJsonString = "{\"root\":{\"id\":{\"xsi:type\":\"java.lang.String\",\"content\":1234}}}";
final JSONObject expectedJson = new JSONObject(expectedJsonString);
final JSONObject actualJson = XML.toJSONObject(originalXml, new XMLParserConfiguration());

String originalXml = "<root><id xsi:type=\"string\">1234</id></root>";
String expectedJsonString = "{\"root\":{\"id\":{\"xsi:type\":\"string\",\"content\":1234}}}";
JSONObject expectedJson = new JSONObject(expectedJsonString);
JSONObject actualJson = XML.toJSONObject(originalXml, new XMLParserConfiguration());
Util.compareActualVsExpectedJsonObjects(actualJson,expectedJson);
}

Expand All @@ -991,12 +993,23 @@ public void testToJsonWithTypeWhenTypeConversionDisabled() {
*/
@Test
public void testToJsonWithTypeWhenTypeConversionEnabled() {
final String originalXml = "<root><id1 xsi:type=\"java.lang.String\">1234</id1>"
+ "<id2 xsi:type=\"java.lang.Integer\">1234</id2></root>";
final String expectedJsonString = "{\"root\":{\"id2\":1234,\"id1\":\"1234\"}}";
final JSONObject expectedJson = new JSONObject(expectedJsonString);
final JSONObject actualJson = XML.toJSONObject(originalXml, new XMLParserConfiguration(false,
"content", false, true));
String originalXml = "<root><id1 xsi:type=\"string\">1234</id1>"
+ "<id2 xsi:type=\"integer\">1234</id2></root>";
String expectedJsonString = "{\"root\":{\"id2\":1234,\"id1\":\"1234\"}}";
JSONObject expectedJson = new JSONObject(expectedJsonString);
Map<String, XMLXsiTypeConverter<?>> xsiTypeMap = new HashMap<String, XMLXsiTypeConverter<?>>();
xsiTypeMap.put("string", new XMLXsiTypeConverter<String>() {
@Override public String convert(final String value) {
return value;
}
});
xsiTypeMap.put("integer", new XMLXsiTypeConverter<Integer>() {
@Override public Integer convert(final String value) {
return Integer.valueOf(value);
}
});
JSONObject actualJson = XML.toJSONObject(originalXml, new XMLParserConfiguration(false,
"content", false, xsiTypeMap));
Util.compareActualVsExpectedJsonObjects(actualJson,expectedJson);
}

Expand Down

0 comments on commit 61c1a88

Please sign in to comment.