Package com.azure.json.gson

Class GsonJsonWriter

java.lang.Object

com.azure.json.JsonWriter

com.azure.json.gson.GsonJsonWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class GsonJsonWriter
extends JsonWriter

GSON-based implementation of JsonWriter.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the JSON stream.
JsonWriter	flush()	Flushes any un-flushed content written to this writer.
JsonWriteContext	getWriteContext()	Gets the current writing context for the JSON object.
static JsonWriter	toStream(OutputStream stream)	Creates a GsonJsonWriter that writes the given OutputStream.
JsonWriter	writeBinary(byte[] value)	Writes a JSON binary value.
JsonWriter	writeBinaryField(String fieldName, byte[] value)	Writes a JSON binary field.
JsonWriter	writeBoolean(boolean value)	Writes a JSON boolean value (true or false).
JsonWriter	writeBooleanField(String fieldName, boolean value)	Writes a JSON boolean field.
JsonWriter	writeDouble(double value)	Writes a JSON double value.
JsonWriter	writeDoubleField(String fieldName, double value)	Writes a JSON double field.
JsonWriter	writeEndArray()	Writes a JSON end array (]).
JsonWriter	writeEndObject()	Writes a JSON end object (}).
JsonWriter	writeFieldName(String fieldName)	Writes a JSON field name ("fieldName":).
JsonWriter	writeFloat(float value)	Writes a JSON float value.
JsonWriter	writeFloatField(String fieldName, float value)	Writes a JSON float field.
JsonWriter	writeInt(int value)	Writes a JSON int value.
JsonWriter	writeIntField(String fieldName, int value)	Writes a JSON int field.
JsonWriter	writeLong(long value)	Writes a JSON long value.
JsonWriter	writeLongField(String fieldName, long value)	Writes a JSON long field.
JsonWriter	writeNull()	Writes a JSON null.
JsonWriter	writeNullField(String fieldName)	Writes a JSON null field ("fieldName":null).
JsonWriter	writeRawField(String fieldName, String value)	Writes the passed field literally without any additional handling.
JsonWriter	writeRawValue(String value)	Writes the passed value literally without any additional handling.
JsonWriter	writeStartArray()	Writes a JSON start array ([).
JsonWriter	writeStartObject()	Writes a JSON start object ({).
JsonWriter	writeString(String value)	Writes a JSON String value.
JsonWriter	writeStringField(String fieldName, String value)	Writes a JSON String field.

Methods inherited from class com.azure.json.JsonWriter

writeArray, writeArray, writeArray, writeArray, writeArrayField, writeArrayField, writeArrayField, writeArrayField, writeBinary, writeBinaryField, writeBoolean, writeBoolean, writeBooleanField, writeBooleanField, writeDouble, writeDouble, writeDoubleField, writeDoubleField, writeFloat, writeFloat, writeFloatField, writeFloatField, writeInteger, writeInteger, writeIntegerField, writeIntegerField, writeJson, writeJson, writeJsonField, writeJsonField, writeLong, writeLong, writeLongField, writeLongField, writeMap, writeMap, writeMapField, writeMapField, writeStartArray, writeStartObject, writeString, writeStringField, writeUntyped, writeUntypedField

Methods inherited from class java.lang.Object

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

Method Details

toStream

public static JsonWriter toStream(OutputStream stream)

Creates a GsonJsonWriter that writes the given OutputStream.

The passed OutputStream won't be closed when close() is called as the GsonJsonWriter isn't the owner of the stream.

Parameters:

stream - The OutputStream that will be written.

Returns:

An instance of GsonJsonWriter.

getWriteContext

public JsonWriteContext getWriteContext()

Description copied from class: JsonWriter

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.

Specified by:

getWriteContext in class JsonWriter

Returns:

The current writing context.

close

public void close()
           throws IOException

Description copied from class: JsonWriter

Closes the JSON stream.

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class JsonWriter

Throws:

IOException

flush

public JsonWriter flush()

Description copied from class: JsonWriter

Flushes any un-flushed content written to this writer.

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

Specified by:

flush in class JsonWriter

Returns:

The flushed JsonWriter object.

writeStartObject

public JsonWriter writeStartObject()

Description copied from class: JsonWriter

Writes a JSON start object ({).

Specified by:

writeStartObject in class JsonWriter

Returns:

The updated JsonWriter object.

writeEndObject

public JsonWriter writeEndObject()

Description copied from class: JsonWriter

Writes a JSON end object (}).

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

Specified by:

writeEndObject in class JsonWriter

Returns:

The updated JsonWriter object.

writeStartArray

public JsonWriter writeStartArray()

Description copied from class: JsonWriter

Writes a JSON start array ([).

Specified by:

writeStartArray in class JsonWriter

Returns:

The updated JsonWriter object.

writeEndArray

public JsonWriter writeEndArray()

Description copied from class: JsonWriter

Writes a JSON end array (]).

Specified by:

writeEndArray in class JsonWriter

Returns:

The updated JsonWriter object.

writeFieldName

public JsonWriter writeFieldName(String fieldName)

Description copied from class: JsonWriter

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

Specified by:

writeFieldName in class JsonWriter

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

writeBinary

public JsonWriter writeBinary(byte[] value)

Description copied from class: JsonWriter

Writes a JSON binary value.

A value is always written no matter whether value is null, if null shouldn't be written this API call must be null guarded. Or, use JsonWriter.writeBinary(byte[], boolean) to indicate whether null should be written.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

Specified by:

writeBinary in class JsonWriter

Parameters:

value - Binary value to write.

Returns:

The updated JsonWriter object.

writeBoolean

public JsonWriter writeBoolean(boolean value)

Description copied from class: JsonWriter

Writes a JSON boolean value (true or false).

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

For the nullable Boolean use JsonWriter.writeBoolean(Boolean).

Specified by:

writeBoolean in class JsonWriter

Parameters:

value - boolean value to write.

Returns:

The updated JsonWriter object.

writeDouble

public JsonWriter writeDouble(double value)

Description copied from class: JsonWriter

Writes a JSON double value.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

For the nullable Double use JsonWriter.writeDouble(Double).

Specified by:

writeDouble in class JsonWriter

Parameters:

value - double value to write.

Returns:

The updated JsonWriter object.

writeFloat

public JsonWriter writeFloat(float value)

Description copied from class: JsonWriter

Writes a JSON float value.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

For the nullable Float use JsonWriter.writeFloat(Float).

Specified by:

writeFloat in class JsonWriter

Parameters:

value - float value to write.

Returns:

The updated JsonWriter object.

writeInt

public JsonWriter writeInt(int value)

Description copied from class: JsonWriter

Writes a JSON int value.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

For the nullable Integer use JsonWriter.writeInteger(Integer).

Specified by:

writeInt in class JsonWriter

Parameters:

value - int value to write.

Returns:

The updated JsonWriter object.

writeLong

public JsonWriter writeLong(long value)

Description copied from class: JsonWriter

Writes a JSON long value.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

For the nullable Long use JsonWriter.writeLong(Long).

Specified by:

writeLong in class JsonWriter

Parameters:

value - long value to write.

Returns:

The updated JsonWriter object.

writeNull

public JsonWriter writeNull()

Description copied from class: JsonWriter

Writes a JSON null.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

Specified by:

writeNull in class JsonWriter

Returns:

The updated JsonWriter object.

writeString

public JsonWriter writeString(String value)

Description copied from class: JsonWriter

Writes a JSON String value.

A value is always written no matter whether value is null, if null shouldn't be written this API call must be null guarded. Or, use JsonWriter.writeString(String, boolean) to indicate whether null should be written.

This API is used instead of JsonWriter.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 JsonWriter.writeFieldName(String).

Specified by:

writeString in class JsonWriter

Parameters:

value - String value to write.

Returns:

The updated JsonWriter object.

writeRawValue

public JsonWriter writeRawValue(String value)

Description copied from class: JsonWriter

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 JsonWriter.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 JsonWriter.writeFieldName(String).

Specified by:

writeRawValue in class JsonWriter

Parameters:

value - The raw JSON value to write.

Returns:

The updated JsonWriter object.

writeBinaryField

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

Description copied from class: JsonWriter

Writes a JSON binary field.

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

A value is always written no matter whether value is null, if null shouldn't be written this API call must be null guarded. Or, use JsonWriter.writeBinaryField(String, byte[], boolean) to indicate whether null should be written.

Specified by:

writeBinaryField in class JsonWriter

Parameters:

fieldName - The field name.

value - Binary value to write.

Returns:

The updated JsonWriter object.

writeBooleanField

public JsonWriter writeBooleanField(String fieldName,
 boolean value)

Description copied from class: JsonWriter

Writes a JSON boolean field.

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

Specified by:

writeBooleanField in class JsonWriter

Parameters:

fieldName - The field name.

value - boolean value to write.

Returns:

The updated JsonWriter object.

writeDoubleField

public JsonWriter writeDoubleField(String fieldName,
 double value)

Description copied from class: JsonWriter

Writes a JSON double field.

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

Specified by:

writeDoubleField in class JsonWriter

Parameters:

fieldName - The field name.

value - double value to write.

Returns:

The updated JsonWriter object.

writeFloatField

public JsonWriter writeFloatField(String fieldName,
 float value)

Description copied from class: JsonWriter

Writes a JSON float field.

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

Specified by:

writeFloatField in class JsonWriter

Parameters:

fieldName - The field name.

value - float value to write.

Returns:

The updated JsonWriter object.

writeIntField

public JsonWriter writeIntField(String fieldName,
 int value)

Description copied from class: JsonWriter

Writes a JSON int field.

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

Specified by:

writeIntField in class JsonWriter

Parameters:

fieldName - The field name.

value - int value to write.

Returns:

The updated JsonWriter object.

writeLongField

public JsonWriter writeLongField(String fieldName,
 long value)

Description copied from class: JsonWriter

Writes a JSON long field.

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

Specified by:

writeLongField in class JsonWriter

Parameters:

fieldName - The field name.

value - long value to write.

Returns:

The updated JsonWriter object.

writeNullField

public JsonWriter writeNullField(String fieldName)

Description copied from class: JsonWriter

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

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

Specified by:

writeNullField in class JsonWriter

Parameters:

fieldName - The field name.

Returns:

The updated JsonWriter object.

writeStringField

public JsonWriter writeStringField(String fieldName,
 String value)

Description copied from class: JsonWriter

Writes a JSON String field.

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

A value is always written no matter whether value is null, if null shouldn't be written this API call must be null guarded. Or, use JsonWriter.writeStringField(String, String, boolean) to indicate whether null should be written.

Specified by:

writeStringField in class JsonWriter

Parameters:

fieldName - The field name.

value - String value to write.

Returns:

The updated JsonWriter object.

writeRawField

public JsonWriter writeRawField(String fieldName,
 String value)

Description copied from class: JsonWriter

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 JsonWriter.writeFieldName(String) and JsonWriter.writeRawValue(String) to simplify adding a key-value to a JSON object.

Specified by:

writeRawField in class JsonWriter

Parameters:

fieldName - The field name.

value - The raw JSON value to write.

Returns:

The updated JsonWriter object.