Package org.bson.json
Class StrictCharacterStreamJsonWriter
-
- org.bson.json.StrictCharacterStreamJsonWriter
-
- All Implemented Interfaces:
StrictJsonWriter
public final class StrictCharacterStreamJsonWriter extends implements StrictJsonWriter
A class that writes JSON texts as a character stream via a provided .- Since:
- 3.5
-
-
Constructor Summary
Constructors Constructor Description writer, StrictCharacterStreamJsonWriterSettings settings)
Construct an instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCurrentLength()
Gets the current length of the JSON text.boolean
isTruncated()
Return true if the output has been truncated due to exceeding the length specified inStrictCharacterStreamJsonWriterSettings.getMaxLength()
.void
writeBoolean(boolean value)
Writes a boolean to the writer.void
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
name)
Writes the name of a member to the writer.void
writeNull()
Writes a null value to the writer.void
name)
Writes a member with a null value to the writer.void
value)
Writes a number to the writer.void
name, value)
Writes a member with a numeric value to the writer.void
value)
Writes a raw value without quoting or escaping.void
name, value)
Writes a member with a raw value without quoting or escaping.void
writeStartArray()
Writes the start of a array to the writer.void
name)
Writes the start of JSON array member to the writer.void
writeStartObject()
Writes the start of a JSON object to the writer.void
name)
Writes the start of a JSON object member to the writer.void
value)
Writes a String to the writer.void
name, value)
Writes a member with a string value to the writer.
-
-
-
Constructor Detail
-
StrictCharacterStreamJsonWriter
public StrictCharacterStreamJsonWriter( writer, StrictCharacterStreamJsonWriterSettings settings)
Construct an instance.- Parameters:
writer
- the writer to write JSON to.settings
- the settings to apply to this writer.
-
-
Method Detail
-
getCurrentLength
public int getCurrentLength()
Gets the current length of the JSON text.- Returns:
- the current length of the JSON text
-
writeStartObject
public void writeStartObject( name)
Description copied from interface:StrictJsonWriter
Writes the start of a JSON object member to the writer.- Specified by:
writeStartObject
in interfaceStrictJsonWriter
- Parameters:
name
- the member name
-
writeStartArray
public void writeStartArray( name)
Description copied from interface:StrictJsonWriter
Writes the start of JSON array member to the writer.- Specified by:
writeStartArray
in interfaceStrictJsonWriter
- Parameters:
name
- the member name
-
writeBoolean
public void writeBoolean( name, boolean value)
Description copied from interface:StrictJsonWriter
Writes a a member with a boolean value to the writer.- Specified by:
writeBoolean
in interfaceStrictJsonWriter
- Parameters:
name
- the member namevalue
- the boolean value
-
writeNumber
public void writeNumber( name, value)
Description copied from interface:StrictJsonWriter
Writes a member with a numeric value to the writer.- Specified by:
writeNumber
in interfaceStrictJsonWriter
- Parameters:
name
- the member namevalue
- the Double value, as a String so that clients can take full control over formatting
-
writeString
public void writeString( name, value)
Description copied from interface:StrictJsonWriter
Writes a member with a string value to the writer.- Specified by:
writeString
in interfaceStrictJsonWriter
- Parameters:
name
- the member namevalue
- the String value
-
writeRaw
public void writeRaw( name, value)
Description copied from interface:StrictJsonWriter
Writes a member with a raw value without quoting or escaping.- Specified by:
writeRaw
in interfaceStrictJsonWriter
- Parameters:
name
- the member namevalue
- the raw value
-
writeNull
public void writeNull( name)
Description copied from interface:StrictJsonWriter
Writes a member with a null value to the writer.- Specified by:
writeNull
in interfaceStrictJsonWriter
- Parameters:
name
- the member name
-
writeName
public void writeName( name)
Description copied from interface:StrictJsonWriter
Writes the name of a member to the writer.- Specified by:
writeName
in interfaceStrictJsonWriter
- Parameters:
name
- the member name
-
writeBoolean
public void writeBoolean(boolean value)
Description copied from interface:StrictJsonWriter
Writes a boolean to the writer.- Specified by:
writeBoolean
in interfaceStrictJsonWriter
- Parameters:
value
- the boolean value.
-
writeNumber
public void writeNumber( value)
Description copied from interface:StrictJsonWriter
Writes a number to the writer.- Specified by:
writeNumber
in interfaceStrictJsonWriter
- Parameters:
value
- the Double value, as a String so that clients can take full control over formatting
-
writeString
public void writeString( value)
Description copied from interface:StrictJsonWriter
Writes a String to the writer.- Specified by:
writeString
in interfaceStrictJsonWriter
- Parameters:
value
- the String value
-
writeRaw
public void writeRaw( value)
Description copied from interface:StrictJsonWriter
Writes a raw value without quoting or escaping.- Specified by:
writeRaw
in interfaceStrictJsonWriter
- Parameters:
value
- the String value
-
writeNull
public void writeNull()
Description copied from interface:StrictJsonWriter
Writes a null value to the writer.- Specified by:
writeNull
in interfaceStrictJsonWriter
-
writeStartObject
public void writeStartObject()
Description copied from interface:StrictJsonWriter
Writes the start of a JSON object to the writer.- Specified by:
writeStartObject
in interfaceStrictJsonWriter
-
writeStartArray
public void writeStartArray()
Description copied from interface:StrictJsonWriter
Writes the start of a array to the writer.- Specified by:
writeStartArray
in interfaceStrictJsonWriter
-
writeEndObject
public void writeEndObject()
Description copied from interface:StrictJsonWriter
Writes the end of a JSON object to the writer.- Specified by:
writeEndObject
in interfaceStrictJsonWriter
-
writeEndArray
public void writeEndArray()
Description copied from interface:StrictJsonWriter
Writes the end of a JSON array to the writer.- Specified by:
writeEndArray
in interfaceStrictJsonWriter
-
isTruncated
public boolean isTruncated()
Return true if the output has been truncated due to exceeding the length specified inStrictCharacterStreamJsonWriterSettings.getMaxLength()
.- Specified by:
isTruncated
in interfaceStrictJsonWriter
- Returns:
- true if the output has been truncated
- Since:
- 3.7
- See Also:
StrictCharacterStreamJsonWriterSettings.getMaxLength()
-
-