X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Forg%2Fjson%2FJSONStringer.java;h=cfed9e70c888e1c76dee380ba4e65b60bc1cc20e;hb=453fa24ab502aaca4ffccf3590f97c897b9580b3;hp=bb9e7a4cfae8620da989293ddf17b58ef2cde602;hpb=6e56c166e45d1af37c5531b4cbe909a3e110927e;p=jalview.git diff --git a/src/org/json/JSONStringer.java b/src/org/json/JSONStringer.java index bb9e7a4..cfed9e7 100644 --- a/src/org/json/JSONStringer.java +++ b/src/org/json/JSONStringer.java @@ -27,53 +27,61 @@ SOFTWARE. import java.io.StringWriter; /** - * JSONStringer provides a quick and convenient way of producing JSON text. - * The texts produced strictly conform to JSON syntax rules. No whitespace is - * added, so the results are ready for transmission or storage. Each instance of + * JSONStringer provides a quick and convenient way of producing JSON text. The + * texts produced strictly conform to JSON syntax rules. No whitespace is added, + * so the results are ready for transmission or storage. Each instance of * JSONStringer can produce one JSON text. *
* A JSONStringer instance provides a value
method for appending
- * values to the
- * text, and a key
- * method for adding keys before values in objects. There are array
- * and endArray
methods that make and bound array values, and
- * object
and endObject
methods which make and bound
- * object values. All of these methods return the JSONWriter instance,
- * permitting cascade style. For example,
- * myString = new JSONStringer() - * .object() - * .key("JSON") - * .value("Hello, World!") - * .endObject() - * .toString();which produces the string
- * {"JSON":"Hello, World!"}+ * values to the text, and a
key
method for adding keys before
+ * values in objects. There are array
and endArray
+ * methods that make and bound array values, and object
and
+ * endObject
methods which make and bound object values. All of
+ * these methods return the JSONWriter instance, permitting cascade style. For
+ * example,
+ *
+ * + * myString = new JSONStringer().object().key("JSON").value("Hello, World!") + * .endObject().toString(); + *+ * + * which produces the string + * + *
+ * {"JSON":"Hello, World!"} + **
* The first method called must be array
or object
.
* There are no methods for adding commas or colons. JSONStringer adds them for
* you. Objects and arrays can be nested up to 20 levels deep.
*
* This can sometimes be easier than using a JSONObject to build a string.
+ *
* @author JSON.org
* @version 2015-12-09
*/
-public class JSONStringer extends JSONWriter {
- /**
- * Make a fresh JSONStringer. It can be used to build one JSON text.
- */
- public JSONStringer() {
- super(new StringWriter());
- }
+public class JSONStringer extends JSONWriter
+{
+ /**
+ * Make a fresh JSONStringer. It can be used to build one JSON text.
+ */
+ public JSONStringer()
+ {
+ super(new StringWriter());
+ }
- /**
- * Return the JSON text. This method is used to obtain the product of the
- * JSONStringer instance. It will return null
if there was a
- * problem in the construction of the JSON text (such as the calls to
- * array
were not properly balanced with calls to
- * endArray
).
- * @return The JSON text.
- */
- @Override
- public String toString() {
- return this.mode == 'd' ? this.writer.toString() : null;
- }
+ /**
+ * Return the JSON text. This method is used to obtain the product of the
+ * JSONStringer instance. It will return null
if there was a
+ * problem in the construction of the JSON text (such as the calls to
+ * array
were not properly balanced with calls to
+ * endArray
).
+ *
+ * @return The JSON text.
+ */
+ @Override
+ public String toString()
+ {
+ return this.mode == 'd' ? this.writer.toString() : null;
+ }
}