Backups/JSON-java
1
0
Fork 0
mirror of https://github.com/stleary/JSON-java.git synced 2025-08-03 03:15:32 -04:00
Code Issues Projects Releases Wiki Activity

Allow to configure Java null handling.

Browse Source
This commit is contained in:
Robert Lichtenberger 2025-03-19 07:59:57 +01:00
parent 6452a6f38d
commit d1327c2da3
3 changed files with 72 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/org/json/JSONObject.java
View File

@ -332,7 +332,7 @@ public class JSONObject {
throw new NullPointerException("Null key.");
}
final Object value = e.getValue();
if (value != null) {
if (value != null || jsonParserConfiguration.isJavaNullAsJsonNull()) {
testValidity(value);
this.map.put(String.valueOf(e.getKey()), wrap(value, recursionDepth + 1, jsonParserConfiguration));
}

31
src/main/java/org/json/JSONParserConfiguration.java
View File

@ -9,6 +9,11 @@ public class JSONParserConfiguration extends ParserConfiguration {
*/
private boolean overwriteDuplicateKey;
/**
* Used to indicate whether ignore null values when converting java maps to JSONObject or not.
*/
private boolean javaNullAsJsonNull;
/**
* Configuration with the default values.
*/
@ -68,6 +73,21 @@ public class JSONParserConfiguration extends ParserConfiguration {
return clone;
}
/**
* Controls the parser's behavior when meeting duplicate keys.
* If set to false, the parser will throw a JSONException when meeting a duplicate key.
* Or the duplicate key's value will be overwritten.
*
* @param javaNullAsJsonNull define, if the parser should ignore null values in Java maps
* @return The existing configuration will not be modified. A new configuration is returned.
*/
public JSONParserConfiguration withJavaNullAsJsonNull(final boolean javaNullAsJsonNull) {
JSONParserConfiguration clone = this.clone();
clone.javaNullAsJsonNull = javaNullAsJsonNull;
return clone;
}
/**
* Sets the strict mode configuration for the JSON parser with default true value
* <p>
@ -107,6 +127,17 @@ public class JSONParserConfiguration extends ParserConfiguration {
return this.overwriteDuplicateKey;
}
/**
* The parser's behavior when meeting a null value in a java map, controls whether the parser should ignore
* that map entry or write a JSON entry with a null value.
*
* @return The <code>javaNullAsJsonNull</code> configuration value.
*/
public boolean isJavaNullAsJsonNull() {
return this.javaNullAsJsonNull;
}
/**
* The parser throws an Exception when strict mode is true and tries to parse invalid JSON characters.
* Otherwise, the parser is more relaxed and might tolerate some invalid characters.

40
src/test/java/org/json/junit/JSONObjectTest.java
View File

@ -617,6 +617,46 @@ public class JSONObjectTest {
Util.checkJSONObjectMaps(jsonObject);
}
@Test
public void jsonObjectByMapWithNullValueAndParserConfiguration() {
Map<String, Object> map = new HashMap<String, Object>();
map.put("nullKey", null);
// by default, null values are ignored
JSONObject obj1 = new JSONObject(map);
assertTrue("expected null value to be ignored by default", obj1.isEmpty());
// if configured, null values are written as such into the JSONObject.
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withJavaNullAsJsonNull(true);
JSONObject obj2 = new JSONObject(map, parserConfiguration);
assertFalse("expected null value to accepted when configured", obj2.isEmpty());
assertTrue(obj2.has("nullKey"));
assertEquals(JSONObject.NULL, obj2.get("nullKey"));
}
@Test
public void jsonObjectByMapWithNestedNullValueAndParserConfiguration() {
Map<String, Object> map = new HashMap<String, Object>();
Map<String, Object> nestedMap = new HashMap<String, Object>();
nestedMap.put("nullKey", null);
map.put("nestedMap", nestedMap);
List<Map<String, Object>> nestedList = new ArrayList<Map<String,Object>>();
nestedList.add(nestedMap);
map.put("nestedList", nestedList);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withJavaNullAsJsonNull(true);
JSONObject jsonObject = new JSONObject(map, parserConfiguration);
JSONObject nestedObject = jsonObject.getJSONObject("nestedMap");
assertTrue(nestedObject.has("nullKey"));
assertEquals(JSONObject.NULL, nestedObject.get("nullKey"));
JSONArray nestedArray = jsonObject.getJSONArray("nestedList");
assertEquals(1, nestedArray.length());
assertTrue(nestedArray.getJSONObject(0).has("nullKey"));
assertEquals(JSONObject.NULL, nestedArray.getJSONObject(0).get("nullKey"));
}
/**
* JSONObject built from a bean. In this case all but one of the
* bean getters return valid JSON types