baljsn_converttojsonoptions

Detailed Description

Provide options for conversion of bdlat to Json objects.

Outline

• Purpose
• Classes
• Description
  • Attributes
  • Usage
    • Example 1: Creating and Populating an Options Object

Purpose

Provide options for conversion of bdlat to Json objects.

Classes

• baljsn::ConvertToJsonOptions: options for bdlat to bdljsn::Json

Description

This component provides a single, (value-semantic) attribute class, baljsn::ConvertToJsonOptions, that is used to specify options for converting bdlat-compliant objects to bdljsn::Json objects.

Attributes

Name                   Type    Default    Simple Constraints
---------------------- ------- ---------- ----------------------
convertEmptyArrays     bool    true       none
convertNullElements    bool    true       none

• convertEmptyArrays: whether empty arrays should be converted to bdljsn::JsonArray() objects. Note that empty arrays that occur as selections of choices are always converted regardless of this option setting.
• convertNullElements: whether null elements in arrays should be converted as bdljsn::JsonNull() objects.

The default values of these options are the opposite of the default values of the similarly named baljsn::EncoderOptions options.

Usage

This section illustrates intended use of this component.

Example 1: Creating and Populating an Options Object

This component is designed to be used at a higher level to set the options for JSON conversion of bdlat objects. This example shows how to create and populate an options object.

First, we default-construct a baljsn::ConvertToJsonOptions object:

baljsn::ConvertToJsonOptions options;
assert(true == options.convertEmptyArrays());
assert(true == options.convertNullElements());

Next, we populate that object with custom values:

options.setConvertEmptyArrays(false);
assert(false == options.convertEmptyArrays());
 
options.setConvertNullElements(false);
assert(false == options.convertNullElements());