Class JsonWriter

Writes a JSON (RFC 7159) encoded value to a stream, one token at a time. The stream includes both literal values (strings, numbers, booleans and nulls) as well as the begin and end delimiters of objects and arrays.

See com.google.gson.stream.JsonWriter for full documentation

Hierarchy

JsonWriter

Index

Constructors

Methods

beginArray beginObject close endArray endObject flush getSerializeNulls isHtmlSafe isLenient jsonValue name nullValue setHtmlSafe setIndent setLenient setSerializeNulls value

Constructors

constructor

new JsonWriter(): JsonWriter
Returns JsonWriter

Methods

beginArray

beginArray(): JsonWriter
Begins encoding a new array.

Returns JsonWriter
- Defined in Java.d.ts:161

beginObject

beginObject(): JsonWriter
Begins encoding a new object.

Returns JsonWriter
- Defined in Java.d.ts:165

close

close(): void
Flushes and closes this writer and the underlying Writer.

Returns void
- Defined in Java.d.ts:169

endArray

endArray(): JsonWriter
Ends encoding the current array.

Returns JsonWriter
- Defined in Java.d.ts:173

endObject

endObject(): JsonWriter
Ends encoding the current object.

Returns JsonWriter
- Defined in Java.d.ts:177

flush

flush(): void
Ensures all buffered data is written to the underlying Writer and flushes that writer.

Returns void
- Defined in Java.d.ts:181

getSerializeNulls

getSerializeNulls(): boolean
Returns true if object members are serialized when their value is null.

Returns boolean
- Defined in Java.d.ts:185

isHtmlSafe

isHtmlSafe(): boolean
Returns true if this writer writes JSON that's safe for inclusion in HTML and XML documents.

Returns boolean
- Defined in Java.d.ts:189

isLenient

isLenient(): boolean
Returns true if this writer has relaxed syntax rules.

Returns boolean
- Defined in Java.d.ts:193

jsonValue

jsonValue(value): JsonWriter
Writes value directly to the writer without quoting or escaping.
Parameters
- value: string
Returns JsonWriter
- Defined in Java.d.ts:197

name

name(name): JsonWriter
Encodes the property name.
Parameters
- name: string
Returns JsonWriter
- Defined in Java.d.ts:201

nullValue

nullValue(): JsonWriter
Encodes null.

Returns JsonWriter
- Defined in Java.d.ts:205

setHtmlSafe

setHtmlSafe(htmlSafe): void
Configure this writer to emit JSON that's safe for direct inclusion in HTML and XML documents.
Parameters
- htmlSafe: boolean
Returns void
- Defined in Java.d.ts:209

setIndent

setIndent(indent): void
Sets the indentation string to be repeated for each level of indentation in the encoded document.
Parameters
- indent: string
Returns void
- Defined in Java.d.ts:213

setLenient

setLenient(lenient): void
Configure this writer to relax its syntax rules.
Parameters
- lenient: boolean
Returns void
- Defined in Java.d.ts:217

setSerializeNulls

setSerializeNulls(serializeNulls): void
Sets whether object members are serialized when their value is null.
Parameters
- serializeNulls: boolean
Returns void
- Defined in Java.d.ts:221

value

value(value): JsonWriter
Encodes value.
Parameters
- value: string | number | boolean
Returns JsonWriter
- Defined in Java.d.ts:225

Generated using TypeDoc