Quick Links:

bal | bbl | bdl | bsl

Public Member Functions | Static Public Attributes

baljsn::DatumEncoderOptions Class Reference

#include <baljsn_datumencoderoptions.h>

List of all members.

Public Member Functions

 DatumEncoderOptions ()
 DatumEncoderOptions (const DatumEncoderOptions &original)
 ~DatumEncoderOptions ()
DatumEncoderOptionsoperator= (const DatumEncoderOptions &rhs)
void reset ()
void setStrictTypes (bool value)
void setInitialIndentLevel (int value)
void setSpacesPerLevel (int value)
void setEncodingStyle (baljsn::EncodingStyle::Value value)
void setEncodeQuotedDecimal64 (bool value)
bool strictTypes () const
int initialIndentLevel () const
int spacesPerLevel () const
baljsn::EncodingStyle::Value encodingStyle () const
bool encodeQuotedDecimal64 () const
bsl::ostream & print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const

Static Public Attributes

static const bool s_DEFAULT_INITIALIZER_STRICT_TYPES
static const bool s_DEFAULT_INITIALIZER_ENCODE_QUOTED_DECIMAL64
static const int s_DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL
static const int s_DEFAULT_INITIALIZER_SPACES_PER_LEVEL
static const
baljsn::EncodingStyle::Value 
s_DEFAULT_INITIALIZER_ENCODING_STYLE

Detailed Description

This simply constrained (value-semantic) attribute class specifies options for encoding Datum objects in the JSON format. See the Attributes section under @DESCRIPTION in the component-level documentation for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

See Component baljsn_datumencoderoptions


Constructor & Destructor Documentation

baljsn::DatumEncoderOptions::DatumEncoderOptions (  ) 

Create an object of type DatumEncoderOptions having the default value.

baljsn::DatumEncoderOptions::DatumEncoderOptions ( const DatumEncoderOptions original  ) 

Create an object of type DatumEncoderOptions having the value of the specified original object.

baljsn::DatumEncoderOptions::~DatumEncoderOptions (  ) 

Destroy this object.


Member Function Documentation

DatumEncoderOptions& baljsn::DatumEncoderOptions::operator= ( const DatumEncoderOptions rhs  ) 

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

void baljsn::DatumEncoderOptions::reset (  ) 

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

void baljsn::DatumEncoderOptions::setStrictTypes ( bool  value  ) 

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

void baljsn::DatumEncoderOptions::setInitialIndentLevel ( int  value  ) 

Set the "InitialIndentLevel" attribute of this object to the specified value. The behavior is undefined unless 0 <= value.

void baljsn::DatumEncoderOptions::setSpacesPerLevel ( int  value  ) 

Set the "SpacesPerLevel" attribute of this object to the specified value. The behavior is undefined unless 0 <= value.

void baljsn::DatumEncoderOptions::setEncodingStyle ( baljsn::EncodingStyle::Value  value  ) 

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

void baljsn::DatumEncoderOptions::setEncodeQuotedDecimal64 ( bool  value  ) 

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

bool baljsn::DatumEncoderOptions::strictTypes (  )  const

Return the "StrictTypes" attribute of this object.

int baljsn::DatumEncoderOptions::initialIndentLevel (  )  const

Return the "InitialIndentLevel" attribute of this object.

int baljsn::DatumEncoderOptions::spacesPerLevel (  )  const

Return the "SpacesPerLevel" attribute of this object.

baljsn::EncodingStyle::Value baljsn::DatumEncoderOptions::encodingStyle (  )  const

Return the "EncodingStyle" attribute of this object.

bool baljsn::DatumEncoderOptions::encodeQuotedDecimal64 (  )  const

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

bsl::ostream& baljsn::DatumEncoderOptions::print ( bsl::ostream &  stream,
int  level = 0,
int  spacesPerLevel = 4 
) const

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.


Member Data Documentation


The documentation for this class was generated from the following file: