org.yuanheng.cookjson

Interface CookJsonGenerator

All Superinterfaces:

AutoCloseable, Closeable, Flushable, JsonGenerator

All Known Implementing Classes:

BsonGenerator, PrettyTextJsonGenerator, TextJsonGenerator

public interface CookJsonGenerator
extends JsonGenerator

Add two binary related functions not present in JsonGenerator.

Author:

Heng Yuan

Field Summary

Fields inherited from interface javax.json.stream.JsonGenerator

PRETTY_PRINTING

Method Summary

Modifier and Type	Method and Description
JsonGenerator	write(byte[] value) Writes the specified data as a binary value within the current array context.
JsonGenerator	write(String name, byte[] value) Writes the specified data as a binary value within the current object context.

Methods inherited from interface javax.json.stream.JsonGenerator

close, flush, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeEnd, writeNull, writeNull, writeStartArray, writeStartArray, writeStartObject, writeStartObject

Method Detail

write

JsonGenerator write(String name,
                    byte[] value)

Writes the specified data as a binary value within the current object context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.

Parameters:

name - the key name.

value - a binary data to be written

Returns:

this.

Throws:

JsonGenerationException - if this method is not called within an array context

JsonException - in case of other errors (such as I/O).

See Also:

CookJsonBinary

write

JsonGenerator write(byte[] value)

Writes the specified data as a binary value within the current array context. Depends on the implementation, it can be written as binary, or as Base64 / Hexadecimal strings.

Parameters:

value - a binary data to be written

Returns:

this.

Throws:

JsonGenerationException - if this method is not called within an array context

JsonException - in case of other errors (such as I/O).

See Also:

CookJsonBinary