[#BloombergLP-bdljsn-WriteOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::WriteOptions
:relfileprefix: ../../
:mrdocs:

Options for writing a JSON document.

== Synopsis

Declared in `<bdljsn_writeoptions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/WriteOptions/2constructor-05.adoc[`WriteOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdljsn/WriteOptions/2destructor.adoc[`~WriteOptions`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdljsn/WriteOptions/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object.
| xref:BloombergLP/bdljsn/WriteOptions/escapeForwardSlash.adoc[`escapeForwardSlash`] 
| Return the `escapeForwardSlash` attribute of this object.
| xref:BloombergLP/bdljsn/WriteOptions/initialIndentLevel.adoc[`initialIndentLevel`] 
| Return the `initialIndentLevel` attribute of this object.
| xref:BloombergLP/bdljsn/WriteOptions/print.adoc[`print`] 
| Format this object to the specified output `stream`.
| xref:BloombergLP/bdljsn/WriteOptions/reset.adoc[`reset`] 
| Reset this object to the default value (i.e., its value upon default construction).
| xref:BloombergLP/bdljsn/WriteOptions/setEscapeForwardSlash.adoc[`setEscapeForwardSlash`] 
| Set the `escapeForwardSlash` attribute of this object to the specified `value`.
| xref:BloombergLP/bdljsn/WriteOptions/setInitialIndentLevel.adoc[`setInitialIndentLevel`] 
| Set the `initialIndentLevel` attribute of this object to the specified `value`.
| xref:BloombergLP/bdljsn/WriteOptions/setSortMembers.adoc[`setSortMembers`] 
| Set the `sortMembers` attribute of this object to the specified `value`.
| xref:BloombergLP/bdljsn/WriteOptions/setSpacesPerLevel.adoc[`setSpacesPerLevel`] 
| Set the `spacesPerLevel` attribute of this object to the specified `value`.
| xref:BloombergLP/bdljsn/WriteOptions/setStyle.adoc[`setStyle`] 
| Set the `style` attribute of this object to the specified `value`.
| xref:BloombergLP/bdljsn/WriteOptions/sortMembers.adoc[`sortMembers`] 
| Return the `sortMembers` attribute of this object.
| xref:BloombergLP/bdljsn/WriteOptions/spacesPerLevel.adoc[`spacesPerLevel`] 
| Return the `spacesPerLevel` attribute of this object.
| xref:BloombergLP/bdljsn/WriteOptions/style.adoc[`style`] 
| Return the `style` attribute of this object.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/WriteOptions/s_DEFAULT_INITIALIZER_ESCAPE_FORWARD_SLASH.adoc[`s_DEFAULT_INITIALIZER_ESCAPE_FORWARD_SLASH`] 
| Default value for the `escapeForwardSlash` attribute.
| xref:BloombergLP/bdljsn/WriteOptions/s_DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL.adoc[`s_DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL`] 
| Default value for the `initialIndentLevel` attribute.
| xref:BloombergLP/bdljsn/WriteOptions/s_DEFAULT_INITIALIZER_SORT_MEMBERS.adoc[`s_DEFAULT_INITIALIZER_SORT_MEMBERS`] 
| Default value for the `sortMembers` attribute.
| xref:BloombergLP/bdljsn/WriteOptions/s_DEFAULT_INITIALIZER_SPACES_PER_LEVEL.adoc[`s_DEFAULT_INITIALIZER_SPACES_PER_LEVEL`] 
| Default value for the `spacesPerLevel` attribute.
| xref:BloombergLP/bdljsn/WriteOptions/s_DEFAULT_INITIALIZER_STYLE.adoc[`s_DEFAULT_INITIALIZER_STYLE`] 
| Default value for the `style` attribute.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/operator_not_eq-017.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise.
| xref:BloombergLP/bdljsn/operator_eq-07c9.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#