baljsn_convertfromjsonoptions

Detailed Description

Provide an attribute class for JsonConverter "from" options.

Outline

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

Purpose

Provide an attribute class for JsonConverter "from" options.

Classes

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

Description

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

Attributes

Name                   Type    Default    Simple Constraints
---------------------- ------- ---------- ----------------------
maxDepth               int     512        >= 0
skipUnknownElements    bool    true       none

• maxDepth: maximum allowed depth of the Json source object. If exceeded, the conversion fails.
• skipUnknownElements: flag specifying if elements of the Json source object that are unknown to the bdlat object should be quietly skipped. If false any unknown element fails the conversion.

The default values of maxDepth and skipUnknownElements are the same as the default values of the identically named baljsn::DecoderOptions 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::ConvertFromJsonOptions object:

baljsn::ConvertFromJsonOptions options;
assert(512  == options.maxDepth());
assert(true == options.skipUnknownElements());

Next, we populate that object with custom values:

options.setMaxDepth(10);
assert(10 == options.maxDepth());
 
options.setSkipUnknownElements(false);
assert(false == options.skipUnknownElements());