ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFXMLElement Class Reference

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

#import <ObjFW/OFXMLElement.h>

Inheritance diagram for OFXMLElement:
Inheritance graph
[legend]
Collaboration diagram for OFXMLElement:
Collaboration graph
[legend]

Instance Methods

(instancetype) - initWithName:
 Initializes an already allocated OFXMLElement with the specified name. More...
 
(instancetype) - initWithName:stringValue:
 Initializes an already allocated OFXMLElement with the specified name and string value. More...
 
(instancetype) - initWithName:namespace:
 Initializes an already allocated OFXMLElement with the specified name and namespace. More...
 
(instancetype) - initWithName:namespace:stringValue:
 Initializes an already allocated OFXMLElement with the specified name, namespace and value. More...
 
(instancetype) - initWithElement:
 Initializes an already allocated OFXMLElement with the specified element. More...
 
(instancetype) - initWithXMLString:
 Parses the string and initializes an already allocated OFXMLElement with it. More...
 
(instancetype) - initWithStream:
 Parses the specified stream and initializes an already allocated OFXMLElement with it. More...
 
(instancetype) - 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...
 
(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) - 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 *) - 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...
 
- Instance Methods inherited from OFXMLNode
(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...
 
(long long) - longLongValueWithBase:
 The contents of the receiver as a long long value in the specified base. More...
 
(unsigned long long) - unsignedLongLongValueWithBase:
 The contents of the receiver as an unsigned long long value in the specified base. More...
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object. More...
 
(nullable OFMethodSignature *) - methodSignatureForSelector:
 Returns the method signature for the specified selector. 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:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject: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) - performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject: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) - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject: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...
 
(void) - performSelector:onThread:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject: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...
 
- Instance Methods inherited from <OFObject>
(unsigned long) - hash
 Returns a 32 bit hash for the object. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the object allows weak references. 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...
 
