BDE 4.14.0 Production release
Loading...
Searching...
No Matches
balxml::DecoderOptions Class Reference

#include <balxml_decoderoptions.h>

Public Types

enum  {
  ATTRIBUTE_ID_MAX_DEPTH = 0 , ATTRIBUTE_ID_FORMATTING_MODE = 1 , ATTRIBUTE_ID_SKIP_UNKNOWN_ELEMENTS = 2 , ATTRIBUTE_ID_VALIDATE_INPUT_IS_UTF8 = 3 ,
  ATTRIBUTE_ID_VALIDATE_ROOT_TAG = 4
}
 
enum  { NUM_ATTRIBUTES = 5 }
 
enum  {
  ATTRIBUTE_INDEX_MAX_DEPTH = 0 , ATTRIBUTE_INDEX_FORMATTING_MODE = 1 , ATTRIBUTE_INDEX_SKIP_UNKNOWN_ELEMENTS = 2 , ATTRIBUTE_INDEX_VALIDATE_INPUT_IS_UTF8 = 3 ,
  ATTRIBUTE_INDEX_VALIDATE_ROOT_TAG = 4
}
 

Public Member Functions

 DecoderOptions ()
 Create an object of type DecoderOptions having the default value.
 
 DecoderOptions (const DecoderOptions &original)
 
 ~DecoderOptions ()
 Destroy this object.
 
DecoderOptionsoperator= (const DecoderOptions &rhs)
 Assign to this object the value of the specified rhs object.
 
void reset ()
 
template<typename t_MANIPULATOR >
int manipulateAttributes (t_MANIPULATOR &manipulator)
 
template<typename t_MANIPULATOR >
int manipulateAttribute (t_MANIPULATOR &manipulator, int id)
 
template<typename t_MANIPULATOR >
int manipulateAttribute (t_MANIPULATOR &manipulator, const char *name, int nameLength)
 
void setMaxDepth (int value)
 
void setFormattingMode (int value)
 
void setSkipUnknownElements (bool value)
 
void setValidateInputIsUtf8 (bool value)
 
void setValidateRootTag (bool value)
 
bsl::ostream & print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const
 
template<typename t_ACCESSOR >
int accessAttributes (t_ACCESSOR &accessor) const
 
template<typename t_ACCESSOR >
int accessAttribute (t_ACCESSOR &accessor, int id) const
 
template<typename t_ACCESSOR >
int accessAttribute (t_ACCESSOR &accessor, const char *name, int nameLength) const
 
int maxDepth () const
 Return the value of the "MaxDepth" attribute of this object.
 
int formattingMode () const
 Return the value of the "FormattingMode" attribute of this object.
 
bool skipUnknownElements () const
 
bool validateInputIsUtf8 () const
 
bool validateRootTag () const
 Return the value of the "ValidateRootTag" attribute of this object.
 

Static Public Member Functions

static const bdlat_AttributeInfolookupAttributeInfo (int id)
 
static const bdlat_AttributeInfolookupAttributeInfo (const char *name, int nameLength)
 

Static Public Attributes

static const char CLASS_NAME []
 
static const int DEFAULT_INITIALIZER_MAX_DEPTH
 
static const int DEFAULT_INITIALIZER_FORMATTING_MODE
 
static const bool DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS
 
static const bool DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8
 
static const bool DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG
 
static const bdlat_AttributeInfo ATTRIBUTE_INFO_ARRAY []
 

Detailed Description

Options for controlling the XML decoding process. The generated C++ code for this schema element is created by using bas_codegen.pl, run by balxml/code_from_xsd.pl with no hand-editing.

See balxml_decoderoptions

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ATTRIBUTE_ID_MAX_DEPTH 
ATTRIBUTE_ID_FORMATTING_MODE 
ATTRIBUTE_ID_SKIP_UNKNOWN_ELEMENTS 
ATTRIBUTE_ID_VALIDATE_INPUT_IS_UTF8 
ATTRIBUTE_ID_VALIDATE_ROOT_TAG 

◆ anonymous enum

anonymous enum
Enumerator
NUM_ATTRIBUTES 

◆ anonymous enum

anonymous enum
Enumerator
ATTRIBUTE_INDEX_MAX_DEPTH 
ATTRIBUTE_INDEX_FORMATTING_MODE 
ATTRIBUTE_INDEX_SKIP_UNKNOWN_ELEMENTS 
ATTRIBUTE_INDEX_VALIDATE_INPUT_IS_UTF8 
ATTRIBUTE_INDEX_VALIDATE_ROOT_TAG 

Constructor & Destructor Documentation

◆ DecoderOptions() [1/2]

balxml::DecoderOptions::DecoderOptions ( )

◆ DecoderOptions() [2/2]

balxml::DecoderOptions::DecoderOptions ( const DecoderOptions original)

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

◆ ~DecoderOptions()

balxml::DecoderOptions::~DecoderOptions ( )

Member Function Documentation

◆ accessAttribute() [1/2]

