VMime
Classes | Public Member Functions | Static Public Member Functions | List of all members
propertySet Class Reference

#include <propertySet.hpp>

Inheritance diagram for propertySet:
Inheritance graph
[legend]
Collaboration diagram for propertySet:
Collaboration graph
[legend]

Classes

class  constPropertyProxy
 
class  property
 
class  propertyProxy
 

Public Member Functions

 propertySet ()
 
 propertySet (const string &props)
 
 propertySet (const propertySet &set)
 
 ~propertySet ()
 
propertySet & operator= (const propertySet &set)
 
void setFromString (const string &props)
 
void removeAllProperties ()
 
void removeProperty (const string &name)
 
bool hasProperty (const string &name) const
 
template<class TYPE >
const TYPE getProperty (const string &name) const
 
template<class TYPE >
const TYPE getProperty (const string &name, const TYPE defaultValue) const
 
template<class TYPE >
void setProperty (const string &name, const TYPE &value)
 
propertyProxy operator[] (const string &name)
 
const constPropertyProxy operator[] (const string &name) const
 
const std::vector< shared_ptr< const property > > getPropertyList () const
 
const std::vector< shared_ptr< property > > getPropertyList ()
 
template<>
string valueFromString (const string &value)
 
template<>
string valueToString (const string &value)
 
template<>
bool valueFromString (const string &value)
 
template<>
string valueToString (const bool &value)
 
template<>
VMIME_EXPORT string valueFromString (const string &value)
 
template<>
VMIME_EXPORT string valueToString (const string &value)
 
template<>
VMIME_EXPORT bool valueFromString (const string &value)
 
template<>
VMIME_EXPORT string valueToString (const bool &value)
 

Static Public Member Functions

template<typename TYPE >
static TYPE valueFromString (const string &value)
 
template<typename TYPE >
static string valueToString (const TYPE &value)
 

Additional Inherited Members

- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
object & operator= (const object &)
 
virtual ~object ()
 

Detailed Description

Manage a list of (name,value) pairs.

Constructor & Destructor Documentation

◆ propertySet() [1/3]

propertySet ( )

◆ propertySet() [2/3]

propertySet ( const string &  props)

◆ propertySet() [3/3]

propertySet ( const propertySet &  set)

References vmime::dynamicCast().

◆ ~propertySet()

~propertySet ( )

References propertySet::removeAllProperties().

Member Function Documentation

◆ getProperty() [1/2]

template<class TYPE >
const TYPE getProperty ( const string &  name) const

Get the value of the specified property.

Exceptions
exceptions::no_such_propertyif the property does not exist
Parameters
nameproperty name
Returns
value of the specified property

References vmime::dynamicCast().

Referenced by qpEncoder::decode(), b64Encoder::encode(), qpEncoder::encode(), uuEncoder::encode(), b64Encoder::getEncodedSize(), and qpEncoder::getEncodedSize().

◆ getProperty() [2/2]

template<class TYPE >
const TYPE getProperty ( const string &  name,
const TYPE  defaultValue 
) const

Get the value of the specified property.

A default value can be returned if the property is not set.

Parameters
nameproperty name
defaultValuevalue to return if the specified property does not exist
Returns
value of the specified property or default value if if does not exist

References vmime::dynamicCast().

◆ getPropertyList() [1/2]

const std::vector< shared_ptr< propertySet::property > > getPropertyList ( )

Return the property list.

Returns
list of properties

References vmime::dynamicCast().

◆ getPropertyList() [2/2]

const std::vector< shared_ptr< const propertySet::property > > getPropertyList ( ) const

Return the property list.

Returns
list of properties

References vmime::dynamicCast().

◆ hasProperty()

bool hasProperty ( const string &  name) const

Test whether the specified property is set.

Parameters
namename of the property to test
Returns
true if the property is set (has a value), false otherwise

References vmime::dynamicCast().

Referenced by defaultAuthenticator::getAccessToken(), defaultAuthenticator::getPassword(), and defaultAuthenticator::getUsername().

◆ operator=()

propertySet & operator= ( const propertySet &  set)

References vmime::dynamicCast(), and propertySet::removeAllProperties().

◆ operator[]() [1/2]

propertySet::propertyProxy operator[] ( const string &  name)

Return a proxy object to access the specified property suitable for reading or writing.

If the property does not exist and the value is changed, a new property will be created.

Parameters
nameproperty name
Returns
proxy object for the specified property

◆ operator[]() [2/2]

const propertySet::constPropertyProxy operator[] ( const string &  name) const

Return a proxy object to access the specified property suitable for reading only.

Exceptions
exceptions::no_such_propertyif the property does not exist
Returns
read-only proxy object for the specified property

◆ removeAllProperties()

void removeAllProperties ( )

Remove all properties from the list.

Referenced by propertySet::operator=(), and propertySet::~propertySet().

◆ removeProperty()

void removeProperty ( const string &  name)

Remove the specified property.

Parameters
namename of the property to remove

References vmime::dynamicCast().

◆ setFromString()

void setFromString ( const string &  props)

Parse a string and extract one or more properties.

The string format is: name[=value](;name[=value])*.

Parameters
propsstring representing a list of properties

◆ setProperty()

template<class TYPE >
void setProperty ( const string &  name,
const TYPE &  value 
)

Change the value of the specified property or create a new property set to the specified a value.

Parameters
nameproperty name
valueproperty value

References vmime::dynamicCast().

◆ valueFromString() [1/5]

template<>
string valueFromString ( const string &  value)

References vmime::dynamicCast().

◆ valueFromString() [2/5]

template<>
bool valueFromString ( const string &  value)

References vmime::dynamicCast(), and stringUtils::toLower().

◆ valueFromString() [3/5]

template<typename TYPE >
static TYPE valueFromString ( const string &  value)
static

References vmime::dynamicCast().

◆ valueFromString() [4/5]

template<>
VMIME_EXPORT string valueFromString ( const string &  value)

◆ valueFromString() [5/5]

template<>
VMIME_EXPORT bool valueFromString ( const string &  value)

◆ valueToString() [1/5]

template<>
string valueToString ( const bool &  value)

References vmime::dynamicCast().

◆ valueToString() [2/5]

template<>
VMIME_EXPORT string valueToString ( const bool &  value)

◆ valueToString() [3/5]

template<>
string valueToString ( const string &  value)

References vmime::dynamicCast().

◆ valueToString() [4/5]

template<>
VMIME_EXPORT string valueToString ( const string &  value)

◆ valueToString() [5/5]

template<typename TYPE >
static string valueToString ( const TYPE &  value)
static

References vmime::dynamicCast().

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