(nullable IMP- methodForSelector:
 Returns the implementation 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...
 
(nullable id- performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(instancetype) - retain
 Increases the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...
 
(instancetype) - self
 Returns the receiver. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 
- Instance Methods inherited from <OFCopying>
(id- copy
 Copies the object. 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) + elementWithStream:
 Parses the specified stream 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...
 
(instancetype) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(instancetype) + new
 Calls alloc on self and then init on the returned object. 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 OFMethodSignature *) + instanceMethodSignatureForSelector:
 Returns the method signature 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...
 
(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

OFStringname
 The name of the element.
 
OFStringdefaultNamespace
 The namespace of the element. More...
 
OFArrayattributes
 An array with the attributes of the element.
 
OFArraychildren
 An array of OFXMLNodes with all children of the element.
 
OFArrayelements
 All children that are elements.
 
id objectByDeserializing
 The XML element interpreted as serialization and parsed into an object.
 
- Properties inherited from OFXMLNode
OFStringstringValue
 The contents of the node as a string value. More...
 
long long longLongValue
 The contents of the receiver as a long long value.
 
unsigned long long unsignedLongLongValue
 The contents of the receiver as an unsigned long long value.
 
float floatValue
 The contents of the receiver as a float value.
 
double doubleValue
 The contents of the receiver as a double value.
 
OFStringXMLString
 A string representing the node as an XML string.
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object. More...
 
OFStringstringBySerializing
 The object serialized as a string.
 
- Properties inherited from <OFSerialization>
OFXMLElementXMLElementBySerializing
 The object serialized into an XML element.
 

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
attributeThe 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
nameThe name of the attribute
namespace_The namespace of the attribute
stringValueThe 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
nameThe name of the attribute
stringValueThe value of the attribute

◆ addChild:

- (void) addChild: (OFXMLNode *)  child

Adds a child to the OFXMLElement.

Parameters
childAn OFXMLNode which is added as a child

◆ attributeForName:

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

Returns the attribute with the specified name.

Parameters
attributeNameThe 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
attributeNameThe name of the attribute
attributeNSThe namespace of the attribute
Returns
The attribute with the specified name and namespace

◆ bindPrefix:forNamespace:

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

Binds a prefix for a namespace.

Parameters
prefixThe prefix for the namespace
namespace_The namespace for which the prefix is bound

◆ elementForName:

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

Returns the first child element with the specified name.

Parameters
elementNameThe 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
elementNameThe name of the element
elementNSThe namespace of the element
Returns
The first child element with the specified name and namespace

◆ elementsForName:

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

Returns the child elements with the specified name.

Parameters
elementNameThe 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
elementNameThe name of the elements
elementNSThe 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
elementAn OFXMLElement to initialize the OFXMLElement with
Returns
A new autoreleased OFXMLElement with the contents of the specified element

◆ elementWithName:

+ (instancetype) elementWithName: (OFString *)  name

Creates a new XML element with the specified name.

Parameters
nameThe 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
nameThe 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
nameThe name for the element
namespace_The namespace for the element
stringValueThe 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
nameThe name for the element
stringValueThe value for the element
Returns
A new autoreleased OFXMLElement with the specified element name and value

◆ elementWithStream:

+ (instancetype) elementWithStream: (OFStream *)  stream

Parses the specified stream and returns an OFXMLElement for it.

Parameters
streamThe stream to parse
Returns
A new autoreleased OFXMLElement with the contents of the specified stream

◆ elementWithXMLString:

+ (instancetype) elementWithXMLString: (OFString *)  string

Parses the string and returns an OFXMLElement for it.

Parameters
stringThe string to parse
Returns
A new autoreleased OFXMLElement with the contents of the string

◆ initWithElement:

- (instancetype) initWithElement: (OFXMLElement *)  element

Initializes an already allocated OFXMLElement with the specified element.

Parameters
elementAn OFXMLElement to initialize the OFXMLElement with
Returns
A new autoreleased OFXMLElement with the contents of the specified element

◆ initWithName:

- (instancetype) initWithName: (OFString *)  name

Initializes an already allocated OFXMLElement with the specified name.

Parameters
nameThe name for the element
Returns
An initialized OFXMLElement with the specified element name

◆ initWithName:namespace:

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

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

Parameters
nameThe name for the element
namespace_The namespace for the element
Returns
An initialized OFXMLElement with the specified element name and namespace

◆ initWithName:namespace:stringValue:

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

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

Parameters
nameThe name for the element
namespace_The namespace for the element
stringValueThe value for the element
Returns
An initialized OFXMLElement with the specified element name, namespace and value

◆ initWithName:stringValue:

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

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

Parameters
nameThe name for the element
stringValueThe value for the element
Returns
An initialized OFXMLElement with the specified element name and value

◆ initWithSerialization:

- (instancetype) initWithSerialization: (OFXMLElement *)  element

Initializes the object with the specified XML element serialization.

Parameters
elementAn OFXMLElement with the serialized object
Returns
An initialized object

Reimplemented from OFXMLNode.

◆ initWithStream:

- (instancetype) initWithStream: (OFStream *)  stream

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

Parameters
streamThe stream to parse
Returns
An initialized OFXMLElement with the contents of the specified stream

◆ initWithXMLString:

- (instancetype) initWithXMLString: (OFString *)  string

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

Parameters
stringThe 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
childAn OFXMLNode which is added as a child
indexThe 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
childrenAn array of OFXMLNodes which are added as children
indexThe index where the child is added

◆ removeAttributeForName:

- (void) removeAttributeForName: (OFString *)  attributeName

Removes the attribute with the specified name.

Parameters
attributeNameThe name of the attribute

◆ removeAttributeForName:namespace:

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

Removes the attribute with the specified name and namespace.

Parameters
attributeNameThe name of the attribute
attributeNSThe namespace of the attribute

◆ removeChild:

- (void) removeChild: (OFXMLNode *)  child

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

Parameters
childThe child to remove from the OFXMLElement

◆ removeChildAtIndex:

- (void) removeChildAtIndex: (size_t)  index

Removes the child at the specified index.

Parameters
indexThe 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
childThe child to replace
nodeThe 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
indexThe index of the child to replace
nodeThe node to replace the child with

◆ setPrefix:forNamespace:

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

Sets a prefix for a namespace.

Parameters
prefixThe prefix for the namespace
namespace_The namespace for which the prefix is set

Property Documentation

◆ defaultNamespace

- (OFString*) defaultNamespace
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: