A class which stores an XML element. More...

#import <ObjFW/OFXMLElement.h>

Inheritance diagram for OFXMLElement:

Instance Methods
(id)	- initWithName:
	Initializes an already allocated OFXMLElement with the specified name. More...

(id)	- initWithName:stringValue:
	Initializes an already allocated OFXMLElement with the specified name and string value. More...

(id)	- initWithName:namespace:
	Initializes an already allocated OFXMLElement with the specified name and namespace. More...

(id)	- initWithName:namespace:stringValue:
	Initializes an already allocated OFXMLElement with the specified name, namespace and value. More...

(id)	- initWithElement:
	Initializes an already allocated OFXMLElement with the specified element. More...

(id)	- initWithXMLString:
	Parses the string and initializes an already allocated OFXMLElement with it. More...

(id)	- initWithFile:
	Parses the specified file and initializes an already allocated OFXMLElement with it. More...

(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization. More...

(void)	- setPrefix:forNamespace:
	Sets a prefix for a namespace. More...

(void)	- bindPrefix:forNamespace:
	Binds a prefix for a namespace. More...

(nullable OFArray *)	- attributes
	Returns an OFArray with the attributes of the element. More...

(void)	- addAttribute:
	Adds the specified attribute. More...

(void)	- addAttributeWithName:stringValue:
	Adds the specified attribute with the specified string value. More...

(void)	- addAttributeWithName:namespace:stringValue:
	Adds the specified attribute with the specified namespace and string value. More...

(nullable OFXMLAttribute *)	- attributeForName:
	Returns the attribute with the specified name. More...

(nullable OFXMLAttribute *)	- attributeForName:namespace:
	Returns the attribute with the specified name and namespace. More...

(void)	- removeAttributeForName:
	Removes the attribute with the specified name. More...

(void)	- removeAttributeForName:namespace:
	Removes the attribute with the specified name and namespace. More...

(void)	- setChildren:
	Removes all children and adds the children from the specified array. More...

(nullable OFArray *)	- children
	Returns an array of OFXMLNodes with all children of the element. More...

(void)	- addChild:
	Adds a child to the OFXMLElement. More...

(void)	- insertChild:atIndex:
	Inserts a child at the specified index. More...

(void)	- insertChildren:atIndex:
	Inserts the specified children at the specified index. More...

(void)	- removeChild:
	Removes the first child that is equal to the specified OFXMLNode. More...

(void)	- removeChildAtIndex:
	Removes the child at the specified index. More...

(void)	- replaceChild:withNode:
	Replaces the first child that is equal to the specified OFXMLNode with the specified node. More...

(void)	- replaceChildAtIndex:withNode:
	Replaces the child at the specified index with the specified node. More...

(OFArray *)	- elements
	Returns all children that are elements. More...

(OFArray *)	- elementsForNamespace:
	Returns all children that have the specified namespace. More...

(nullable OFXMLElement *)	- elementForName:
	Returns the first child element with the specified name. More...

(OFArray *)	- elementsForName:
	Returns the child elements with the specified name. More...

(nullable OFXMLElement *)	- elementForName:namespace:
	Returns the first child element with the specified name and namespace. More...

(OFArray *)	- elementsForName:namespace:
	Returns the child elements with the specified name and namespace. More...

(id)	- objectByDeserializing
	Deserializes the receiver into an object. More...

Instance Methods inherited from OFXMLNode
(OFString *)	- stringValue
	Returns the contents of the receiver as a string value. More...

(void)	- setStringValue:
	Sets the string value of the receiver to the specified string. More...

(intmax_t)	- decimalValue
	Returns the contents of the receiver as a decimal value. More...

(uintmax_t)	- hexadecimalValue
	Returns the contents of the receiver as a hexadecimal value. More...

(float)	- floatValue
	Returns the contents of the receiver as a float value. More...

(double)	- doubleValue
	Returns the contents of the receiver as a double value. More...

(OFString *)	- XMLString
	Returns an OFString representing the OFXMLNode as an XML string. More...

(OFString *)	- XMLStringWithIndentation:
	Returns an OFString representing the OFXMLNode as an XML string with indentation. More...

(OFString *)	- XMLStringWithIndentation:level:
	Returns an OFString representing the OFXMLNode as an XML string with indentation for the specified level. More...

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...

(OFString *)	- className
	Returns the name of the object's class. More...

(OFString *)	- description
	Returns a description for the object. More...

(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(nullable void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...

(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...

(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...

Instance Methods inherited from <OFObject>
(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...

(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...

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object. More...

Instance Methods inherited from <OFSerialization>
(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element. More...

Class Methods
(instancetype)	+ elementWithName:
	Creates a new XML element with the specified name. More...

(instancetype)	+ elementWithName:stringValue:
	Creates a new XML element with the specified name and string value. More...

(instancetype)	+ elementWithName:namespace:
	Creates a new XML element with the specified name and namespace. More...

(instancetype)	+ elementWithName:namespace:stringValue:
	Creates a new XML element with the specified name, namespace and string value. More...

(instancetype)	+ elementWithElement:
	Creates a new element with the specified element. More...

(instancetype)	+ elementWithXMLString:
	Parses the string and returns an OFXMLElement for it. More...

(instancetype)	+ elementWithFile:
	Parses the specified file and returns an OFXMLElement for it. More...

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(id)	+ new
	Allocates memory for a new instance and calls init on it. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(nullable Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...

(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(BOOL)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(BOOL)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Properties
OFString *	name

	nonatomic

Detailed Description

A class which stores an XML element.

Method Documentation

◆ addAttribute:()

- (void) addAttribute: (OFXMLAttribute *) attribute

Adds the specified attribute.

If an attribute with the same name and namespace already exists, it is not added.

Parameters

attribute The attribute to add

◆ addAttributeWithName:namespace:stringValue:()

- (void) addAttributeWithName:	(OFString *)	name
namespace:	(nullable OFString *)	namespace_
stringValue:	(OFString *)	stringValue

Adds the specified attribute with the specified namespace and string value.

If an attribute with the same name and namespace already exists, it is not added.

Parameters

name	The name of the attribute
namespace_	The namespace of the attribute
stringValue	The value of the attribute

◆ addAttributeWithName:stringValue:()

- (void) addAttributeWithName:	(OFString *)	name
stringValue:	(OFString *)	stringValue

Adds the specified attribute with the specified string value.

If an attribute with the same name and namespace already exists, it is not added.

Parameters

name	The name of the attribute
stringValue	The value of the attribute

◆ addChild:()

- (void) addChild: (OFXMLNode *) child

Adds a child to the OFXMLElement.

Parameters

child An OFXMLNode which is added as a child

◆ attributeForName:()

- (OFXMLAttribute *) attributeForName: (OFString *) attributeName

Returns the attribute with the specified name.

Parameters

attributeName The name of the attribute

Returns: The attribute with the specified name

◆ attributeForName:namespace:()

- (nullable OFXMLAttribute *) attributeForName:	(OFString *)	attributeName
namespace:	(nullable OFString *)	attributeNS

Returns the attribute with the specified name and namespace.

Parameters

attributeName	The name of the attribute
attributeNS	The namespace of the attribute

Returns: The attribute with the specified name and namespace

◆ attributes()

- (OFArray *) attributes

Returns an OFArray with the attributes of the element.

Returns: An OFArray with the attributes of the element

◆ bindPrefix:forNamespace:()

- (void) bindPrefix:	(OFString *)	prefix
forNamespace:	(OFString *)	namespace_

Binds a prefix for a namespace.

Parameters

prefix	The prefix for the namespace
namespace_	The namespace for which the prefix is bound

◆ children()

- (OFArray *) children

Returns an array of OFXMLNodes with all children of the element.

Returns: An array of OFXMLNodes with all children of the element

◆ elementForName:()

- (OFXMLElement *) elementForName: (OFString *) elementName

Returns the first child element with the specified name.

Parameters

elementName The name of the element

Returns: The first child element with the specified name

◆ elementForName:namespace:()

- (nullable OFXMLElement *) elementForName:	(OFString *)	elementName
namespace:	(nullable OFString *)	elementNS

Returns the first child element with the specified name and namespace.

Parameters

elementName	The name of the element
elementNS	The namespace of the element

Returns: The first child element with the specified name and namespace

◆ elements()

- (OFArray *) elements

Returns all children that are elements.

Returns: All children that are elements

◆ elementsForName:()

- (OFArray *) elementsForName: (OFString *) elementName

Returns the child elements with the specified name.

Parameters

elementName The name of the elements

Returns: The child elements with the specified name

◆ elementsForName:namespace:()

- (OFArray *) elementsForName:	(OFString *)	elementName
namespace:	(nullable OFString *)	elementNS

Returns the child elements with the specified name and namespace.

Parameters

elementName	The name of the elements
elementNS	The namespace of the elements

Returns: The child elements with the specified name and namespace

◆ elementsForNamespace:()

- (OFArray *) elementsForNamespace: (nullable OFString *) elementNS

Returns all children that have the specified namespace.

Returns: All children that have the specified namespace

◆ elementWithElement:()

+ (instancetype) elementWithElement: (OFXMLElement *) element

Creates a new element with the specified element.

Parameters

element An OFXMLElement to initialize the OFXMLElement with

Returns: A new autoreleased OFXMLElement with the contents of the specified element

◆ elementWithFile:()

+ (instancetype) elementWithFile: (OFString *) path

Parses the specified file and returns an OFXMLElement for it.

Parameters

path	The path to the file

Returns: A new autoreleased OFXMLElement with the contents of the specified file

◆ elementWithName:()

+ (instancetype) elementWithName: (OFString *) name

Creates a new XML element with the specified name.

Parameters

name	The name for the element

Returns: A new autoreleased OFXMLElement with the specified element name

◆ elementWithName:namespace:()

+ (instancetype) elementWithName:	(OFString *)	name
namespace:	(nullable OFString *)	namespace_

Creates a new XML element with the specified name and namespace.

Parameters

name	The name for the element
namespace_	The namespace for the element

Returns: A new autoreleased OFXMLElement with the specified element name and namespace

◆ elementWithName:namespace:stringValue:()

+ (instancetype) elementWithName:	(OFString *)	name
namespace:	(nullable OFString *)	namespace_
stringValue:	(nullable OFString *)	stringValue

Creates a new XML element with the specified name, namespace and string value.

Parameters

name	The name for the element
namespace_	The namespace for the element
stringValue	The value for the element

Returns: A new autoreleased OFXMLElement with the specified element name, namespace and value

◆ elementWithName:stringValue:()

+ (instancetype) elementWithName:	(OFString *)	name
stringValue:	(nullable OFString *)	stringValue

Creates a new XML element with the specified name and string value.

Parameters

name	The name for the element
stringValue	The value for the element

Returns: A new autoreleased OFXMLElement with the specified element name and value

◆ elementWithXMLString:()

+ (instancetype) elementWithXMLString: (OFString *) string

Parses the string and returns an OFXMLElement for it.

Parameters

string The string to parse

Returns: A new autoreleased OFXMLElement with the contents of the string

◆ initWithElement:()

- (id) initWithElement: (OFXMLElement *) element

Initializes an already allocated OFXMLElement with the specified element.

Parameters

element An OFXMLElement to initialize the OFXMLElement with

Returns: A new autoreleased OFXMLElement with the contents of the specified element

◆ initWithFile:()

- (id) initWithFile: (OFString *) path

Parses the specified file and initializes an already allocated OFXMLElement with it.

Parameters

path	The path to the file

Returns: An initialized OFXMLElement with the contents of the specified file

◆ initWithName:()

- (id) initWithName: (OFString *) name

Initializes an already allocated OFXMLElement with the specified name.

Parameters

name	The name for the element

Returns: An initialized OFXMLElement with the specified element name

◆ initWithName:namespace:()

- (id) initWithName:	(OFString *)	name
namespace:	(nullable OFString *)	namespace_

Initializes an already allocated OFXMLElement with the specified name and namespace.

Parameters

name	The name for the element
namespace_	The namespace for the element

Returns: An initialized OFXMLElement with the specified element name and namespace

◆ initWithName:namespace:stringValue:()

- (id) initWithName:	(OFString *)	name
namespace:	(nullable OFString *)	namespace_
stringValue:	(nullable OFString *)	stringValue

Initializes an already allocated OFXMLElement with the specified name, namespace and value.

Parameters

name	The name for the element
namespace_	The namespace for the element
stringValue	The value for the element

Returns: An initialized OFXMLElement with the specified element name, namespace and value

◆ initWithName:stringValue:()

- (id) initWithName:	(OFString *)	name
stringValue:	(nullable OFString *)	stringValue

Initializes an already allocated OFXMLElement with the specified name and string value.

Parameters

name	The name for the element
stringValue	The value for the element

Returns: An initialized OFXMLElement with the specified element name and value

◆ initWithSerialization:()

- (id) initWithSerialization: (OFXMLElement *) element

Initializes the object with the specified XML element serialization.

Parameters

element An OFXMLElement with the serialized object

Returns: An initialized object

Reimplemented from OFXMLNode.

◆ initWithXMLString:()

- (id) initWithXMLString: (OFString *) string

Parses the string and initializes an already allocated OFXMLElement with it.

Parameters

string The string to parse

Returns: An initialized OFXMLElement with the contents of the string

◆ insertChild:atIndex:()

- (void) insertChild:	(OFXMLNode *)	child
atIndex:	(size_t)	index

Inserts a child at the specified index.

Parameters

child	An OFXMLNode which is added as a child
index	The index where the child is added

◆ insertChildren:atIndex:()

- (void) insertChildren:	(OFArray *)	children
atIndex:	(size_t)	index

Inserts the specified children at the specified index.

Parameters

children	An array of OFXMLNodes which are added as children
index	The index where the child is added

◆ objectByDeserializing()

- (id) objectByDeserializing

Deserializes the receiver into an object.

Returns: The deserialized object

◆ removeAttributeForName:()

- (void) removeAttributeForName: (OFString *) attributeName

Removes the attribute with the specified name.

Parameters

attributeName The name of the attribute

◆ removeAttributeForName:namespace:()

- (void) removeAttributeForName:	(OFString *)	attributeName
namespace:	(nullable OFString *)	attributeNS

Removes the attribute with the specified name and namespace.

Parameters

attributeName	The name of the attribute
attributeNS	The namespace of the attribute

◆ removeChild:()

- (void) removeChild: (OFXMLNode *) child

Removes the first child that is equal to the specified OFXMLNode.

Parameters

child The child to remove from the OFXMLElement

◆ removeChildAtIndex:()

- (void) removeChildAtIndex: (size_t) index

Removes the child at the specified index.

Parameters

index The index of the child to remove

◆ replaceChild:withNode:()

- (void) replaceChild:	(OFXMLNode *)	child
withNode:	(OFXMLNode *)	node

Replaces the first child that is equal to the specified OFXMLNode with the specified node.

Parameters

child	The child to replace
node	The node to replace the child with

◆ replaceChildAtIndex:withNode:()

- (void) replaceChildAtIndex:	(size_t)	index
withNode:	(OFXMLNode *)	node

Replaces the child at the specified index with the specified node.

Parameters

index	The index of the child to replace
node	The node to replace the child with

◆ setChildren:()

- (void) setChildren: (nullable OFArray *) children

Removes all children and adds the children from the specified array.

Parameters

children The new children to add

◆ setPrefix:forNamespace:()

- (void) setPrefix:	(OFString *)	prefix
forNamespace:	(OFString *)	namespace_

Sets a prefix for a namespace.

Parameters

prefix	The prefix for the namespace
namespace_	The namespace for which the prefix is set

Property Documentation

◆ name

- (OFString*) name

readwritenonatomiccopy

The name of the element.

◆ nonatomic

- nonatomic

readwriteatomic

The namespace of the element.

The default namespace for the element to be used if there is no parent.

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

src/OFXMLElement.h
src/OFXMLElement.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ addAttribute:()

◆ addAttributeWithName:namespace:stringValue:()

◆ addAttributeWithName:stringValue:()

◆ addChild:()

◆ attributeForName:()

◆ attributeForName:namespace:()

◆ attributes()

◆ bindPrefix:forNamespace:()

◆ children()

◆ elementForName:()

◆ elementForName:namespace:()

◆ elements()

◆ elementsForName:()

◆ elementsForName:namespace:()

◆ elementsForNamespace:()

◆ elementWithElement:()

◆ elementWithFile:()

◆ elementWithName:()

◆ elementWithName:namespace:()

◆ elementWithName:namespace:stringValue:()

◆ elementWithName:stringValue:()

◆ elementWithXMLString:()

◆ initWithElement:()

◆ initWithFile:()

◆ initWithName:()

◆ initWithName:namespace:()

◆ initWithName:namespace:stringValue:()

◆ initWithName:stringValue:()

◆ initWithSerialization:()

◆ initWithXMLString:()

◆ insertChild:atIndex:()

◆ insertChildren:atIndex:()

◆ objectByDeserializing()

◆ removeAttributeForName:()

◆ removeAttributeForName:namespace:()

◆ removeChild:()

◆ removeChildAtIndex:()

◆ replaceChild:withNode:()

◆ replaceChildAtIndex:withNode:()

◆ setChildren:()

◆ setPrefix:forNamespace:()

Property Documentation

◆ name

◆ nonatomic