ObjFW
Instance Methods | List of all members
<OFXMLElementBuilderDelegate> Protocol Reference

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

#import <OFXMLElementBuilder.h>

Inheritance diagram for <OFXMLElementBuilderDelegate>:
<OFObject>

Instance Methods

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

Detailed Description

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

OFXMLElementBuilder.h ObjFW/OFXMLElementBuilder.h

Method Documentation

- (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
builderThe builder which built an OFXMLElement
elementThe OFXMLElement the OFXMLElementBuilder built
- (void) elementBuilder: (OFXMLElementBuilder *)  builder
didBuildParentlessNode: (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
builderThe builder which built the OFXMLNode without parent
nodeThe OFXMLNode the OFXMLElementBuilder built
- (void) elementBuilder: (OFXMLElementBuilder *)  builder
didNotExpectCloseTag: (OFString *)  name
prefix: (nullable OFString *)  prefix
namespace: (nullable OFString *)  namespace_ 
optional

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
builderThe builder which did not expect the close tag
nameThe name of the close tag
prefixThe prefix of the close tag
namespace_The namespace of the close tag
- (OFString*) elementBuilder: (OFXMLElementBuilder *)  builder
foundUnknownEntityNamed: (OFString *)  entity 
optional

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

Parameters
builderThe element builder which found an unknown entity
entityThe name of the entity
Returns
The substitution for the entity

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