Package com.azure.json

Class JsonWriter

java.lang.Object

com.azure.json.JsonWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class JsonWriter
extends Object
implements Closeable

Writes a JSON value as a stream of tokens.

Instances of JsonWriter are created using an instance of JsonProvider or using the utility methods in JsonProviders.

See Also:

• com.azure.json
• JsonProvider
• JsonProviders

Constructor Summary

Constructors

Constructor	Description
JsonWriter()	Creates an instance of JsonWriter.

Method Summary

Modifier and Type	Method	Description
abstract void	close()	Closes the JSON stream.
abstract JsonWriter	flush()	Flushes any un-flushed content written to this writer.
abstract JsonWriteContext	getWriteContext()	Gets the current writing context for the JSON object.
final <T> JsonWriter	writeArray(Iterable<T> array, WriteValueCallback<JsonWriter,T> elementWriterFunc)	Writes a JSON array.
final <T> JsonWriter	writeArray(T[] array, WriteValueCallback<JsonWriter,T> elementWriterFunc)	Writes a JSON array.
final <T> JsonWriter	writeArrayField(String fieldName, Iterable<T> array, WriteValueCallback<JsonWriter,T> elementWriterFunc)	Writes a JSON array field.
final <T> JsonWriter	writeArrayField(String fieldName, T[] array, WriteValueCallback<JsonWriter,T> elementWriterFunc)	Writes a JSON array field.
abstract JsonWriter	writeBinary(byte[] value)	Writes a JSON binary value.
final JsonWriter	writeBinaryField(String fieldName, byte[] value)	Writes a JSON binary field.
abstract JsonWriter	writeBoolean(boolean value)	Writes a JSON boolean value (true or false).
final JsonWriter	writeBoolean(Boolean value)	Writes a nullable JSON boolean value (true, false, or null).
final JsonWriter	writeBooleanField(String fieldName, boolean value)	Writes a JSON boolean field.
final JsonWriter	writeBooleanField(String fieldName, Boolean value)	Writes a nullable JSON boolean field.
abstract JsonWriter	writeDouble(double value)	Writes a JSON double value.
final JsonWriter	writeDoubleField(String fieldName, double value)	Writes a JSON double field.
abstract JsonWriter	writeEndArray()	Writes a JSON end array (]).
abstract JsonWriter	writeEndObject()	Writes a JSON end object (&#125;).
abstract JsonWriter	writeFieldName(String fieldName)	Writes a JSON field name ("fieldName":).
abstract JsonWriter	writeFloat(float value)	Writes a JSON float value.
final JsonWriter	writeFloatField(String fieldName, float value)	Writes a JSON float field.
abstract JsonWriter	writeInt(int value)	Writes a JSON int value.
final JsonWriter	writeIntField(String fieldName, int value)	Writes a JSON int field.
final JsonWriter	writeJson(JsonSerializable<?> value)	Writes a JsonSerializable object.
final JsonWriter	writeJsonField(String fieldName, JsonSerializable<?> value)	Writes a JsonSerializable field.
abstract JsonWriter	writeLong(long value)	Writes a JSON long value.
final JsonWriter	writeLongField(String fieldName, long value)	Writes a JSON long field.
final <T> JsonWriter	writeMap(Map<String,T> map, WriteValueCallback<JsonWriter,T> valueWriterFunc)	Writes a JSON map.
final <T> JsonWriter	writeMapField(String fieldName, Map<String,T> map, WriteValueCallback<JsonWriter,T> valueWriterFunc)	Writes a JSON map field.
abstract JsonWriter	writeNull()	Writes a JSON null.
final <T> JsonWriter	writeNullableField(String fieldName, T nullable, WriteValueCallback<JsonWriter,T> writerFunc)	Writes a nullable JSON field.
final JsonWriter	writeNullField(String fieldName)	Writes a JSON null field ("fieldName":null).
final JsonWriter	writeNumber(Number value)	Writes a nullable JSON number value.
final JsonWriter	writeNumberField(String fieldName, Number value)	Writes a nullable JSON number field.
final JsonWriter	writeRawField(String fieldName, String value)	Writes the passed field literally without any additional handling.
abstract JsonWriter	writeRawValue(String value)	Writes the passed value literally without any additional handling.
abstract JsonWriter	writeStartArray()	Writes a JSON start array ([).
final JsonWriter	writeStartArray(String fieldName)	Writes a JSON start array ([) with a preceding field name.
abstract JsonWriter	writeStartObject()	Writes a JSON start object (&#123;).
final JsonWriter	writeStartObject(String fieldName)	Writes a JSON start object (&#123;) with a preceding field name.
abstract JsonWriter	writeString(String value)	Writes a JSON String value.
final JsonWriter	writeStringField(String fieldName, String value)	Writes a JSON String field.
JsonWriter	writeUntyped(Object value)	Writes the unknown type value.
JsonWriter	writeUntypedField(String fieldName, Object value)	Writes the unknown type value field.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonWriter

public JsonWriter()

Creates an instance of JsonWriter.

Method Details

getWriteContext

public abstract JsonWriteContext getWriteContext()

Gets the current writing context for the JSON object.

The writing context can help determine whether a write operation would be illegal.

The initial write context is JsonWriteContext.ROOT.

Returns:

The current writing context.

close

public abstract void close()
                    throws IOException

Closes the JSON stream.

If the writing context isn't JsonWriteContext.COMPLETED when this is called an IllegalStateException will be thrown.

During closing the implementation of JsonWriter must flush any un-flushed content.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IllegalStateException - If the JsonWriter is closed before the writing context is JsonWriteContext.COMPLETED.

IOException - If the underlying content store fails to close.

flush

public abstract JsonWriter flush()
                          throws IOException

Flushes any un-flushed content written to this writer.

It should be assumed that each write call won't flush any contents.

Returns:

The flushed JsonWriter object.

Throws:

IOException - If the underlying content fails to flush.

writeStartObject

public abstract JsonWriter writeStartObject()
                                     throws IOException

Writes a JSON start object ({).

Returns:

The updated JsonWriter object.

Throws:

IOException - If JSON start object fails to be written.

writeStartObject

public final JsonWriter writeStartObject(String fieldName)
                                  throws IOException

Writes a JSON start object ({) with a preceding field name.

This API is the equivalent of calling writeFieldName(String) and writeStartObject(), in that order.

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either fieldName or JSON start object fails to be written.

writeEndObject

public abstract JsonWriter writeEndObject()
                                   throws IOException

Writes a JSON end object (}).

If the current writing context isn't an object an IllegalStateException will be thrown.

Returns:

The updated JsonWriter object.

Throws:

IOException - If JSON end object fails to be written.

writeStartArray

public abstract JsonWriter writeStartArray()
                                    throws IOException

Writes a JSON start array ([).

Returns:

The updated JsonWriter object.

Throws:

IOException - If JSON start array fails to be written.

writeStartArray

public final JsonWriter writeStartArray(String fieldName)
                                 throws IOException

Writes a JSON start array ([) with a preceding field name.

This API is the equivalent of calling writeFieldName(String) and writeStartArray(), in that order.

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either fieldName or JSON start array fails to be written.

writeEndArray

public abstract JsonWriter writeEndArray()
                                  throws IOException

Writes a JSON end array (]).

Returns:

The updated JsonWriter object.

Throws:

IOException - If JSON end array fails to be written.

writeFieldName

public abstract JsonWriter writeFieldName(String fieldName)
                                   throws IOException

Writes a JSON field name ("fieldName":).

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If fieldName fails to be written.

writeJson

public final JsonWriter writeJson(JsonSerializable<?> value)
                           throws IOException

Writes a JsonSerializable object.

If value is null JsonToken.NULL will be written.

This API is used instead of writeJsonField(String, JsonSerializable) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Parameters:

value - JsonSerializable object to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the JsonSerializable fails to be written.

writeArray

public final <T> JsonWriter writeArray(T[] array,
 WriteValueCallback<JsonWriter,T> elementWriterFunc)
                                throws IOException

Writes a JSON array.

This API will begin by writing the start array ([) followed by all elements in the array using the elementWriterFunc and finishing by writing the end array (]).

If array is null JsonToken.NULL will be written.

This API is used instead of writeArrayField(String, Object[], WriteValueCallback) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Type Parameters:

T - The array element type.

Parameters:

array - The array being written.

elementWriterFunc - The function that writes each element of the array.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If elementWriterFunc is null.

IOException - If the JSON array fails to be written, either the start or end array or an element write.

writeArray

public final <T> JsonWriter writeArray(Iterable<T> array,
 WriteValueCallback<JsonWriter,T> elementWriterFunc)
                                throws IOException

Writes a JSON array.

This API will begin by writing the start array ([) followed by all elements in the array using the elementWriterFunc and finishing by writing the end array (]).

If array is null JsonToken.NULL will be written.

This API is used instead of writeArrayField(String, Iterable, WriteValueCallback) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Type Parameters:

T - The array element type.

Parameters:

array - The array being written.

elementWriterFunc - The function that writes each element of the array.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If elementWriterFunc is null.

IOException - If the JSON array fails to be written, either the start or end array or an element write.

writeMap

public final <T> JsonWriter writeMap(Map<String,T> map,
 WriteValueCallback<JsonWriter,T> valueWriterFunc)
                              throws IOException

Writes a JSON map.

This API will begin by writing the start object ({) followed by key-value fields in the map using the valueWriterFunc and finishing by writing the end object (}).

If map is null JsonToken.NULL will be written.

This API is used instead of writeMapField(String, Map, WriteValueCallback) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Type Parameters:

T - The value element type.

Parameters:

map - The map being written.

valueWriterFunc - The function that writes value of each key-value pair in the map.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If valueWriterFunc is null.

IOException - If the JSON map fails to be written, either the start or end object or a key or value write.

writeBinary

public abstract JsonWriter writeBinary(byte[] value)
                                throws IOException

Writes a JSON binary value.

If value is null JsonToken.NULL will be written.

This API is used instead of writeBinaryField(String, byte[]) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Parameters:

value - Binary value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the binary value fails to be written.

writeBoolean

public abstract JsonWriter writeBoolean(boolean value)
                                 throws IOException

Writes a JSON boolean value (true or false).

This API is used instead of writeBooleanField(String, boolean) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the nullable Boolean use writeBoolean(Boolean).

Parameters:

value - boolean value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the boolean value fails to be written.

writeBoolean

public final JsonWriter writeBoolean(Boolean value)
                              throws IOException

Writes a nullable JSON boolean value (true, false, or null).

If value is null JsonToken.NULL will be written.

This API is used instead of writeBooleanField(String, Boolean) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the primitive boolean use writeBoolean(boolean).

Parameters:

value - Boolean value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the Boolean value fails to be written.

writeDouble

public abstract JsonWriter writeDouble(double value)
                                throws IOException

Writes a JSON double value.

This API is used instead of writeDoubleField(String, double) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the nullable Double use writeNumber(Number).

Parameters:

value - double value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the double value fails to be written.

writeFloat

public abstract JsonWriter writeFloat(float value)
                               throws IOException

Writes a JSON float value.

This API is used instead of writeFloatField(String, float) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the nullable Float use writeNumber(Number).

Parameters:

value - float value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the float value fails to be written.

writeInt

public abstract JsonWriter writeInt(int value)
                             throws IOException

Writes a JSON int value.

This API is used instead of writeIntField(String, int) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the nullable Integer use writeNumber(Number).

Parameters:

value - int value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the int value fails to be written.

writeLong

public abstract JsonWriter writeLong(long value)
                              throws IOException

Writes a JSON long value.

This API is used instead of writeLongField(String, long) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

For the nullable Long use writeNumber(Number).

Parameters:

value - long value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the long value fails to be written.

writeNull

public abstract JsonWriter writeNull()
                              throws IOException

Writes a JSON null.

This API is used instead of writeNullField(String) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Returns:

The updated JsonWriter object.

Throws:

IOException - If a JSON null fails to be written.

writeNumber

public final JsonWriter writeNumber(Number value)
                             throws IOException

Writes a nullable JSON number value.

If value is null JsonToken.NULL will be written.

This API is used instead of writeNumberField(String, Number) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Parameters:

value - Number value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the Number value fails to be written.

writeString

public abstract JsonWriter writeString(String value)
                                throws IOException

Writes a JSON String value.

If value is null JsonToken.NULL will be written.

This API is used instead of writeStringField(String, String) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Parameters:

value - String value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the String value fails to be written.

writeRawValue

public abstract JsonWriter writeRawValue(String value)
                                  throws IOException

Writes the passed value literally without any additional handling.

Use this API when writing a String value that is already properly formatted JSON, such as a JSON string ("\"string\""), number ("42", "42.0"), boolean ("true", "false"), null ("null"), array ("[\"string\", \"array\"]"), or object ({"\"field\":\"value\""}).

This API is used instead of writeRawField(String, String) when the value needs to be written to the root of the JSON value, as an element in an array, or after a call to writeFieldName(String).

Parameters:

value - The raw JSON value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If value is null.

IOException - If the raw value fails to be written.

writeNullableField

public final <T> JsonWriter writeNullableField(String fieldName,
 T nullable,
 WriteValueCallback<JsonWriter,T> writerFunc)
                                        throws IOException

Writes a nullable JSON field.

When the value is null this effectively is the same as writeNullField(String). When the value isn't null this will write the JSON field name and call the writerFunc that is supplied with the non-null nullable value and this JsonWriter to perform the write operation.

Type Parameters:

T - Type of the nullable value.

Parameters:

fieldName - The field name.

nullable - The nullable JSON value.

writerFunc - The non-null JSON value writer function.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName or writerFunc is null.

IOException - If the fieldName or the nullable fails to be written.

writeJsonField

public final JsonWriter writeJsonField(String fieldName,
 JsonSerializable<?> value)
                                throws IOException

Writes a JsonSerializable field.

Combines writeFieldName(String) and writeJson(JsonSerializable) to simplify adding a key-value to a JSON object.

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Parameters:

fieldName - The field name.

value - JsonSerializable object to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If the fieldName or the JsonSerializable fails to be written.

writeArrayField

public final <T> JsonWriter writeArrayField(String fieldName,
 T[] array,
 WriteValueCallback<JsonWriter,T> elementWriterFunc)
                                     throws IOException

Writes a JSON array field.

This API will begin by writing the field name and start array ([) followed by all elements in the array using the elementWriterFunc and finishing by writing the end array (]).

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Combines writeFieldName(String) and writeArray(Object[], WriteValueCallback) to simplify adding a key-value to a JSON object.

Type Parameters:

T - The array element type.

Parameters:

fieldName - The field name.

array - The array being written.

elementWriterFunc - The function that writes each element of the array.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName or elementWriterFunc is null.

IOException - If the fieldName or the JSON array fails to be written, either JSON start or end array or the element write.

writeArrayField

public final <T> JsonWriter writeArrayField(String fieldName,
 Iterable<T> array,
 WriteValueCallback<JsonWriter,T> elementWriterFunc)
                                     throws IOException

Writes a JSON array field.

This API will begin by writing the field name and start array ([) followed by all elements in the array using the elementWriterFunc and finishing by writing the end array (]).

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Combines writeFieldName(String) and writeArray(Iterable, WriteValueCallback) to simplify adding a key-value to a JSON object.

Type Parameters:

T - The array element type.

Parameters:

fieldName - The field name.

array - The array being written.

elementWriterFunc - The function that writes each element of the array.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName or elementWriterFunc is null.

IOException - If the fieldName or the JSON array fails to be written, either JSON start or end array or the element write.

writeMapField

public final <T> JsonWriter writeMapField(String fieldName,
 Map<String,T> map,
 WriteValueCallback<JsonWriter,T> valueWriterFunc)
                                   throws IOException

Writes a JSON map field.

This API will begin by writing the field name and start object ({) followed by key-value fields in the map using the valueWriterFunc and finishing by writing the end object (}).

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Combines writeFieldName(String) and writeMap(Map, WriteValueCallback) to simplify adding a key-value to a JSON object.

Type Parameters:

T - The value element type.

Parameters:

fieldName - The field name.

map - The map being written.

valueWriterFunc - The function that writes each value of the map.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName or valueWriterFunc is null.

IOException - If the fieldName or the JSON map fails to be written, either JSON start or end object or the key or value write.

writeBinaryField

public final JsonWriter writeBinaryField(String fieldName,
 byte[] value)
                                  throws IOException

Writes a JSON binary field.

Combines writeFieldName(String) and writeBinary(byte[]) to simplify adding a key-value to a JSON object.

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Parameters:

fieldName - The field name.

value - Binary value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or binary value fails to be written.

writeBooleanField

public final JsonWriter writeBooleanField(String fieldName,
 boolean value)
                                   throws IOException

Writes a JSON boolean field.

Combines writeFieldName(String) and writeBoolean(boolean) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - boolean value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or boolean value fails to be written.

writeBooleanField

public final JsonWriter writeBooleanField(String fieldName,
 Boolean value)
                                   throws IOException

Writes a nullable JSON boolean field.

Combines writeFieldName(String) and writeBoolean(Boolean) to simplify adding a key-value to a JSON object.

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Parameters:

fieldName - The field name.

value - Boolean value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or Boolean value fails to be written.

writeDoubleField

public final JsonWriter writeDoubleField(String fieldName,
 double value)
                                  throws IOException

Writes a JSON double field.

Combines writeFieldName(String) and writeDouble(double) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - double value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or double value fails to be written.

writeFloatField

public final JsonWriter writeFloatField(String fieldName,
 float value)
                                 throws IOException

Writes a JSON float field.

Combines writeFieldName(String) and writeFloat(float) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - float value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or float value fails to be written.

writeIntField

public final JsonWriter writeIntField(String fieldName,
 int value)
                               throws IOException

Writes a JSON int field.

Combines writeFieldName(String) and writeInt(int) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - int value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or int value fails to be written.

writeLongField

public final JsonWriter writeLongField(String fieldName,
 long value)
                                throws IOException

Writes a JSON long field.

Combines writeFieldName(String) and writeLong(long) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - long value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or long value fails to be written.

writeNullField

public final JsonWriter writeNullField(String fieldName)
                                throws IOException

Writes a JSON null field ("fieldName":null).

Combines writeFieldName(String) and writeNull() to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or JSON null fails to be written.

writeNumberField

public final JsonWriter writeNumberField(String fieldName,
 Number value)
                                  throws IOException

Writes a nullable JSON number field.

Combines writeFieldName(String) and writeNumber(Number) to simplify adding a key-value to a JSON object.

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Parameters:

fieldName - The field name.

value - Number value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or Number value fails to be written.

writeStringField

public final JsonWriter writeStringField(String fieldName,
 String value)
                                  throws IOException

Writes a JSON String field.

Combines writeFieldName(String) and writeString(String) to simplify adding a key-value to a JSON object.

The field is only written when value isn't null, if a null field needs to be written use writeNullableField(String, Object, WriteValueCallback).

Parameters:

fieldName - The field name.

value - String value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either the fieldName or String value fails to be written.

writeRawField

public final JsonWriter writeRawField(String fieldName,
 String value)
                               throws IOException

Writes the passed field literally without any additional handling.

Use this API when writing a String value that is already properly formatted JSON, such as a JSON string ("\"string\""), number ("42", "42.0"), boolean ("true", "false"), null ("null"), array ("[\"string\", \"array\"]"), or object ({"\"field\":\"value\""}).

Combines writeFieldName(String) and writeRawValue(String) to simplify adding a key-value to a JSON object.

Parameters:

fieldName - The field name.

value - The raw JSON value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName or value is null.

IOException - If either the fieldName or raw value fails to be written.

writeUntypedField

public JsonWriter writeUntypedField(String fieldName,
 Object value)
                             throws IOException

Writes the unknown type value field.

The following is how each value is handled (in this order):

• null -> writeNull()
• short -> writeInt(int)
• int -> writeInt(int)
• long -> writeLong(long)
• float -> writeFloat(float)
• double -> writeDouble(double)
• boolean -> writeBoolean(boolean)
• CharSequence -> writeString(String)
• char -> writeString(String)
• JsonSerializable -> writeJson(JsonSerializable)
• Object[] -> writeUntyped(Object) for each element
• Iterable -> writeUntyped(Object) for each element
• Map -> writeUntyped(Object) for each element where the key to toString'd
• Object -> empty JSON object ({})
• All other values use the toString value with writeString(String)

Parameters:

fieldName - The field name.

value - The value to write.

Returns:

The updated JsonWriter object.

Throws:

NullPointerException - If fieldName is null.

IOException - If either fieldName or the untyped value fails to be written.

writeUntyped

public JsonWriter writeUntyped(Object value)
                        throws IOException

Writes the unknown type value.

The following is how each value is handled (in this order):

• null -> writeNull()
• short -> writeInt(int)
• int -> writeInt(int)
• long -> writeLong(long)
• float -> writeFloat(float)
• double -> writeDouble(double)
• boolean -> writeBoolean(boolean)
• CharSequence -> writeString(String)
• char -> writeString(String)
• JsonSerializable -> writeJson(JsonSerializable)
• Object[] -> writeUntyped(Object) for each element
• Iterable -> writeUntyped(Object) for each element
• Map -> writeUntyped(Object) for each element where the key to toString'd
• Object -> empty JSON object ({})
• All other values use the toString value with writeString(String)

Parameters:

value - The value to write.

Returns:

The updated JsonWriter object.

Throws:

IOException - If the untyped value fails to be written.