OFXMLElement Class Reference

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

#import <OFXMLElement.h>

Inheritance diagram for OFXMLElement:

List of all members.

Public Member Functions
(id)	- initWithName:
	Initializes an already allocated OFXMLElement with the specified name.
(id)	- initWithName:stringValue:
	Initializes an already allocated OFXMLElement with the specified name and string value.
(id)	- initWithName:namespace:
	Initializes an already allocated OFXMLElement with the specified name and namespace.
(id)	- initWithName:namespace:stringValue:
	Initializes an already allocated OFXMLElement with the specified name, namespace and value.
(id)	- initWithElement:
	Initializes an already allocated OFXMLElement with the specified element.
(id)	- initWithXMLString:
	Parses the string and initializes an already allocated OFXMLElement with it.
(id)	- initWithFile:
	Parses the specified file and initializes an already allocated OFXMLElement with it.
(void)	- setName:
	Sets the name of the element.
(OFString *)	- name
	Returns the name of the element.
(void)	- setNamespace:
	Sets the namespace of the element.
(OFString *)	- namespace
	Returns the namespace of the element.
(OFArray *)	- attributes
	Returns an OFArray with the attributes of the element.
(void)	- setChildren:
	Removes all children and adds the children from the specified array.
(OFArray *)	- children
	Returns an array of OFXMLNodes with all children of the element.
(void)	- setStringValue:
	Removes all children and sets the string value to the specified string.
(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.
(OFXMLAttribute *)	- attributeForName:
	Returns the attribute with the specified name.
(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)	- setPrefix:forNamespace:
	Sets a prefix for a namespace.
(void)	- bindPrefix:forNamespace:
	Binds a prefix for a namespace.
(void)	- setDefaultNamespace:
	Sets the default namespace for the element to be used if there is no parent.
(void)	- addChild:
	Adds a child to the OFXMLElement.
(void)	- removeChild:
	Removes the first child that is equal to the specified OFXMLElement.
(OFArray *)	- elements
	Returns all children that are elements.
(OFArray *)	- elementsForNamespace:
	Returns all children that have the specified namespace.
(OFXMLElement *)	- elementForName:
	Returns the first child element with the specified name.
(OFArray *)	- elementsForName:
	Returns the child elements with the specified name.
(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.
(id)	- objectByDeserializing
	Deserializes the receiver into an object.
Static Public Member Functions
(id)	+ elementWithName:
	Creates a new XML element with the specified name.
(id)	+ elementWithName:stringValue:
	Creates a new XML element with the specified name and string value.
(id)	+ elementWithName:namespace:
	Creates a new XML element with the specified name and namespace.
(id)	+ elementWithName:namespace:stringValue:
	Creates a new XML element with the specified name, namespace and string value.
(id)	+ elementWithElement:
	Creates a new element with the specified element.
(id)	+ elementWithXMLString:
	Parses the string and returns an OFXMLElement for it.
(id)	+ elementWithFile:
	Parses the specified file and returns an OFXMLElement for it.

---

Detailed Description

A class which stores an XML element.

---

Member Function Documentation

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

- (void) addAttributeWithName:		(OFString*)	name
namespace:		(OFString*)	ns
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
ns	The namespace of the attribute
stringValue	The value of the attribute

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

- (void) addChild:

(OFXMLNode*)

child

Adds a child to the OFXMLElement.

Parameters:

child

An OFXMLNode which is added as a child

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

- (OFXMLAttribute *) attributeForName:		(OFString*)	attributeName
namespace:		(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

- (OFArray*) attributes

Returns an OFArray with the attributes of the element.

Returns:

An OFArray with the attributes of the element

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

Binds a prefix for a namespace.

Parameters:

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

- (OFArray*) children

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

Returns:

An array of OFXMLNodes with all children of the element

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

- (OFXMLElement *) elementForName:		(OFString*)	elementName
namespace:		(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

- (OFArray *) elements

Returns all children that are elements.

Returns:

All children that are elements

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

- (OFArray *) elementsForName:		(OFString*)	elementName
namespace:		(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

- (OFArray *) elementsForNamespace:

(OFString*)

elementNS

Returns all children that have the specified namespace.

Returns:

All children that have the specified namespace

+ (id) 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

+ (id) 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

+ (id) 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

+ (id) elementWithName:		(OFString*)	name
namespace:		(OFString*)	ns

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

Parameters:

name	The name for the element
ns	The namespace for the element

Returns:

A new autoreleased OFXMLElement with the specified element name and namespace

+ (id) elementWithName:		(OFString*)	name
namespace:		(OFString*)	ns
stringValue:		(OFString*)	stringValue

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

Parameters:

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

Returns:

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

+ (id) elementWithName:		(OFString*)	name
stringValue:		(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

+ (id) 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

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

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

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

- (id) initWithName:		(OFString*)	name
namespace:		(OFString*)	ns

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

Parameters:

name	The name for the element
ns	The namespace for the element

Returns:

An initialized OFXMLElement with the specified element name and namespace

- (id) initWithName:		(OFString*)	name
namespace:		(OFString*)	ns
stringValue:		(OFString*)	stringValue

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

Parameters:

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

Returns:

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

- (id) initWithName:		(OFString*)	name
stringValue:		(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

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

- (OFString*) name

Returns the name of the element.

Returns:

The name of the element

- (OFString *) namespace

Returns the namespace of the element.

Returns:

The namespace of the element

- (id) objectByDeserializing

Deserializes the receiver into an object.

Returns:

The deserialized object

- (void) removeAttributeForName:

(OFString*)

attributeName

Removes the attribute with the specified name.

Parameters:

attribteName

The name of the attribute

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

Removes the attribute with the specified name and namespace.

Parameters:

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

Parameters:

child

The child to remove from the OFXMLElement

- (void) setChildren:

(OFArray*)

children

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

Parameters:

children

The new children to add

- (void) setDefaultNamespace:

(OFString*)

ns

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

Parameters:

ns	The default namespace for the element

- (void) setName:

(OFString*)

name

Sets the name of the element.

Parameters:

name	The new name

- (void) setNamespace:

(OFString*)

ns

Sets the namespace of the element.

Parameters:

ns	The new namespace

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

Sets a prefix for a namespace.

Parameters:

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

- (void) setStringValue:

(OFString*)

stringValue

Removes all children and sets the string value to the specified string.

Parameters:

stringValue

The new string value for the element

---

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

• src/OFXMLElement+Serialization.m
• src/OFXMLElement.h
• src/OFXMLElement.m