Module com.grack.nanojson

Package com.grack.nanojson

Class JsonWriter

java.lang.Object

com.grack.nanojson.JsonWriter

public final class JsonWriter
extends Object

Factory for JSON writers that target Strings and Appendables. Creates writers that write JSON to a String, an OutputStream, or an Appendable such as a StringBuilder, a Writer a PrintStream or a CharBuffer.

 String json = JsonWriter
     .indent("  ")
     .string()
     .object()
         .array("a")
             .value(1)
             .value(2)
         .end()
         .value("b", false)
         .value("c", true)
     .end()
 .done();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonWriter.JsonWriterContext	Allows for additional configuration of the JsonWriter.

Method Summary

Modifier and Type	Method	Description
static String	escape(String value)	Escape a string value.
static JsonWriter.JsonWriterContext	indent(String indent)	Creates a JsonWriter source that will write indented output with the given indent.
static JsonAppendableWriter	on(OutputStream out)	Creates a JsonAppendableWriter that can output to an OutputStream subclass.
static JsonAppendableWriter	on(PrintStream appendable)	Creates a JsonAppendableWriter that can output to an PrintStream subclass.
static JsonAppendableWriter	on(Appendable appendable)	Creates a JsonAppendableWriter that can output to an Appendable subclass, such as a StringBuilder, a Writer a PrintStream or a CharBuffer.
static JsonStringWriter	string()	Creates a new JsonStringWriter.
static String	string(Object value)	Emits a single value (a JSON primitive such as a Number, Boolean, String, a Map or JsonObject, or a Collection or JsonArray.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

indent

public static JsonWriter.JsonWriterContext indent(String indent)

Creates a JsonWriter source that will write indented output with the given indent.

 String json = JsonWriter.indent("  ").string()
     .object()
         .array("a")
             .value(1)
             .value(2)
         .end()
         .value("b", false)
         .value("c", true)
     .end()
 .done();
 

string

public static JsonStringWriter string()

Creates a new JsonStringWriter.

 String json = JsonWriter.string()
     .object()
         .array("a")
             .value(1)
             .value(2)
         .end()
         .value("b", false)
         .value("c", true)
     .end()
 .done();
 

string

public static String string(Object value)

Emits a single value (a JSON primitive such as a Number, Boolean, String, a Map or JsonObject, or a Collection or JsonArray. Emit a String, JSON-escaped:

 JsonWriter.string("abc\n\"") // "\"abc\\n\\"\""
 

 JsonObject obj = new JsonObject();
 obj.put("abc", 1);
 JsonWriter.string(obj) // "{\"abc\":1}"
 

on

public static JsonAppendableWriter on(Appendable appendable)

Creates a JsonAppendableWriter that can output to an Appendable subclass, such as a StringBuilder, a Writer a PrintStream or a CharBuffer.

on

public static JsonAppendableWriter on(PrintStream appendable)

Creates a JsonAppendableWriter that can output to an PrintStream subclass.

 JsonWriter.on(System.out)
                .object()
                        .value("a", 1)
                        .value("b", 2)
                .end()
        .done();
 

on

public static JsonAppendableWriter on(OutputStream out)

Creates a JsonAppendableWriter that can output to an OutputStream subclass. Uses the UTF-8 Charset. To specify a different charset, use the on(Appendable) method with an OutputStreamWriter.

 JsonWriter.on(System.out)
                .object()
                        .value("a", 1)
                        .value("b", 2)
                .end()
        .done();
 

escape

public static String escape(String value)

Escape a string value.

Parameters:

value -

Returns:

the escaped JSON value