JsonValueWriter

Begins encoding a new array. Each call to this method must be paired with a call to .

Cancels immediately-nested calls to beginArray or beginObject and their matching calls to endArray or endObject . Use this to compose JSON adapters without nesting.

For example, the following creates JSON with nested arrays: {@code [1,[2,3,4],5]} .

{@code * JsonAdapter

With flattening we can create JSON with a single array {@code [1,2,3,4,5]} :

{@code * JsonAdapter

This method flattens arrays within arrays:

{@code * Emit: [1, [2, 3, 4], 5] * To produce: [1, 2, 3, 4, 5] * }

{@code * Emit: {"a": 1, {"b": 2}, "c": 3} * To Produce: {"a": 1, "b": 2, "c": 3} * }

{@code * Emit: [1, {"b": 2}, 3, [4, 5], 6] * To Produce: [1, {"b": 2}, 3, 4, 5, 6] * }

This method returns an opaque token. Callers must match all calls to this method with a call to endFlatten with the matching token.

Begins encoding a new object. Each call to this method must be paired with a call to .

Before pushing a value on the stack this confirms that the stack has capacity.

Ends encoding the current array.

Ends nested call flattening created by beginFlatten .

Ends encoding the current object.

Returns a string containing only whitespace, used for each level of indentation. If empty, the encoded document will be compact.

Returns a JsonPath to the current location in the JSON value.

Returns true if object members are serialized when their value is null. This has no impact on array elements. The default is false.

Returns true if this writer has relaxed syntax rules.

Encodes the value which may be a string, number, boolean, null, map, or list.

Encodes the property name.

Encodes {@code null} .

Returns a new instance that writes UTF-8 encoded JSON to {@code sink} .

Returns the scope on the top of the stack.

Changes the writer to treat the next value as a string name. This is useful for map adapters so that arbitrary type adapters can use to write a name value.

In this example, calling this method allows two sequential calls to value to produce the object, {@code {"a": "b"}} .

{@code * JsonWriter writer = JsonWriter.of(...); * writer.beginObject(); * writer.promoteValueToName(); * writer.value("a"); * writer.value("b"); * writer.endObject(); * }

Replace the value on the top of the stack with the given value.

Sets the indentation string to be repeated for each level of indentation in the encoded document. If {@code indent.isEmpty()} the encoded document will be compact. Otherwise the encoded document will be more human-readable.

Configure this writer to relax its syntax rules. By default, this writer only emits well-formed JSON as specified by RFC 7159. Setting the writer to lenient permits the following:

• Top-level values of any type. With strict writing, the top-level value must be an object or an array.
• Numbers may be NaNs or infinities .

Sets whether object members are serialized when their value is null. This has no impact on array elements. The default is false.

Assigns the tag value using the given class key and value.

Returns the tag value for the given class key.

Encodes {@code value} .

Writes {@code source} directly without encoding its contents. Equivalent to {@code try * (BufferedSink sink = writer.valueSink()) { source.readAll(sink): }}

Returns a BufferedSink into which arbitrary data can be written without any additional encoding. You must call before interacting with this {@code * JsonWriter} instance again.

Since no validation is performed, options like setSerializeNulls and other writer configurations are not respected.