C# Class SimpleFramework.Xml.Core.Qualifier

The Qualifier object is used to provide decorations to an output node for namespaces. This will scan a provided contact object for namespace annotations. If any are found they can then be used to apply these namespaces to the provided node. The Contact objects can represent fields or methods that have been annotated with XML annotations.

Inheritance: Decorator

显示文件 Open project: ngallagher/simplexml

Public Methods

Method	Description
Decorate ( OutputNode node ) : void	This method is used to decorate the provided node. This node can be either an XML element or an attribute. Decorations that can be applied to the node by invoking this method include things like namespaces and namespace lists.
Decorate ( OutputNode node, Decorator secondary ) : void	This method is used to decorate the provided node. This node can be either an XML element or an attribute. Decorations that can be applied to the node by invoking this method include things like namespaces and namespace lists. This can also be given another `Decorator` which is applied before this decorator, any common data can then be overwritten.
Namespace ( Contact contact ) : void	This is use to scan for `Namespace` annotations on the contact. Once a namespace has been located then it is used to populate the internal namespace decorator. This can then be used to decorate any output node that requires it.
Qualifier ( Contact contact ) : SimpleFramework.Xml.Stream	Constructor for the `Qualifier` object. This is used to create a decorator that will scan the provided contact for `Namespace` annotations. These can then be applied to the output node to provide qualification.
Scan ( Contact contact ) : void	This method is used to scan the `Contact` provided to determine if there are any namespace annotations. If there are any annotations then these are added to the internal namespace decorator. This ensues that they can be applied to the node when that node requests decoration.

Method Details

Decorate() public method

public Decorate ( OutputNode node ) : void
node	OutputNode	/// this is the node that is to be decorated by this ///
return	void

Decorate() public method

This method is used to decorate the provided node. This node can be either an XML element or an attribute. Decorations that can be applied to the node by invoking this method include things like namespaces and namespace lists. This can also be given another Decorator which is applied before this decorator, any common data can then be overwritten.

public Decorate ( OutputNode node, Decorator secondary ) : void
node	OutputNode	/// this is the node that is to be decorated by this ///
secondary	Decorator	/// this is a secondary decorator to be applied ///
return	void

Namespace() public method

This is use to scan for Namespace annotations on the contact. Once a namespace has been located then it is used to populate the internal namespace decorator. This can then be used to decorate any output node that requires it.

public Namespace ( Contact contact ) : void
contact	Contact	/// this is the contact to scan for namespaces ///
return	void

Qualifier() public method

Constructor for the Qualifier object. This is used to create a decorator that will scan the provided contact for Namespace annotations. These can then be applied to the output node to provide qualification.

public Qualifier ( Contact contact ) : SimpleFramework.Xml.Stream
contact	Contact	/// this is the contact to be scanned ///
return	SimpleFramework.Xml.Stream

Scan() public method

This method is used to scan the Contact provided to determine if there are any namespace annotations. If there are any annotations then these are added to the internal namespace decorator. This ensues that they can be applied to the node when that node requests decoration.

public Scan ( Contact contact ) : void
contact	Contact	/// this is the contact to be scanned for namespaces ///
return	void