This class implements a formatter providing operations for rending JSON text elements to an output stream (supplied at construction) according to a set of formatting options (also supplied at construction). This is a component‐private class and should not be used outside of this component.

Synopsis

Declared in <baljsn_encoder.h>

class Encoder_Formatter;

Description

DEPRECATED: Use baljsn::Formatter instead.

Member Functions

Name

Description

Encoder_Formatter [constructor]

Create a Encoder_Formatter object using the specified stream and options.

closeArray

Print onto the stream supplied at construction the sequence of characters designating the end of an array. Optionally specify formatAsEmptyArrayFlag denoting if the array being closed should be formatted as an empty array. If formatAsEmptyArrayFlag is not specified then the array being closed is formatted as an array having elements. Note that the formatting (and as a consequence the formatAsEmptyArrayFlag) is relevant only if this formatter encodes in the pretty style and is ignored otherwise.

closeDocument

Print onto the stream supplied at construction the sequence of characters designating the end of the document.

closeElement

Print onto the stream supplied at construction the sequence of characters designating the end of an element.

closeObject

Print onto the stream supplied at construction the sequence of characters designating the end of an object.

indent

Print onto the stream supplied at construction the sequence of whitespace characters for the proper indentation of an element given the encoding options supplied at construction.

isArrayElement

Return the value of the flag denoting if the current element refers to an array element.

openArray

Print onto the stream supplied at construction the sequence of characters designating the start of an array. Optionally specify formatAsEmptyArrayFlag denoting if the array being opened should be formatted as an empty array. If formatAsEmptyArrayFlag is not specified then the array being opened is formatted as an array having elements. Note that the formatting (and as a consequence the formatAsEmptyArrayFlag) is relevant only if this formatter encodes in the pretty style and is ignored otherwise.

openDocument

Print onto the stream supplied at construction the sequence of characters designating the start of the document.

openElement

Print onto the stream supplied at construction the sequence of characters designating the start of an element having the specified name. Return 0 on success and a non‐zero value otherwise.

openObject

Print onto the stream supplied at construction the sequence of characters designating the start of an object.

setIsArrayElement

Set the flag denoting if the current element refers to an array element to the specified isArrayElement.

Created with MrDocs