OFXMLParser Class Reference

An event-based XML parser. More...

#import <OFXMLParser.h>

Inheritance diagram for OFXMLParser:

Instance Methods
(id< OFXMLParserDelegate >)	- delegate
	Returns the delegate that is used by the XML parser.
(void)	- setDelegate:
	Sets the delegate the OFXMLParser should use.
(void)	- parseBuffer:length:
	Parses the specified buffer with the specified size.
(void)	- parseString:
	Parses the specified string.
(void)	- parseStream:
	Parses the specified stream.
(void)	- parseFile:
	Parses the specified file.
(size_t)	- lineNumber
	Returns the current line number.
(BOOL)	- finishedParsing
	Returns whether the XML parser has finished parsing.
Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.
(OFString *)	- className
	Returns the name of the object's class.
(OFString *)	- description
	Returns a description for the object.
(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool.
(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.
(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.
(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.
(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.
(void)	- dealloc
	Deallocates the object.
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.
Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object 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.
(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.
(id)	- performSelector:
	Performs the specified selector.
(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(BOOL)	- isEqual:
	Checks two objects for equality.
(uint32_t)	- hash
	Calculates a hash for the object.
(id)	- retain
	Increases the retain count.
(unsigned int)	- retainCount
	Returns the retain count.
(void)	- release
	Decreases the retain count.
(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.
(id)	- self
	Returns the receiver.
(BOOL)	- isProxy
	Returns whether the object is a proxy object.
Instance Methods inherited from <OFStringXMLUnescapingDelegate>
(OFString *)	- string:containsUnknownEntityNamed:
	This callback is called when an unknown entity was found while trying to unescape XML.

Class Methods
(instancetype)	+ parser
	Creates a new XML parser.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(id)	+ new
	Allocates memory for a new instance and calls -[init] on it.
(Class)	+ class
	Returns the class.
(OFString *)	+ className
	Returns the name of the class as a string.
(BOOL)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.
(Class)	+ superclass
	Returns the superclass of the class.
(BOOL)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.
(BOOL)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.
(IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method.
(IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method.
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.
(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method.
(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

Additional Inherited Members
Public Attributes inherited from OFObject
Class	isa
	The class of the object.

Detailed Description

An event-based XML parser.

OFXMLParser is an event-based XML parser which calls the delegate's callbacks as soon asit finds something, thus suitable for streams as well.

Method Documentation

- (id <OFXMLParserDelegate>) delegate

Returns the delegate that is used by the XML parser.

Returns

The delegate that is used by the XML parser

- (BOOL) finishedParsing

Returns whether the XML parser has finished parsing.

Returns

Whether the XML parser has finished parsing

- (size_t) lineNumber

Returns the current line number.

Returns

The current line number

- (void) parseBuffer:		(const char*)	buffer
length:		(size_t)	length

Parses the specified buffer with the specified size.

Parameters

buffer	The buffer to parse
length	The length of the buffer

- (void) parseFile:

(OFString*)

path

Parses the specified file.

Parameters

path	The path to the file to parse

+ (instancetype) parser

Creates a new XML parser.

Returns

A new, autoreleased OFXMLParser

- (void) parseStream:

(OFStream*)

stream

Parses the specified stream.

Parameters

stream

The stream to parse

- (void) parseString:

(OFString*)

string

Parses the specified string.

Parameters

string

The string to parse

- (void) setDelegate:

(id <OFXMLParserDelegate>)

delegate

Sets the delegate the OFXMLParser should use.

Parameters

delegate

The delegate to use

---

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

• src/OFXMLParser.h
• src/OFXMLParser.m