An XMLObject that supports arbitrary attributes. More...

#include <xmltooling/AttributeExtensibleXMLObject.h>

Inheritance diagram for xmltooling::AttributeExtensibleXMLObject:

Collaboration diagram for xmltooling::AttributeExtensibleXMLObject:

Public Member Functions
virtual const XMLCh *	getAttribute (const QName &qualifiedName) const =0
	Gets the value of an XML attribute of the object.
virtual void	setAttribute (const QName &qualifiedName, const XMLCh *value, bool ID=false)=0
	Sets (or clears) an XML attribute of the object.
virtual void	setAttribute (const QName &qualifiedName, const QName &value)
	Sets a QName-valued XML attribute of the object.
virtual const std::map< QName, XMLCh * > &	getExtensionAttributes () const =0
	Gets an immutable map of the extended XML attributes of the object.
Static Public Member Functions
static const std::set< QName > &	getRegisteredIDAttributes ()
	Gets an immutable list of all the ID attributes currently registered.
static bool	isRegisteredIDAttribute (const QName &name)
	Tests whether an XML attribute is registered as an XML ID.
static void	registerIDAttribute (const QName &name)
	Registers a new attribute as being of XML ID type.
static void	deregisterIDAttribute (const QName &name)
	Deregisters an ID attribute.
static void	deregisterIDAttributes ()
	Deregisters all ID attributes.

Detailed Description

An XMLObject that supports arbitrary attributes.

Member Function Documentation

static void xmltooling::AttributeExtensibleXMLObject::deregisterIDAttribute ( const QName & name ) [static]

Deregisters an ID attribute.

Parameters:

name

the qualified attribute name

virtual const XMLCh* xmltooling::AttributeExtensibleXMLObject::getAttribute ( const QName & qualifiedName ) const [pure virtual]

Gets the value of an XML attribute of the object.

Parameters:

qualifiedName

qualified name of the attribute

virtual const std::map<QName,XMLCh*>& xmltooling::AttributeExtensibleXMLObject::getExtensionAttributes ( ) const [pure virtual]

Gets an immutable map of the extended XML attributes of the object.

This set is not guaranteed to (and generally will not) include attributes defined directly on the object's "type".

static const std::set<QName>& xmltooling::AttributeExtensibleXMLObject::getRegisteredIDAttributes ( ) [static]

Gets an immutable list of all the ID attributes currently registered.

static bool xmltooling::AttributeExtensibleXMLObject::isRegisteredIDAttribute ( const QName & name ) [static]

Tests whether an XML attribute is registered as an XML ID.

static void xmltooling::AttributeExtensibleXMLObject::registerIDAttribute ( const QName & name ) [static]

Registers a new attribute as being of XML ID type.

Parameters:

name

the qualified attribute name

virtual void xmltooling::AttributeExtensibleXMLObject::setAttribute	(	const QName &	qualifiedName,
		const QName &	value
	)			`[virtual]`

Sets a QName-valued XML attribute of the object.

Parameters:

	qualifiedName	qualified name of the attribute
	value	value to set

virtual void xmltooling::AttributeExtensibleXMLObject::setAttribute	(	const QName &	qualifiedName,
		const XMLCh *	value,
		bool	ID = `false`
	)			`[pure virtual]`

Sets (or clears) an XML attribute of the object.

Parameters:

	qualifiedName	qualified name of the attribute
	value	value to set, or nullptr to clear
	ID	true iff the attribute is an XML ID

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