apple.foundation.protocol

Interface NSXMLParserDelegate

public interface NSXMLParserDelegate

The parser's delegate is informed of events through the methods in the NSXMLParserDelegateEventAdditions category.

Method Summary

Modifier and Type	Method and Description
default void	parserDidEndDocument(NSXMLParser parser) sent when the parser begins parsing of the document.
default void	parserDidEndElementNamespaceURIQualifiedName(NSXMLParser parser, java.lang.String elementName, java.lang.String namespaceURI, java.lang.String qName) sent when the parser finds an element start tag.
default void	parserDidEndMappingPrefix(NSXMLParser parser, java.lang.String prefix) sent when the parser first sees a namespace attribute.
default void	parserDidStartDocument(NSXMLParser parser) Document handling methods
default void	parserDidStartElementNamespaceURIQualifiedNameAttributes(NSXMLParser parser, java.lang.String elementName, java.lang.String namespaceURI, java.lang.String qName, NSDictionary<java.lang.String,java.lang.String> attributeDict)
default void	parserDidStartMappingPrefixToURI(NSXMLParser parser, java.lang.String prefix, java.lang.String namespaceURI) sent when an end tag is encountered.
default void	parserFoundAttributeDeclarationWithNameForElementTypeDefaultValue(NSXMLParser parser, java.lang.String attributeName, java.lang.String elementName, java.lang.String type, java.lang.String defaultValue)
default void	parserFoundCDATA(NSXMLParser parser, NSData CDATABlock) A comment (Text in a block) is reported to the delegate as a single string
default void	parserFoundCharacters(NSXMLParser parser, java.lang.String string) sent when the namespace prefix in question goes out of scope.
default void	parserFoundComment(NSXMLParser parser, java.lang.String comment) The parser reports a processing instruction to you using this method.
default void	parserFoundElementDeclarationWithNameModel(NSXMLParser parser, java.lang.String elementName, java.lang.String model)
default void	parserFoundExternalEntityDeclarationWithNamePublicIDSystemID(NSXMLParser parser, java.lang.String name, java.lang.String publicID, java.lang.String systemID)
default void	parserFoundIgnorableWhitespace(NSXMLParser parser, java.lang.String whitespaceString) This returns the string of the characters encountered thus far.
default void	parserFoundInternalEntityDeclarationWithNameValue(NSXMLParser parser, java.lang.String name, java.lang.String value)
default void	parserFoundNotationDeclarationWithNamePublicIDSystemID(NSXMLParser parser, java.lang.String name, java.lang.String publicID, java.lang.String systemID) DTD handling methods for various declarations.
default void	parserFoundProcessingInstructionWithTargetData(NSXMLParser parser, java.lang.String target, java.lang.String data) The parser reports ignorable whitespace in the same way as characters it's found.
default void	parserFoundUnparsedEntityDeclarationWithNamePublicIDSystemIDNotationName(NSXMLParser parser, java.lang.String name, java.lang.String publicID, java.lang.String systemID, java.lang.String notationName)
default void	parserParseErrorOccurred(NSXMLParser parser, NSError parseError) this gives the delegate an opportunity to resolve an external entity itself and reply with the resulting data.
default NSData	parserResolveExternalEntityNameSystemID(NSXMLParser parser, java.lang.String name, java.lang.String systemID) this reports a CDATA block to the delegate as an NSData.
default void	parserValidationErrorOccurred(NSXMLParser parser, NSError validationError) ...and this reports a fatal error to the delegate.

Method Detail

parserDidEndElementNamespaceURIQualifiedName

default void parserDidEndElementNamespaceURIQualifiedName(NSXMLParser parser,
                                                          java.lang.String elementName,
                                                          java.lang.String namespaceURI,
                                                          java.lang.String qName)

sent when the parser finds an element start tag. In the case of the cvslog tag, the following is what the delegate receives: elementName == cvslog, namespaceURI == http://xml.apple.com/cvslog, qualifiedName == cvslog In the case of the radar tag, the following is what's passed in: elementName == radar, namespaceURI == http://xml.apple.com/radar, qualifiedName == radar:radar If namespace processing >isn't< on, the xmlns:radar="http://xml.apple.com/radar" is returned as an attribute pair, the elementName is 'radar:radar' and there is no qualifiedName.

parserDidEndMappingPrefix

default void parserDidEndMappingPrefix(NSXMLParser parser,
                                       java.lang.String prefix)

sent when the parser first sees a namespace attribute. In the case of the cvslog tag, before the didStartElement:, you'd get one of these with prefix == @"" and namespaceURI == @"http://xml.apple.com/cvslog" (i.e. the default namespace) In the case of the radar:radar tag, before the didStartElement: you'd get one of these with prefix == @"radar" and namespaceURI == @"http://xml.apple.com/radar"

