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

Use better name for parser configuration option, fix API comment.

Browse Source
This commit is contained in:
Robert Lichtenberger 2025-03-21 07:25:37 +01:00
parent 5d1c789490
commit 1afd7cd6bc
4 changed files with 18 additions and 17 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 || jsonParserConfiguration.isJavaNullAsJsonNull()) {
if (value != null || jsonParserConfiguration.isUseNativeNulls()) {
testValidity(value);
this.map.put(String.valueOf(e.getKey()), wrap(value, recursionDepth + 1, jsonParserConfiguration));
}

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

@ -10,9 +10,9 @@ public class JSONParserConfiguration extends ParserConfiguration {
private boolean overwriteDuplicateKey;
/**
* Used to indicate whether ignore null values when converting java maps to JSONObject or not.
* Used to indicate whether to convert java null values to JSONObject.NULL or ignoring the entry when converting java maps.
*/
private boolean javaNullAsJsonNull;
private boolean useNativeNulls;
/**
* Configuration with the default values.
@ -74,16 +74,16 @@ public class JSONParserConfiguration extends ParserConfiguration {
}
/**
* 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.
* Controls the parser's behavior when meeting Java null values while converting maps.
* If set to true, the parser will put a JSONObject.NULL into the resulting JSONObject.
* Or the map entry will be ignored.
*
* @param javaNullAsJsonNull define, if the parser should ignore null values in Java maps
* @param useNativeNulls defines if the parser should convert null values in Java maps
* @return The existing configuration will not be modified. A new configuration is returned.
*/
public JSONParserConfiguration withJavaNullAsJsonNull(final boolean javaNullAsJsonNull) {
public JSONParserConfiguration withUseNativeNulls(final boolean useNativeNulls) {
JSONParserConfiguration clone = this.clone();
clone.javaNullAsJsonNull = javaNullAsJsonNull;
clone.useNativeNulls = useNativeNulls;
return clone;
}
@ -128,13 +128,14 @@ public class JSONParserConfiguration extends ParserConfiguration {
}
/**
* 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.
* The parser's behavior when meeting a null value in a java map, controls whether the parser should
* write a JSON entry with a null value (<code>isUseNativeNulls() == true</code>)
* or ignore that map entry (<code>isUseNativeNulls() == false</code>).
*
* @return The <code>javaNullAsJsonNull</code> configuration value.
* @return The <code>useNativeNulls</code> configuration value.
*/
public boolean isJavaNullAsJsonNull() {
return this.javaNullAsJsonNull;
public boolean isUseNativeNulls() {
return this.useNativeNulls;
}

2
src/test/java/org/json/junit/JSONArrayTest.java
View File

@ -235,7 +235,7 @@ public class JSONArrayTest {
Map<String, Object> sub = new HashMap<String, Object>();
sub.put("nullKey", null);
list.add(sub);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withJavaNullAsJsonNull(true);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withUseNativeNulls(true);
JSONArray jsonArray = new JSONArray(list, parserConfiguration);
JSONObject subObject = jsonArray.getJSONObject(0);
assertTrue(subObject.has("nullKey"));

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

@ -627,7 +627,7 @@ public class JSONObjectTest {
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);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withUseNativeNulls(true);
JSONObject obj2 = new JSONObject(map, parserConfiguration);
assertFalse("expected null value to accepted when configured", obj2.isEmpty());
assertTrue(obj2.has("nullKey"));
@ -644,7 +644,7 @@ public class JSONObjectTest {
nestedList.add(nestedMap);
map.put("nestedList", nestedList);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withJavaNullAsJsonNull(true);
JSONParserConfiguration parserConfiguration = new JSONParserConfiguration().withUseNativeNulls(true);
JSONObject jsonObject = new JSONObject(map, parserConfiguration);
JSONObject nestedObject = jsonObject.getJSONObject("nestedMap");