disposition Class Reference

#include <disposition.hpp>

Inheritance diagram for disposition:

Collaboration diagram for disposition:

Public Member Functions
	disposition ()
	disposition (const string &actionMode, const string &sendingMode, const string &type, const string &modifier)
shared_ptr< component >	clone () const
void	copyFrom (const component &other)
disposition &	operator= (const disposition &other)
const std::vector< shared_ptr< component > >	getChildComponents ()
void	setActionMode (const string &mode)
const string &	getActionMode () const
void	setSendingMode (const string &mode)
const string &	getSendingMode () const
void	setType (const string &type)
const string &	getType () const
void	addModifier (const string &modifier)
void	removeModifier (const string &modifier)
void	removeAllModifiers ()
bool	hasModifier (const string &modifier) const
const std::vector< string >	getModifierList () const
Public Member Functions inherited from headerFieldValue
size_t	getGeneratedSize (const generationContext &ctx)
Public Member Functions inherited from component
	component ()
virtual	~component ()
void	parse (const string &buffer)
void	parse (const parsingContext &ctx, const string &buffer)
void	parse (shared_ptr< utility::inputStream > inputStream, const size_t length)
void	parse (const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (const parsingContext &ctx, shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
virtual const string	generate (const size_t maxLineLength=lineLengthLimits::infinite, const size_t curLinePos=0) const
virtual void	generate (utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
virtual void	generate (const generationContext &ctx, utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
size_t	getParsedOffset () const
size_t	getParsedLength () const

Protected Member Functions
void	parseImpl (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	generateImpl (const generationContext &ctx, utility::outputStream &os, const size_t curLinePos=0, size_t *newLinePos=NULL) const
Protected Member Functions inherited from component
void	setParsedBounds (const size_t start, const size_t end)
virtual void	parseImpl (const parsingContext &ctx, shared_ptr< utility::parserInputStreamAdapter > parser, const size_t position, const size_t end, size_t *newPosition=NULL)
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Disposition - from RFC-3798 (basic type).

Constructor & Destructor Documentation

disposition() [1/2]

disposition

(

)

Referenced by copyFrom(), and operator=().

disposition() [2/2]

disposition	(	const string &	actionMode,
		const string &	sendingMode,
		const string &	type,
		const string &	modifier )

Member Function Documentation

addModifier()

void addModifier

(

const string &

modifier

)

Add a disposition modifier if it does not exist.

See the constants in vmime::dispositionModifiers.

Parameters

modifier

modifier to add

References hasModifier(), and stringUtils::toLower().

clone()

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns

a copy of this component

Implements component.

copyFrom()

void copyFrom ( const component & other )

virtual

Replace data in this component by data in other component.

Both components must be of the same type.

Exceptions

std::bad_cast_exception

if the components are not of the same (dynamic) type

Parameters

other

other component to copy data from

Implements component.

References disposition().

Referenced by operator=().

generateImpl()

void generateImpl ( const generationContext & ctx, utility::outputStream & os, const size_t curLinePos = 0, size_t * newLinePos = NULL ) const

protectedvirtual

Implements component.

References generationContext::getMaxLineLength(), vmime::NEW_LINE_SEQUENCE, vmime::NEW_LINE_SEQUENCE_LENGTH, and stringUtils::trim().

getActionMode()

const string & getActionMode

(

)

const

Return the disposition action mode.

See the constants in vmime::dispositionActionModes.

Returns

disposition action mode

getChildComponents()

const std::vector< shared_ptr< component > > getChildComponents ( )

virtual

Return the list of children of this component.

Returns

list of child components

Implements component.

getModifierList()

const std::vector< string > getModifierList

(

)

const

Return the list of modifiers.

Returns

list of modifiers

getSendingMode()

const string & getSendingMode

(

)

const

Return the disposition sending mode.

See the constants in vmime::dispositionSendingModes.

Returns

disposition sending mode

getType()

const string & getType

(

)

const

Return the disposition type.

See the constants in vmime::dispositionTypes.

Returns

disposition type

hasModifier()

bool hasModifier

(

const string &

modifier

)

const

Test whether a disposition modifier is set.

Parameters

modifier

modifier to test

Returns

true if the specified modifier is set, false otherwise

References stringUtils::toLower().

Referenced by addModifier().

operator=()

disposition & operator=

(

const disposition &

other

)

References copyFrom(), and disposition().

parseImpl()

void parseImpl ( const parsingContext & ctx, const string & buffer, const size_t position, const size_t end, size_t * newPosition = NULL )

protectedvirtual

Reimplemented from component.

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

removeAllModifiers()

void removeAllModifiers

(

)

Remove all disposition modifiers.

removeModifier()

void removeModifier

(

const string &

modifier

)

Remove the specified disposition modifier.

See the constants in vmime::dispositionModifiers.

Parameters

modifier

modifier to remove

References stringUtils::toLower().

setActionMode()

void setActionMode

(

const string &

mode

)

Set the disposition action mode.

See the constants in vmime::dispositionActionModes.

Parameters

mode	disposition action mode

setSendingMode()

void setSendingMode

(

const string &

mode

)

Set the disposition sending mode.

See the constants in vmime::dispositionSendingModes.

Parameters

mode	disposition sending mode

setType()

void setType

(

const string &

type

)

Set the disposition type.

See the constants in vmime::dispositionTypes.

Parameters

type	disposition type

---

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

• disposition.hpp
• disposition.cpp