|
ObjFW
|
A class which stores an XML element. More...
#import <ObjFW/OFXMLElement.h>
Instance Methods | |
| (instancetype) | - initWithName: |
| Initializes an already allocated OFXMLElement with the specified name. | |
| (instancetype) | - initWithName:stringValue: |
| Initializes an already allocated OFXMLElement with the specified name and string value. | |
| (instancetype) | - initWithName:namespace: |
| Initializes an already allocated OFXMLElement with the specified name and namespace. | |
| (instancetype) | - initWithName:namespace:stringValue: |
| Initializes an already allocated OFXMLElement with the specified name, namespace and value. | |
| (instancetype) | - initWithXMLString: |
| Parses the string and initializes an already allocated OFXMLElement with it. | |
| (instancetype) | - initWithStream: |
| Parses the specified stream and initializes an already allocated OFXMLElement with it. | |
| (void) | - setPrefix:forNamespace: |
| Sets a prefix for a namespace. | |
| (void) | - bindPrefix:forNamespace: |
| Binds a prefix for a namespace. | |
| (void) | - addAttribute: |
| Adds the specified attribute. | |
| (void) | - addAttributeWithName:stringValue: |
| Adds the specified attribute with the specified string value. | |
| (void) | - addAttributeWithName:namespace:stringValue: |
| Adds the specified attribute with the specified namespace and string value. | |
| (nullable OFXMLAttribute *) | - attributeForName: |
| Returns the attribute with the specified name. | |
| (nullable OFXMLAttribute *) | - attributeForName:namespace: |
| Returns the attribute with the specified name and namespace. | |
| (void) | - removeAttributeForName: |
| Removes the attribute with the specified name. | |
| (void) | - removeAttributeForName:namespace: |
| Removes the attribute with the specified name and namespace. | |
| (void) | - addChild: |
| Adds a child to the OFXMLElement. | |
| (void) | - insertChild:atIndex: |
| Inserts a child at the specified index. | |
| (void) | - insertChildren:atIndex: |
| Inserts the specified children at the specified index. | |
| (void) | - removeChild: |
| Removes the first child that is equal to the specified OFXMLNode. | |
| (void) | - removeChildAtIndex: |
| Removes the child at the specified index. | |
| (void) | - replaceChild:withNode: |
| Replaces the first child that is equal to the specified OFXMLNode with the specified node. | |
| (void) | - replaceChildAtIndex:withNode: |
| Replaces the child at the specified index with the specified node. | |
| (OFArray *) | - elementsForNamespace: |
| Returns all children that have the specified namespace. | |
| (nullable OFXMLElement *) | - elementForName: |
| Returns the first child element with the specified name. | |
| (OFArray *) | - elementsForName: |
| Returns the child elements with the specified name. | |
| (nullable OFXMLElement *) | - elementForName:namespace: |
| Returns the first child element with the specified name and namespace. | |
| (OFArray *) | - elementsForName:namespace: |
| Returns the child elements with the specified name and namespace. | |
| (OFString *) | - XMLStringWithIndentation: |
| Returns an OFString representing the OFXMLElement as an XML string with the specified indentation per level. | |
| (OFString *) | - XMLStringWithDefaultNamespace:indentation: |
| Returns an OFString representing the OFXMLElement as an XML string with the specified default namespace and indentation per level. | |
Instance Methods inherited from OFXMLNode | |
| (long long) | - longLongValueWithBase: |
The contents of the receiver as a long long value in the specified base. | |
| (unsigned long long) | - unsignedLongLongValueWithBase: |
The contents of the receiver as an unsigned long long value in the specified base. | |
Instance Methods inherited from OFObject | |
| (instancetype) | - init |
| Initializes an already allocated object. | |
| (nullable OFMethodSignature *) | - methodSignatureForSelector: |
| Returns the method signature for the specified selector. | |
| (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:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject: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) | - performSelector:onThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject: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) | - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject: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. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (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. | |
| (void) | - doesNotRecognizeSelector: |
| Handles messages which are not understood by the receiver. | |
Instance Methods inherited from <OFObject> | |
| (Class) | - class |
| Returns the class of the object. | |
| (nullable Class) | - superclass |
| Returns the superclass of the object. | |
| (unsigned long) | - hash |
| Returns a hash for the object. | |
| (unsigned int) | - retainCount |
| Returns the retain count. | |
| (bool) | - isProxy |
| Returns whether the object is a proxy object. | |
| (bool) | - isKindOfClass: |
| Returns a boolean whether the object is 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. | |
| (bool) | - conformsToProtocol: |
| Checks whether the object conforms to the specified protocol. | |
| (nullable IMP) | - methodForSelector: |
| Returns the implementation for the specified selector. | |
| (nullable id) | - performSelector: |
| Performs the specified selector. | |
| (nullable id) | - performSelector:withObject: |
| Performs the specified selector with the specified object. | |
| (nullable id) | - performSelector:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (bool) | - isEqual: |
| Checks two objects for equality. | |
| (instancetype) | - retain |
| Increases the retain count. | |
| (void) | - release |
| Decreases the retain count. | |
| (instancetype) | - autorelease |
| Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. | |
| (instancetype) | - self |
| Returns the receiver. | |
| (bool) | - allowsWeakReference |
| Returns whether the object allows a weak reference. | |
| (bool) | - retainWeakReference |
| Retain a weak reference to this object. | |
Instance Methods inherited from <OFCopying> | |
| (id) | - copy |
| Copies the object. | |
Class Methods | |
| (instancetype) | + elementWithName: |
| Creates a new XML element with the specified name. | |
| (instancetype) | + elementWithName:stringValue: |
| Creates a new XML element with the specified name and string value. | |
| (instancetype) | + elementWithName:namespace: |
| Creates a new XML element with the specified name and namespace. | |
| (instancetype) | + elementWithName:namespace:stringValue: |
| Creates a new XML element with the specified name, namespace and string value. | |
| (instancetype) | + elementWithXMLString: |
| Parses the string and returns an OFXMLElement for it. | |
| (instancetype) | + elementWithStream: |
| Parses the specified stream and returns an OFXMLElement for it. | |
Class Methods inherited from OFObject | |
| (void) | + load |
| A method which is called once when the class is loaded into the runtime. | |
| (void) | + unload |
| A method which is called when the class is unloaded from the runtime. | |
| (void) | + initialize |
| A method which is called the moment before the first call to the class is being made. | |
| (instancetype) | + alloc |
| Allocates memory for an instance of the class and sets up the memory pool for the object. | |
| (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. | |
| (nullable 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. | |
| (nullable IMP) | + instanceMethodForSelector: |
| Returns the implementation of the instance method for the specified selector. | |
| (nullable OFMethodSignature *) | + instanceMethodSignatureForSelector: |
| Returns the method signature of the instance method for the specified selector. | |
| (OFString *) | + description |
| Returns a description for the class, which is usually the class name. | |
| (nullable IMP) | + replaceClassMethod:withMethodFromClass: |
| Replaces a class method with a class method from another class. | |
| (nullable IMP) | + replaceInstanceMethod:withMethodFromClass: |
| Replaces an instance method with an instance method from another class. | |
| (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. | |
| (id) | + copy |
| Returns the class. | |
Properties | |
| OFString * | name |
| The name of the element. | |
| OFArray * | attributes |
| The namespace of the element. | |
| OFArray * | children |
| An array of OFXMLNodes with all children of the element. | |
| OFArray * | elements |
| All children that are elements. | |
Properties inherited from OFXMLNode | |
| OFString * | stringValue |
| The contents of the node as a string value. | |
| 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. | |
| OFString * | XMLString |
| A string representing the node as an XML string. | |
Properties inherited from OFObject | |
| OFString * | className |
| The name of the object's class. | |
| OFString * | description |
| A description for the object. | |
A class which stores an XML element.
| - (void) addAttribute: | (OFXMLAttribute *) | attribute |
Adds the specified attribute.
If an attribute with the same name and namespace already exists, it is not added.
| attribute | The attribute to add |
| - (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.
| name | The name of the attribute |
| nameSpace | The namespace of the attribute |
| stringValue | The value of the attribute |
Adds the specified attribute with the specified string value.
If an attribute with the same name and namespace already exists, it is not added.
| name | The name of the attribute |
| stringValue | The value of the attribute |
| - (void) addChild: | (OFXMLNode *) | child |
Adds a child to the OFXMLElement.
| child | An OFXMLNode which is added as a child |
| - (OFXMLAttribute *) attributeForName: | (OFString *) | attributeName |
Returns the attribute with the specified name.
| attributeName | The name of the attribute |
| - (nullable OFXMLAttribute *) attributeForName: | (OFString *) | attributeName | |
| namespace: | (nullable OFString *) | attributeNS | |
Returns the attribute with the specified name and namespace.
| attributeName | The name of the attribute |
| attributeNS | The namespace of the attribute |
Binds a prefix for a namespace.
| prefix | The prefix for the namespace |
| nameSpace | The namespace for which the prefix is bound |
| - (OFXMLElement *) elementForName: | (OFString *) | elementName |
Returns the first child element with the specified name.
| elementName | The name of the element |
| - (nullable OFXMLElement *) elementForName: | (OFString *) | elementName | |
| namespace: | (nullable OFString *) | elementNS | |
Returns the first child element with the specified name and namespace.
| elementName | The name of the element |
| elementNS | The namespace of the element |
Returns the child elements with the specified name.
| elementName | The name of the elements |
| - (OFArray *) elementsForName: | (OFString *) | elementName | |
| namespace: | (nullable OFString *) | elementNS | |
Returns the child elements with the specified name and namespace.
| elementName | The name of the elements |
| elementNS | The namespace of the elements |
Returns all children that have the specified namespace.
| + (instancetype) elementWithName: | (OFString *) | name |
Creates a new XML element with the specified name.
| name | The name for the element |
| + (instancetype) elementWithName: | (OFString *) | name | |
| namespace: | (nullable OFString *) | nameSpace | |
Creates a new XML element with the specified name and namespace.
| name | The name for the element |
| nameSpace | The namespace for the element |
| + (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.
| name | The name for the element |
| nameSpace | The namespace for the element |
| stringValue | The value for the element |
| + (instancetype) elementWithName: | (OFString *) | name | |
| stringValue: | (nullable OFString *) | stringValue | |
Creates a new XML element with the specified name and string value.
| name | The name for the element |
| stringValue | The value for the element |
| + (instancetype) elementWithStream: | (OFStream *) | stream |
Parses the specified stream and returns an OFXMLElement for it.
| stream | The stream to parse |
| OFMalformedXMLException | The XML was malformed |
| OFUnboundPrefixException | A prefix was used that was not bound to any namespace |
| OFInvalidEncodingException | The XML is not in the encoding it specified |
| + (instancetype) elementWithXMLString: | (OFString *) | string |
Parses the string and returns an OFXMLElement for it.
| string | The string to parse |
| OFMalformedXMLException | The XML was malformed |
| OFUnboundPrefixException | A prefix was used that was not bound to any namespace |
| OFInvalidEncodingException | The XML is not in the encoding it specified |
| - (instancetype) initWithName: | (OFString *) | name |
Initializes an already allocated OFXMLElement with the specified name.
| name | The name for the element |
| - (instancetype) initWithName: | (OFString *) | name | |
| namespace: | (nullable OFString *) | nameSpace | |
Initializes an already allocated OFXMLElement with the specified name and namespace.
| name | The name for the element |
| nameSpace | The namespace for the element |
| - (instancetype) initWithName: | (OFString *) | name | |
| namespace: | (nullable OFString *) | nameSpace | |
| stringValue: | (nullable OFString *) | stringValue | |
Initializes an already allocated OFXMLElement with the specified name, namespace and value.
| name | The name for the element |
| nameSpace | The namespace for the element |
| stringValue | The value for the element |
| - (instancetype) initWithName: | (OFString *) | name | |
| stringValue: | (nullable OFString *) | stringValue | |
Initializes an already allocated OFXMLElement with the specified name and string value.
| name | The name for the element |
| stringValue | The value for the element |
| - (instancetype) initWithStream: | (OFStream *) | stream |
Parses the specified stream and initializes an already allocated OFXMLElement with it.
| stream | The stream to parse |
| OFMalformedXMLException | The XML was malformed |
| OFUnboundPrefixException | A prefix was used that was not bound to any namespace |
| OFInvalidEncodingException | The XML is not in the encoding it specified |
| - (instancetype) initWithXMLString: | (OFString *) | string |
Parses the string and initializes an already allocated OFXMLElement with it.
| string | The string to parse |
| OFMalformedXMLException | The XML was malformed |
| OFUnboundPrefixException | A prefix was used that was not bound to any namespace |
| OFInvalidEncodingException | The XML is not in the encoding it specified |
| - (void) insertChild: | (OFXMLNode *) | child | |
| atIndex: | (size_t) | index | |
Inserts a child at the specified index.
| child | An OFXMLNode which is added as a child |
| index | The index where the child is added |
| - (void) insertChildren: | (OFArray *) | children | |
| atIndex: | (size_t) | index | |
Inserts the specified children at the specified index.
| children | An array of OFXMLNodes which are added as children |
| index | The index where the child is added |
| - (void) removeAttributeForName: | (OFString *) | attributeName |
Removes the attribute with the specified name.
| attributeName | The name of the attribute |
| - (void) removeAttributeForName: | (OFString *) | attributeName | |
| namespace: | (nullable OFString *) | attributeNS | |
Removes the attribute with the specified name and namespace.
| attributeName | The name of the attribute |
| attributeNS | The namespace of the attribute |
| - (void) removeChild: | (OFXMLNode *) | child |
Removes the first child that is equal to the specified OFXMLNode.
| child | The child to remove from the OFXMLElement |
| - (void) removeChildAtIndex: | (size_t) | index |
Removes the child at the specified index.
| index | The index of the child to remove |
Replaces the first child that is equal to the specified OFXMLNode with the specified node.
| child | The child to replace |
| node | The node to replace the child with |
| - (void) replaceChildAtIndex: | (size_t) | index | |
| withNode: | (OFXMLNode *) | node | |
Replaces the child at the specified index with the specified node.
| index | The index of the child to replace |
| node | The node to replace the child with |
Sets a prefix for a namespace.
| prefix | The prefix for the namespace |
| nameSpace | The namespace for which the prefix is set |
| - (OFString *) XMLStringWithDefaultNamespace: | (OFString *) | defaultNS | |
| indentation: | (unsigned int) | indentation | |
Returns an OFString representing the OFXMLElement as an XML string with the specified default namespace and indentation per level.
| defaultNS | The default namespace |
| indentation | The indentation per level |
| OFUnboundNamespaceException | The node uses a namespace that was not bound to a prefix in a context where it needs a prefix |
| - (OFString *) XMLStringWithIndentation: | (unsigned int) | indentation |
Returns an OFString representing the OFXMLElement as an XML string with the specified indentation per level.
| indentation | The indentation per level |
| OFUnboundNamespaceException | The node uses a namespace that was not bound to a prefix in a context where it needs a prefix |
|
readwriteatomic |
The namespace of the element.
An array with the attributes of the element.