Options for writing a JSON document.

Synopsis

Declared in <bdljsn_writeoptions.h>

class WriteOptions;

Description

This simply constrained (value‐semantic) attribute class specifies options for writing a JSON document. See the for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

Member Functions

Name

Description

WriteOptions [constructor]

Constructors

~WriteOptions [destructor]

Destroy this object.

operator=

Assign to this object the value of the specified rhs object.

escapeForwardSlash

Return the escapeForwardSlash attribute of this object.

initialIndentLevel

Return the initialIndentLevel attribute of this object.

print

Format this object to the specified output stream.

reset

Reset this object to the default value (i.e., its value upon default construction).

setEscapeForwardSlash

Set the escapeForwardSlash attribute of this object to the specified value.

setInitialIndentLevel

Set the initialIndentLevel attribute of this object to the specified value.

setSortMembers

Set the sortMembers attribute of this object to the specified value.

setSpacesPerLevel

Set the spacesPerLevel attribute of this object to the specified value.

setStyle

Set the style attribute of this object to the specified value.

sortMembers

Return the sortMembers attribute of this object.

spacesPerLevel

Return the spacesPerLevel attribute of this object.

style

Return the style attribute of this object.

Static Data Members

Name

Description

s_DEFAULT_INITIALIZER_ESCAPE_FORWARD_SLASH

Default value for the escapeForwardSlash attribute.

s_DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL

Default value for the initialIndentLevel attribute.

s_DEFAULT_INITIALIZER_SORT_MEMBERS

Default value for the sortMembers attribute.

s_DEFAULT_INITIALIZER_SPACES_PER_LEVEL

Default value for the spacesPerLevel attribute.

s_DEFAULT_INITIALIZER_STYLE

Default value for the style attribute.

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs attribute objects do not have the same value, and false otherwise.

operator==

Return true if the specified lhs and rhs attribute objects have the same value, and false otherwise.

Created with MrDocs