rombert commented on code in PR #2:
URL:
https://github.com/apache/sling-org-apache-sling-commons-json/pull/2#discussion_r1530053255
##########
src/main/java/org/apache/sling/commons/json/io/JSONWriter.java:
##########
@@ -243,134 +208,240 @@ public JSONWriter endObject() throws JSONException {
/**
* Append a key. The key will be associated with the next value. In an
* object, every value must be preceded by a key.
- * @param s A key string.
+ *
+ * @param string A key string.
* @return this
* @throws JSONException If the key is out of place. For example, keys
- * do not belong in arrays or if the key is null.
+ * do not belong in arrays or if the key is null.
*/
- public JSONWriter key(String s) throws JSONException {
- if (s == null) {
+ public JSONWriter key(String string) throws JSONException {
+ if (string == null) {
throw new JSONException("Null key.");
}
if (this.mode == 'k') {
try {
- if (this.comma) {
- this.writer.write(',');
+ JSONObject topObject = this.stack[this.top - 1];
+ // don't use the built in putOnce method to maintain Android
support
+ if (topObject.has(string)) {
+ throw new JSONException("Duplicate key \"" + string +
"\"");
}
- if (tidy) {
- this.writer.write('\n');
- this.writer.write(INDENTS[top]);
- }
- this.writer.write(JSONObject.quote(s));
- this.writer.write(':');
- if (tidy) {
- this.writer.write(' ');
+ topObject.put(string, true);
+ if (this.comma) {
+ this.writer.append(',');
}
+ this.writer.append(JSONObject.quote(string));
+ this.writer.append(':');
this.comma = false;
this.mode = 'o';
return this;
} catch (IOException e) {
+ // Android as of API 25 does not support this exception
constructor
+ // however we won't worry about it. If an exception is
happening here
+ // it will just throw a "Method not found" exception instead.
throw new JSONException(e);
}
}
throw new JSONException("Misplaced key.");
}
-
/**
* Begin appending a new object. All keys and values until the balancing
* <code>endObject</code> will be appended to this object. The
* <code>endObject</code> method must be called to mark the object's end.
+ *
* @return this
* @throws JSONException If the nesting is too deep, or if the object is
- * started in the wrong place (for example as a key or after the end of the
- * outermost array or object).
+ * started in the wrong place (for example as a key
or
+ * after the end of the
+ * outermost array or object).
*/
public JSONWriter object() throws JSONException {
if (this.mode == 'i') {
this.mode = 'o';
}
if (this.mode == 'o' || this.mode == 'a') {
this.append("{");
- this.push('k');
+ this.push(new JSONObject());
this.comma = false;
return this;
}
throw new JSONException("Misplaced object.");
}
-
/**
* Pop an array or object scope.
+ *
* @param c The scope to close.
* @throws JSONException If nesting is wrong.
*/
private void pop(char c) throws JSONException {
- if (this.top <= 0 || this.stack[this.top - 1] != c) {
+ if (this.top <= 0) {
+ throw new JSONException("Nesting error.");
+ }
+ char m = this.stack[this.top - 1] == null ? 'a' : 'k';
+ if (m != c) {
throw new JSONException("Nesting error.");
}
this.top -= 1;
- this.mode = this.top == 0 ? 'd' : this.stack[this.top - 1];
+ this.mode = this.top == 0
+ ? 'd'
+ : this.stack[this.top - 1] == null
+ ? 'a'
+ : 'k';
}
/**
* Push an array or object scope.
- * @param c The scope to open.
+ *
+ * @param jo The scope to open.
* @throws JSONException If nesting is too deep.
*/
- private void push(char c) throws JSONException {
+ private void push(JSONObject jo) throws JSONException {
if (this.top >= maxdepth) {
- throw new JSONException("Nesting too deep (maximum is " + maxdepth
+ " levels)");
+ throw new JSONException("Nesting too deep.");
}
- this.stack[this.top] = c;
- this.mode = c;
+ this.stack[this.top] = jo;
+ this.mode = jo == null ? 'a' : 'k';
this.top += 1;
}
+ /**
+ * Make a JSON text of an Object value. If the object has an
+ * value.toJSONString() method, then that method will be used to produce
the
+ * JSON text. The method is required to produce a strictly conforming text.
+ * If the object does not contain a toJSONString method (which is the most
+ * common case), then a text will be produced by other means. If the value
+ * is an array or Collection, then a JSONArray will be made from it and its
+ * toJSONString method will be called. If the value is a MAP, then a
+ * JSONObject will be made from it and its toJSONString method will be
+ * called. Otherwise, the value's toString method will be called, and the
+ * result will be quoted.
+ *
+ * <p>
+ * Warning: This method assumes that the data structure is acyclical.
+ *
+ * @param value
+ * The value to be serialized.
+ * @return a printable, displayable, transmittable representation of the
+ * object, beginning with <code>{</code> <small>(left
+ * brace)</small> and ending with <code>}</code> <small>(right
+ * brace)</small>.
+ * @throws JSONException
+ * If the value is or contains an invalid number.
+ */
+ public static String valueToString(Object value) throws JSONException {
+ if (value == null || value.equals(null)) {
+ return "null";
+ }
+ if (value instanceof JSONString) {
+ String object;
+ try {
+ object = ((JSONString) value).toJSONString();
+ } catch (Exception e) {
+ throw new JSONException(e);
+ }
+ if (object != null) {
+ return object;
+ }
+ throw new JSONException("Bad value from toJSONString: " + object);
+ }
+ if (value instanceof Number) {
+ // not all Numbers may match actual JSON Numbers. i.e. Fractions
or Complex
+ final String numberAsString = JSONObject.numberToString((Number)
value);
+ if (JSONObject.NUMBER_PATTERN.matcher(numberAsString).matches()) {
+ // Close enough to a JSON number that we will return it
unquoted
+ return numberAsString;
+ }
+ // The Number value is not a valid JSON number.
+ // Instead we will quote it as a string
+ return JSONObject.quote(numberAsString);
+ }
+ if (value instanceof Boolean || value instanceof JSONObject
+ || value instanceof JSONArray) {
+ return value.toString();
+ }
+ if (value instanceof Map) {
+ Map<?, ?> map = (Map<?, ?>) value;
+ return new JSONObject(map).toString();
+ }
+ if (value instanceof Collection) {
+ Collection<?> coll = (Collection<?>) value;
+ return new JSONArray(coll).toString();
+ }
+ if (value.getClass().isArray()) {
+ return new JSONArray(value).toString();
+ }
+ if (value instanceof Enum<?>) {
+ return JSONObject.quote(((Enum<?>) value).name());
+ }
+ return JSONObject.quote(value.toString());
+ }
/**
* Append either the value <code>true</code> or the value
* <code>false</code>.
+ *
* @param b A boolean.
* @return this
- * @throws JSONException
+ * @throws JSONException if a called function has an error
*/
public JSONWriter value(boolean b) throws JSONException {
return this.append(b ? "true" : "false");
}
/**
* Append a double value.
+ *
* @param d A double.
* @return this
* @throws JSONException If the number is not finite.
*/
public JSONWriter value(double d) throws JSONException {
- return this.value(new Double(d));
+ return this.value(Double.valueOf(d));
}
/**
* Append a long value.
+ *
* @param l A long.
* @return this
- * @throws JSONException
+ * @throws JSONException if a called function has an error
*/
public JSONWriter value(long l) throws JSONException {
return this.append(Long.toString(l));
}
-
/**
* Append an object value.
- * @param o The object to append. It can be null, or a Boolean, Number,
- * String, JSONObject, or JSONArray, or an object with a toJSONString()
- * method.
+ *
+ * @param object The object to append. It can be null, or a Boolean,
Number,
+ * String, JSONObject, or JSONArray, or an object that
implements
+ * JSONString.
* @return this
* @throws JSONException If the value is out of sequence.
*/
- public JSONWriter value(Object o) throws JSONException {
- return this.append(JSONObject.valueToString(o));
+ public JSONWriter value(Object object) throws JSONException {
+ return this.append(valueToString(object));
+ }
+
+ /**
+ * @deprecated do not use, was removed from library and later stubbed
+ */
+ @Deprecated
+ public void setTidy(boolean tidy) {
+ // stubbed as this was removed from the library but still is
referenced from
+ // customer code
+ }
+
+ /**
+ * @deprecated do not use, was removed from library and later stubbed
+ */
+ @Deprecated
+ public boolean isTidy() {
+ // stubbed as this was removed from the library but still is
referenced from
+ // customer code
+ return true;
Review Comment:
I am not sure this is a really big concern, but it you want to be sure you
could actually keep storing the `tidy` field but ignore it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
