<OFXMLElementBuilderDelegate> Protocol Reference

A protocol that needs to be implemented by delegates for OFXMLElementBuilder. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for <OFXMLElementBuilderDelegate>:

Instance Methods
(void)	- elementBuilder:didBuildElement:
	This callback is called when the OFXMLElementBuilder built an element.
(void)	- elementBuilder:didBuildOrphanNode:
	This callback is called when the OFXMLElementBuilder built an OFXMLNode which is not inside an element.
(void)	- elementBuilder:didNotExpectCloseTag:prefix:namespace:
	This callback is called when the OFXMLElementBuilder gets a close tag which does not belong there.
(OFString *)	- elementBuilder:foundUnknownEntityNamed:
	This callback is called when the XML parser for the element builder found an unknown entity.
Instance Methods inherited from <OFObject>
(Class)	- class
	Returns the class of the object.
(nullable Class)	- superclass
	Returns the superclass of the object.
(unsigned long)	- hash
	Returns a hash for the object.
(unsigned int)	- retainCount
	Returns the retain count.
(bool)	- isProxy
	Returns whether the object is a proxy object.
(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.
(bool)	- conformsToProtocol:
	Checks whether the object conforms to the specified protocol.
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(nullable id)	- performSelector:
	Performs the specified selector.
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(bool)	- isEqual:
	Checks two objects for equality.
(instancetype)	- retain
	Increases the retain count.
(void)	- release
	Decreases the retain count.
(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
(instancetype)	- self
	Returns the receiver.
(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.
(bool)	- retainWeakReference
	Retain a weak reference to this object.

Detailed Description

A protocol that needs to be implemented by delegates for OFXMLElementBuilder.

Method Documentation

elementBuilder:didBuildElement:

- (void) elementBuilder:		(OFXMLElementBuilder *)	builder
didBuildElement:		(OFXMLElement *)	element

This callback is called when the OFXMLElementBuilder built an element.

If the OFXMLElementBuilder was used as a delegate for the OFXMLParser since parsing started, this will return the complete document as an OFXMLElement with all children.

Parameters

builder	The builder which built an OFXMLElement
element	The OFXMLElement the OFXMLElementBuilder built

elementBuilder:didBuildOrphanNode:

- (void) elementBuilder: (OFXMLElementBuilder *) builder didBuildOrphanNode: (OFXMLNode *) node

optional

This callback is called when the OFXMLElementBuilder built an OFXMLNode which is not inside an element.

This is usually called for comments or whitespace character data before the root element.

Parameters

builder	The builder which built the OFXMLNode without parent
node	The OFXMLNode the OFXMLElementBuilder built

elementBuilder:didNotExpectCloseTag:prefix:namespace:

- (void) elementBuilder: (OFXMLElementBuilder *) builder didNotExpectCloseTag: (OFString *) name prefix: (nullable OFString *) prefix namespace: (nullable OFString *) nameSpace

optionalrequired

This callback is called when the OFXMLElementBuilder gets a close tag which does not belong there.

Most likely, the OFXMLElementBuilder was used to build XML only of a child of the root element and the root element was closed. Often the delegate is set to the OFXMLElementBuilder when a certain element is found, this can be used then to set the delegate back after that certain element has been closed.

If this method is not implemented in the delegate, the default is to throw an OFMalformedXMLException.

Parameters

builder	The builder which did not expect the close tag
name	The name of the close tag
prefix	The prefix of the close tag
nameSpace	The namespace of the close tag

elementBuilder:foundUnknownEntityNamed:

- (OFString *) elementBuilder: (OFXMLElementBuilder *) builder foundUnknownEntityNamed: (OFString *) entity

optionalrequired

This callback is called when the XML parser for the element builder found an unknown entity.

Parameters

builder	The element builder which found an unknown entity
entity	The name of the entity

Returns

The substitution for the entity

---

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

• src/OFXMLElementBuilder.h