MySQL 8.0.32
Source Code Documentation
Mysql::Tools::Base::Options::Composite_options_provider Class Reference

Provider that aggregates options from other providers. More...

#include <composite_options_provider.h>

Inheritance diagram for Mysql::Tools::Base::Options::Composite_options_provider:
[legend]

Public Member Functions

void add_providers (I_options_provider *first,...)
 Adds new providers to list. More...
 
void add_provider (I_options_provider *options_provider)
 Adds new provider to list. More...
 
void options_parsed () override
 This callback is to be called after all options were parsed. More...
 
std::vector< my_optiongenerate_options () override
 Aggregates all options from itsself and all contained providers. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
Simple_optioncreate_new_option (std::string name, std::string description)
 Creates and attach new simple option. More...
 
Disabled_optioncreate_new_disabled_option (std::string name, std::string description)
 Creates and attach new disabled option. More...
 
Char_array_optioncreate_new_option (char **value, std::string name, std::string description)
 Creates and attach new string option stored in char* type object. More...
 
Password_optioncreate_new_password_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new password option. More...
 
String_optioncreate_new_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new string option. More...
 
Number_option< int32 > * create_new_option (int32 *value, std::string name, std::string description)
 Creates and attach new 32-bit signed number option. More...
 
Number_option< uint32 > * create_new_option (uint32 *value, std::string name, std::string description)
 Creates and attach new 32-bit unsigned number option. More...
 
Number_option< int64 > * create_new_option (int64 *value, std::string name, std::string description)
 Creates and attach new 64-bit signed number option. More...
 
Number_option< uint64 > * create_new_option (uint64 *value, std::string name, std::string description)
 Creates and attach new 64-bit unsigned number option. More...
 
Number_option< double > * create_new_option (double *value, std::string name, std::string description)
 Creates and attach new floating-point number option. More...
 
Bool_optioncreate_new_option (bool *value, std::string name, std::string description)
 Creates and attach new boolean option with value received from argument. More...
 
template<typename T_type , typename T_typelib >
Enum_option< T_type, T_typelib > * create_new_enum_option (T_type *value, const T_typelib *type, std::string name, std::string description)
 
virtual void create_options ()=0
 Creates all options that will be provided. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::I_option_changed_listener
virtual ~I_option_changed_listener ()=default
 

Private Attributes

std::vector< I_options_provider * > m_options_providers
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
 Abstract_options_provider ()
 
 ~Abstract_options_provider () override
 
void set_option_changed_listener (I_option_changed_listener *listener) override
 Sets optional option changes listener to which all changes in all options contained in this provider should be reported. More...
 

Detailed Description

Provider that aggregates options from other providers.

It is still a provider, so can have have own options added.

Member Function Documentation

◆ add_provider()

void Composite_options_provider::add_provider ( I_options_provider options_provider)

Adds new provider to list.

◆ add_providers()

void Composite_options_provider::add_providers ( I_options_provider first,
  ... 
)

Adds new providers to list.

Last parameter value must be NULL.

◆ generate_options()

vector< my_option > Composite_options_provider::generate_options ( )
overridevirtual

Aggregates all options from itsself and all contained providers.

Reimplemented from Mysql::Tools::Base::Options::Abstract_options_provider.

◆ options_parsed()

void Composite_options_provider::options_parsed ( )
overridevirtual

This callback is to be called after all options were parsed.

Reimplemented from Mysql::Tools::Base::Options::Abstract_options_provider.

Member Data Documentation

◆ m_options_providers

std::vector<I_options_provider *> Mysql::Tools::Base::Options::Composite_options_provider::m_options_providers
private

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