headerFieldFactory Class Reference

#include <headerFieldFactory.hpp>

Classes
struct	ValueInfo

Public Member Functions
template<class T>
void	registerField (const string &name)
template<class T>
void	registerFieldValue (const string &name)
shared_ptr< headerField >	create (const string &name, const string &body=NULL_STRING)
shared_ptr< headerFieldValue >	createValue (const string &fieldName)
bool	isValueTypeValid (const headerField &field, const headerFieldValue &value) const

Static Public Member Functions
static shared_ptr< headerFieldFactory >	getInstance ()

Protected Types
typedef shared_ptr< headerField >(*	AllocFunc) (void)
typedef std::map< string, AllocFunc >	NameMap
typedef std::map< string, ValueInfo >	ValueMap

Protected Member Functions
	headerFieldFactory ()
	~headerFieldFactory ()

Protected Attributes
NameMap	m_nameMap
ValueMap	m_valueMap

Detailed Description

Creates header field and header field value objects.

Member Typedef Documentation

AllocFunc

typedef shared_ptr< headerField >(* AllocFunc) (void)

protected

NameMap

typedef std::map<string, AllocFunc> NameMap

protected

ValueMap

typedef std::map<string, ValueInfo> ValueMap

protected

Constructor & Destructor Documentation

headerFieldFactory()

headerFieldFactory ( )

protected

References vmime::fields::BCC, vmime::fields::CC, vmime::fields::CONTENT_DESCRIPTION, vmime::fields::CONTENT_DISPOSITION, vmime::fields::CONTENT_ID, vmime::fields::CONTENT_LOCATION, vmime::fields::CONTENT_TRANSFER_ENCODING, vmime::fields::CONTENT_TYPE, vmime::fields::DATE, vmime::fields::DELIVERED_TO, vmime::fields::DISPOSITION, vmime::fields::DISPOSITION_NOTIFICATION_TO, vmime::fields::FROM, vmime::fields::IN_REPLY_TO, vmime::fields::MESSAGE_ID, vmime::fields::MIME_VERSION, vmime::fields::ORGANIZATION, vmime::fields::ORIGINAL_MESSAGE_ID, vmime::fields::RECEIVED, vmime::fields::REFERENCES, registerField(), registerFieldValue(), vmime::fields::REPLY_TO, vmime::fields::RETURN_PATH, vmime::fields::SENDER, vmime::fields::SUBJECT, vmime::fields::TO, and vmime::fields::USER_AGENT.

Referenced by getInstance().

~headerFieldFactory()

~headerFieldFactory ( )

protected

Member Function Documentation

create()

shared_ptr< headerField > create	(	const string &	name,
		const string &	body = NULL_STRING )

Create a new field object for the specified field name.

If the field name has not been registered, a default type is used.

Parameters

name	field name
body	string that will be parsed to initialize the value of the field

Returns

a new field object

References createValue(), m_nameMap, vmime::NULL_STRING, and stringUtils::toLower().

createValue()

shared_ptr< headerFieldValue > createValue

(

const string &

fieldName

)

Create a new field value for the specified field.

Parameters

fieldName

name of the field for which to create value

Returns

a new value object for the field

References m_valueMap, and stringUtils::toLower().

Referenced by create().

getInstance()

shared_ptr< headerFieldFactory > getInstance ( )

static

References headerFieldFactory().

Referenced by headerField::clone(), header::getField(), headerField::parseNext(), headerField::setValue(), headerField::setValue(), and headerField::setValueConst().

isValueTypeValid()

bool isValueTypeValid	(	const headerField &	field,
		const headerFieldValue &	value ) const

Returns whether the specified value type is valid for the specified field.

Parameters

field	header field
value	value for this header field

Returns

true if the value type is compatible with the header field, or false otherwise

References headerField::getName(), m_valueMap, and stringUtils::toLower().

registerField()

template<class T>

void registerField

(

const string &

name

)

Register a field type.

Parameters

T	field class (must inherit from 'headerField')
name	field name (eg. "X-MyField")

References m_nameMap, and stringUtils::toLower().

Referenced by headerFieldFactory().

registerFieldValue()

template<class T>

void registerFieldValue

(

const string &

name

)

Register a field value type.

Parameters

T	value class (must inherit from 'headerFieldValue')
name	field name

References headerFieldFactory::ValueInfo::allocFunc, headerFieldFactory::ValueInfo::checkTypeFunc, m_valueMap, and stringUtils::toLower().

Referenced by headerFieldFactory().

Member Data Documentation

m_nameMap

NameMap m_nameMap

protected

Referenced by create(), and registerField().

m_valueMap

ValueMap m_valueMap

protected

Referenced by createValue(), isValueTypeValid(), and registerFieldValue().

---

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

• headerFieldFactory.hpp
• headerFieldFactory.cpp