propertySet Class Reference

Inheritance diagram for propertySet:

Collaboration diagram for propertySet:

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

)

~propertySet()

~propertySet

(

)

References propertySet::removeAllProperties().

Member Function Documentation

getProperty() [1/2]

const TYPE getProperty

(

const string &

name

)

const

Get the value of the specified property.

Exceptions

exceptions::no_such_property

if the property does not exist

Parameters

name	property name

Returns

value of the specified property

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

getProperty() [2/2]

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

name	property name
defaultValue	value to return if the specified property does not exist

Returns

value of the specified property or default value if if does not exist

getPropertyList() [1/2]

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

(

)

const

Return the property list.

Returns

list of properties

getPropertyList() [2/2]

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

(

)

Return the property list.

Returns

list of properties

hasProperty()

bool hasProperty

(

const string &

name

)

const

Test whether the specified property is set.

Parameters

name	name of the property to test

Returns

true if the property is set (has a value), false otherwise

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

operator=()

propertySet & operator=

(

const propertySet &

set

)

References 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

name	property 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_property

if 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

name	name of the property to remove

References vmime::end(), and parserHelpers::isSpace().

setFromString()

void setFromString

(

const string &

props

)

Parse a string and extract one or more properties.

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

Parameters

props

string representing a list of properties

setProperty()

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

name	property name
value	property value

References stringUtils::toLower().

valueFromString() [1/5]

string valueFromString

(

const string &

value

)

valueFromString() [2/5]

bool valueFromString

(

const string &

value

)

References stringUtils::toLower().

valueFromString() [3/5]

static TYPE valueFromString ( const string &  value )

static

Referenced by propertySet::valueToString().

valueFromString() [4/5]

VMIME_EXPORT string valueFromString

(

const string &

value

)

valueFromString() [5/5]

VMIME_EXPORT bool valueFromString

(

const string &

value

)

valueToString() [1/5]

string valueToString

(

const string &

value

)

valueToString() [2/5]

string valueToString

(

const bool &

value

)

valueToString() [3/5]

static string valueToString ( const TYPE &  value )

static

References propertySet::property::getValue(), propertySet::property::setValue(), stringUtils::toLower(), and propertySet::valueFromString().

valueToString() [4/5]

VMIME_EXPORT string valueToString

(

const string &

value

)

valueToString() [5/5]

VMIME_EXPORT string valueToString

(

const bool &

value

)

---

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

• propertySet.hpp
• propertySet.cpp