org.bson.json

Interface StrictJsonWriter

All Known Implementing Classes:

StrictCharacterStreamJsonWriter

public interface StrictJsonWriter

An interface for creating JSON texts that largely conform to RFC 7159.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
boolean	isTruncated() Return true if the output has been truncated due to exceeding any maximum length specified in settings.
void	writeBoolean(boolean value) Writes a boolean to the writer.
void	writeBoolean(java.lang.String name, boolean value) Writes a a member with a boolean value to the writer.
void	writeEndArray() Writes the end of a JSON array to the writer.
void	writeEndObject() Writes the end of a JSON object to the writer.
void	writeName(java.lang.String name) Writes the name of a member to the writer.
void	writeNull() Writes a null value to the writer.
void	writeNull(java.lang.String name) Writes a member with a null value to the writer.
void	writeNumber(java.lang.String value) Writes a number to the writer.
void	writeNumber(java.lang.String name, java.lang.String value) Writes a member with a numeric value to the writer.
void	writeRaw(java.lang.String value) Writes a raw value without quoting or escaping.
void	writeRaw(java.lang.String name, java.lang.String value) Writes a member with a raw value without quoting or escaping.
void	writeStartArray() Writes the start of a array to the writer.
void	writeStartArray(java.lang.String name) Writes the start of JSON array member to the writer.
void	writeStartObject() Writes the start of a JSON object to the writer.
void	writeStartObject(java.lang.String name) Writes the start of a JSON object member to the writer.
void	writeString(java.lang.String value) Writes a String to the writer.
void	writeString(java.lang.String name, java.lang.String value) Writes a member with a string value to the writer.

Method Detail

writeName

void writeName(java.lang.String name)

Writes the name of a member to the writer.

Parameters:

name - the member name

Throws:

BsonInvalidOperationException - if not in the correct state to write a member name

BSONException - if the underlying Writer throws an IOException

writeBoolean

void writeBoolean(boolean value)

Writes a boolean to the writer.

Parameters:

value - the boolean value.

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeBoolean

void writeBoolean(java.lang.String name,
                  boolean value)

Writes a a member with a boolean value to the writer.

Parameters:

name - the member name

value - the boolean value

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeNumber

void writeNumber(java.lang.String value)

Writes a number to the writer.

Parameters:

value - the Double value, as a String so that clients can take full control over formatting

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeNumber

void writeNumber(java.lang.String name,
                 java.lang.String value)

Writes a member with a numeric value to the writer.

Parameters:

name - the member name

value - the Double value, as a String so that clients can take full control over formatting

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeString

void writeString(java.lang.String value)

Writes a String to the writer.

Parameters:

value - the String value

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeString

void writeString(java.lang.String name,
                 java.lang.String value)

Writes a member with a string value to the writer.

Parameters:

name - the member name

value - the String value

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeRaw

void writeRaw(java.lang.String value)

Writes a raw value without quoting or escaping.

Parameters:

value - the String value

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeRaw

void writeRaw(java.lang.String name,
              java.lang.String value)

Writes a member with a raw value without quoting or escaping.

Parameters:

name - the member name

value - the raw value

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeNull

void writeNull()

Writes a null value to the writer.

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeNull

void writeNull(java.lang.String name)

Writes a member with a null value to the writer.

Parameters:

name - the member name

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeStartArray

void writeStartArray()

Writes the start of a array to the writer.

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeStartArray

void writeStartArray(java.lang.String name)

Writes the start of JSON array member to the writer.

Parameters:

name - the member name

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeStartObject

void writeStartObject()

Writes the start of a JSON object to the writer.

Throws:

BsonInvalidOperationException - if not in the correct state to write a value

BSONException - if the underlying Writer throws an IOException

writeStartObject

void writeStartObject(java.lang.String name)

Writes the start of a JSON object member to the writer.

Parameters:

name - the member name

Throws:

BsonInvalidOperationException - if not in the correct state to write a member

BSONException - if the underlying Writer throws an IOException

writeEndArray

void writeEndArray()

Writes the end of a JSON array to the writer.

Throws:

BsonInvalidOperationException - if not in the correct state to write the end of an array

BSONException - if the underlying Writer throws an IOException

writeEndObject

void writeEndObject()

Writes the end of a JSON object to the writer.

Throws:

BsonInvalidOperationException - if not in the correct state to write the end of an object

BSONException - if the underlying Writer throws an IOException

isTruncated

boolean isTruncated()

Return true if the output has been truncated due to exceeding any maximum length specified in settings.

Returns:

true if the output has been truncated

Since:

3.7