template<typename t_ACCESSOR >
int balxml::DecoderOptions::accessAttribute ( t_ACCESSOR &  accessor,
const char *  name,
int  nameLength 
) const

Invoke the specified accessor on the (non-modifiable) attribute of this object indicated by the specified name of the specified nameLength, supplying accessor with the corresponding attribute information structure. Return the value returned from the invocation of accessor if name identifies an attribute of this class, and -1 otherwise.

◆ accessAttribute() [2/2]

template<typename t_ACCESSOR >
int balxml::DecoderOptions::accessAttribute ( t_ACCESSOR &  accessor,
int  id 
) const

Invoke the specified accessor on the (non-modifiable) attribute of this object indicated by the specified id, supplying accessor with the corresponding attribute information structure. Return the value returned from the invocation of accessor if id identifies an attribute of this class, and -1 otherwise.

◆ accessAttributes()

template<typename t_ACCESSOR >
int balxml::DecoderOptions::accessAttributes ( t_ACCESSOR &  accessor) const

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).

◆ formattingMode()

int balxml::DecoderOptions::formattingMode ( ) const
inline

◆ lookupAttributeInfo() [1/2]

static const bdlat_AttributeInfo * balxml::DecoderOptions::lookupAttributeInfo ( const char *  name,
int  nameLength 
)
static

Return attribute information for the attribute indicated by the specified name of the specified nameLength if the attribute exists, and 0 otherwise.

◆ lookupAttributeInfo() [2/2]

static const bdlat_AttributeInfo * balxml::DecoderOptions::lookupAttributeInfo ( int  id)
static

Return attribute information for the attribute indicated by the specified id if the attribute exists, and 0 otherwise.

◆ manipulateAttribute() [1/2]

template<typename t_MANIPULATOR >
int balxml::DecoderOptions::manipulateAttribute ( t_MANIPULATOR &  manipulator,
const char *  name,
int  nameLength 
)

Invoke the specified manipulator on the address of the (modifiable) attribute indicated by the specified name of the specified nameLength, supplying manipulator with the corresponding attribute information structure. Return the value returned from the invocation of manipulator if name identifies an attribute of this class, and -1 otherwise.

◆ manipulateAttribute() [2/2]

template<typename t_MANIPULATOR >
int balxml::DecoderOptions::manipulateAttribute ( t_MANIPULATOR &  manipulator,
int  id 
)

Invoke the specified manipulator on the address of the (modifiable) attribute indicated by the specified id, supplying manipulator with the corresponding attribute information structure. Return the value returned from the invocation of manipulator if id identifies an attribute of this class, and -1 otherwise.

◆ manipulateAttributes()

template<typename t_MANIPULATOR >
int balxml::DecoderOptions::manipulateAttributes ( t_MANIPULATOR &  manipulator)

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()

int balxml::DecoderOptions::maxDepth ( ) const
inline

◆ operator=()

DecoderOptions & balxml::DecoderOptions::operator= ( const DecoderOptions rhs)

◆ print()

bsl::ostream & balxml::DecoderOptions::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.

◆ reset()

void balxml::DecoderOptions::reset ( )

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

◆ setFormattingMode()

void balxml::DecoderOptions::setFormattingMode ( int  value)
inline

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

◆ setMaxDepth()

void balxml::DecoderOptions::setMaxDepth ( int  value)
inline

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

◆ setSkipUnknownElements()

void balxml::DecoderOptions::setSkipUnknownElements ( bool  value)
inline

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

◆ setValidateInputIsUtf8()

void balxml::DecoderOptions::setValidateInputIsUtf8 ( bool  value)
inline

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

◆ setValidateRootTag()

void balxml::DecoderOptions::setValidateRootTag ( bool  value)
inline

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

◆ skipUnknownElements()

bool balxml::DecoderOptions::skipUnknownElements ( ) const
inline

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

◆ validateInputIsUtf8()

bool balxml::DecoderOptions::validateInputIsUtf8 ( ) const
inline

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

◆ validateRootTag()

bool balxml::DecoderOptions::validateRootTag ( ) const
inline

Member Data Documentation

◆ ATTRIBUTE_INFO_ARRAY

const bdlat_AttributeInfo balxml::DecoderOptions::ATTRIBUTE_INFO_ARRAY[]
static

◆ CLASS_NAME

const char balxml::DecoderOptions::CLASS_NAME[]
static

◆ DEFAULT_INITIALIZER_FORMATTING_MODE

const int balxml::DecoderOptions::DEFAULT_INITIALIZER_FORMATTING_MODE
static

◆ DEFAULT_INITIALIZER_MAX_DEPTH

const int balxml::DecoderOptions::DEFAULT_INITIALIZER_MAX_DEPTH
static

◆ DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS

const bool balxml::DecoderOptions::DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS
static

◆ DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8

const bool balxml::DecoderOptions::DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8
static

◆ DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG

const bool balxml::DecoderOptions::DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG
static

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