Options for controlling the JSON decoding process.

Synopsis

Declared in <baljsn_decoderoptions.h>

class DecoderOptions;

Enums

Name

Description

Unnamed enum

Attribute identifier constants.

Unnamed enum

Attribute count constant.

Unnamed enum

Attribute index constants.

Member Functions

Name

Description

DecoderOptions [constructor]

Constructors

~DecoderOptions [destructor]

Destroy this object.

operator=

Assignment operators

accessAttribute

accessAttribute overloads

accessAttributes

Invoke the specified accessor sequentially on each (non‐modifiable) attribute of this object, supplying accessor with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of accessor (i.e., the invocation that terminated the sequence).

allowConsecutiveSeparators

Return the value of the "AllowConsecutiveSeparators" attribute of this object.

allowFormFeedAsWhitespace

Return the value of the "AllowFormFeedAsWhitespace" attribute of this object.

allowMissingRequiredAttributes

Return the value of the "AllowMissingRequiredAttributes" attribute of this object.

allowUnescapedControlCharacters

Return the value of the "AllowUnescapedControlCharacters" attribute of this object.

manipulateAttribute

manipulateAttribute overloads

manipulateAttributes

Invoke the specified manipulator sequentially on the address of each (modifiable) attribute of this object, supplying manipulator with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of manipulator (i.e., the invocation that terminated the sequence).

maxDepth

Return the value of the "MaxDepth" attribute of this object.

print

Format this object to the specified output stream at the optionally specified indentation level and return a reference to the modifiable stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of level * spacesPerLevel. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, suppress line breaks and format the entire output on one line. If stream is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.

reset

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

setAllowConsecutiveSeparators

Set the "AllowConsecutiveSeparators" attribute of this object to the specified value.

setAllowFormFeedAsWhitespace

Set the "AllowFormFeedAsWhitespace" attribute of this object to the specified value.

setAllowMissingRequiredAttributes

Set "AllowMissingRequiredAttributes" attribute of this object to the specified value.

setAllowUnescapedControlCharacters

Set the "AllowUnescapedControlCharacters" attribute of this object to the specified value.

setMaxDepth

Set the "MaxDepth" attribute of this object to the specified value.

setSkipUnknownElements

Set the "SkipUnknownElements" attribute of this object to the specified value.

setValidateInputIsUtf8

Set the "ValidateInputIsUtf8" attribute of this object to the specified value.

skipUnknownElements

Return the value of the "SkipUnknownElements" attribute of this object.

validateInputIsUtf8

Return the value of the "ValidateInputIsUtf8" attribute of this object.

Static Member Functions

Name

Description

lookupAttributeInfo

lookupAttributeInfo overloads

Static Data Members

Name

Description

ATTRIBUTE_INFO_ARRAY

Attribute metadata for this options type.

CLASS_NAME

Name of this class.

DEFAULT_INITIALIZER_ALLOW_CONSECUTIVE_SEPARATORS

Default value for the allowConsecutiveSeparators attribute.

DEFAULT_INITIALIZER_ALLOW_FORM_FEED_AS_WHITESPACE

Default value for the allowFormFeedAsWhitespace attribute.

DEFAULT_INITIALIZER_ALLOW_MISSING_REQUIRED_ATTRIBUTES

Default value for the allowMissingRequiredAttributes attribute.

DEFAULT_INITIALIZER_ALLOW_UNESCAPED_CONTROL_CHARACTERS

Default value for the allowUnescapedControlCharacters attribute.

DEFAULT_INITIALIZER_MAX_DEPTH

Default value for the maxDepth attribute.

DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS

Default value for the skipUnknownElements attribute.

DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8

Default value for the validateInputIsUtf8 attribute.

Friends

Name

Description

BloombergLP::baljsn::hashAppend

Pass the specified object to the specified hashAlg. This function integrates with the bslh modular hashing system and effectively provides a bsl::hash specialization for DecoderOptions.

BloombergLP::baljsn::operator<<

Format the specified rhs to the specified output stream and return a reference to the modifiable stream.

BloombergLP::baljsn::operator!=

Returns !(lhs == rhs)

BloombergLP::baljsn::operator==

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

Created with MrDocs