Package org.bson.json

Interface StrictJsonWriter

All Known Implementing Classes:
StrictCharacterStreamJsonWriter
@Deprecated(since="2022-10-31") public interface StrictJsonWriter
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.
An interface for creating JSON texts that largely conform to RFC 7159.
Since:
3.5

  • Method Summary

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

  • Method Details

    • writeName

      void writeName(String name)
      Deprecated.
      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)
      Deprecated.
      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(String name, boolean value)
      Deprecated.
      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(String value)
      Deprecated.
      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(String name, String value)
      Deprecated.
      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(String value)
      Deprecated.
      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(String name, String value)
      Deprecated.
      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(String value)
      Deprecated.
      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(String name, String value)
      Deprecated.
      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()
      Deprecated.
      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(String name)
      Deprecated.
      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()
      Deprecated.
      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(String name)
      Deprecated.
      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()
      Deprecated.
      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(String name)
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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