parserDidStartElementNamespaceURIQualifiedNameAttributes

default void parserDidStartElementNamespaceURIQualifiedNameAttributes(NSXMLParser parser,
                                                                      java.lang.String elementName,
                                                                      java.lang.String namespaceURI,
                                                                      java.lang.String qName,
                                                                      NSDictionary<java.lang.String,java.lang.String> attributeDict)

parserDidStartMappingPrefixToURI

default void parserDidStartMappingPrefixToURI(NSXMLParser parser,
                                              java.lang.String prefix,
                                              java.lang.String namespaceURI)

sent when an end tag is encountered. The various parameters are supplied as above.

parserFoundAttributeDeclarationWithNameForElementTypeDefaultValue

default void parserFoundAttributeDeclarationWithNameForElementTypeDefaultValue(NSXMLParser parser,
                                                                               java.lang.String attributeName,
                                                                               java.lang.String elementName,
                                                                               java.lang.String type,
                                                                               java.lang.String defaultValue)

parserFoundCDATA

default void parserFoundCDATA(NSXMLParser parser,
                              NSData CDATABlock)

A comment (Text in a block) is reported to the delegate as a single string

parserFoundCharacters

default void parserFoundCharacters(NSXMLParser parser,
                                   java.lang.String string)

sent when the namespace prefix in question goes out of scope.

parserFoundComment

default void parserFoundComment(NSXMLParser parser,
                                java.lang.String comment)

The parser reports a processing instruction to you using this method. In the case above, target == @"xml-stylesheet" and data == @"type='text/css' href='cvslog.css'"

parserFoundElementDeclarationWithNameModel

default void parserFoundElementDeclarationWithNameModel(NSXMLParser parser,
                                                        java.lang.String elementName,
                                                        java.lang.String model)

parserFoundExternalEntityDeclarationWithNamePublicIDSystemID

default void parserFoundExternalEntityDeclarationWithNamePublicIDSystemID(NSXMLParser parser,
                                                                          java.lang.String name,
                                                                          java.lang.String publicID,
                                                                          java.lang.String systemID)

parserFoundIgnorableWhitespace

default void parserFoundIgnorableWhitespace(NSXMLParser parser,
                                            java.lang.String whitespaceString)

This returns the string of the characters encountered thus far. You may not necessarily get the longest character run. The parser reserves the right to hand these to the delegate as potentially many calls in a row to -parser:foundCharacters:

parserFoundInternalEntityDeclarationWithNameValue

default void parserFoundInternalEntityDeclarationWithNameValue(NSXMLParser parser,
                                                               java.lang.String name,
                                                               java.lang.String value)

parserFoundNotationDeclarationWithNamePublicIDSystemID

default void parserFoundNotationDeclarationWithNamePublicIDSystemID(NSXMLParser parser,
                                                                    java.lang.String name,
                                                                    java.lang.String publicID,
                                                                    java.lang.String systemID)

DTD handling methods for various declarations.

parserFoundProcessingInstructionWithTargetData

default void parserFoundProcessingInstructionWithTargetData(NSXMLParser parser,
                                                            java.lang.String target,
                                                            java.lang.String data)

The parser reports ignorable whitespace in the same way as characters it's found.

parserFoundUnparsedEntityDeclarationWithNamePublicIDSystemIDNotationName

default void parserFoundUnparsedEntityDeclarationWithNamePublicIDSystemIDNotationName(NSXMLParser parser,
                                                                                      java.lang.String name,
                                                                                      java.lang.String publicID,
                                                                                      java.lang.String systemID,
                                                                                      java.lang.String notationName)

parserParseErrorOccurred

default void parserParseErrorOccurred(NSXMLParser parser,
                                      NSError parseError)

this gives the delegate an opportunity to resolve an external entity itself and reply with the resulting data.

parserResolveExternalEntityNameSystemID

default NSData parserResolveExternalEntityNameSystemID(NSXMLParser parser,
                                                       java.lang.String name,
                                                       java.lang.String systemID)

this reports a CDATA block to the delegate as an NSData.

parserValidationErrorOccurred

default void parserValidationErrorOccurred(NSXMLParser parser,
                                           NSError validationError)

...and this reports a fatal error to the delegate. The parser will stop parsing.

parserDidEndDocument

default void parserDidEndDocument(NSXMLParser parser)

sent when the parser begins parsing of the document.

parserDidStartDocument

default void parserDidStartDocument(NSXMLParser parser)

Document handling methods