com.sap.cloud.server.odata.xml

Class XmlElement

java.lang.Object

com.sap.cloud.server.odata.xml.XmlNode

com.sap.cloud.server.odata.xml.XmlElement

public class XmlElement
extends XmlNode

Represents an XML element node.

Field Summary

Fields inherited from class com.sap.cloud.server.odata.xml.XmlNode

TYPE_COMMENT, TYPE_ELEMENT, TYPE_PROCESSING_INSTRUCTION, TYPE_TEXT

Constructor Summary

Constructors

Constructor and Description
XmlElement()

Method Summary

Modifier and Type	Method and Description
XmlElement	addAttribute(java.lang.String name, java.lang.String value) Add an attribute to this element.
XmlElement	addAttributeWithQName(XmlName name, java.lang.String value) Add an attribute to this element.
XmlElement	addChild(XmlNode child) Add a child node to this element.
XmlElement	addComment(java.lang.String text) Add a comment node to this element.
XmlElement	addElement(XmlElement child) Add an element node to this element.
XmlElement	addElements(XmlElementList elements) Add a list of elements to this element.
XmlElement	addText(java.lang.String text) Add a text node to this element.
void	appendTo(com.sap.cloud.server.odata.core.CharBuffer buffer) See appendTo(CharBuffer, int).
void	appendTo(com.sap.cloud.server.odata.core.CharBuffer buffer, int indent) Append the textual representation of this element to a buffer.
XmlElementList	elementsNamed(java.lang.String name) Lookup all child elements with a specified name.
java.lang.String	getAttribute(java.lang.String name) Lookup the value for the attribute with a specified name.
XmlAttributeList	getAttributes() Return list of attributes for this element.
XmlNodeList	getChildNodes() Return list of child nodes for this element.
XmlCommentList	getComments() Return a list of the comment nodes in this element.
XmlElement	getElement(java.lang.String name) Lookup first child element with a specified name.
XmlElementList	getElements() Return a list of the element nodes in this element.
int	getLineNumber() Return line number (starting at 1) if this element was parsed from a file.
java.lang.String	getLocalName() Return local element name, without namespace prefix, e.g.
java.lang.String	getName() Return element name, possibly qualified by namespace prefix, e.g.
java.lang.String	getNamespaceURI() Return (nullable) Namespace URI, if known.
java.lang.String	getPrefix() Return (nullable) Optional namespace prefix, e.g.
java.lang.String	getRequiredAttribute(java.lang.String name) Lookup the value for the attribute with a specified name.
XmlElement	getRequiredElement(java.lang.String name) Lookup first child element with a specified name.
java.lang.String	getSourceFile() Return (nullable) Source file name (if available).
java.lang.String	getText() Return a combination of all the text nodes in this element.
int	getType() Return XmlNode.TYPE_ELEMENT.
boolean	hasPrefix() Return is XmlElement.prefix non-null?
static XmlElement	parse(java.lang.String xml) Parse a string to an element.
static XmlElement	parseMixed(java.lang.String xml) See parseMixed(String, boolean).
static XmlElement	parseMixed(java.lang.String xml, boolean mixed) Parse a string to an element.
void	removeAttribute(java.lang.String name) Remove the value for the attribute with a specified name.
void	resolveNamespaces() Traverse the element hierachy starting at this element, ensuring that every node has the XmlElement.namespaceURI set according to the "xmlns" attributes and namespace prefixes encountered in the nodes.
XmlElement	setAttribute(java.lang.String name, java.lang.String value) Set an attribute of this element (replace attribute value if the attribute is already defined, otherwise add the attribute).
void	setAttributes(XmlAttributeList value) Set list of attributes for this element.
XmlElement	setAttributeWithQName(XmlName name, java.lang.String value) Set an attribute of this element (replace attribute value if the attribute is already defined, otherwise add the attribute).
void	setChildNodes(XmlNodeList value) Set list of child nodes for this element.
void	setLineNumber(int value) Set line number (starting at 1) if this element was parsed from a file.
void	setLocalName(java.lang.String value) Set local element name, without namespace prefix, e.g.
void	setName(java.lang.String value) Set element name, possibly qualified by namespace prefix, e.g.
void	setNamespaceURI(java.lang.String value) Set namespace URI, if known.
void	setPrefix(java.lang.String value) Set optional namespace prefix, e.g.
void	setSourceFile(java.lang.String value) Set source file name (if available).
java.lang.String	toString() Return the element, without an XML declaration.
static XmlElement	withName(java.lang.String name) Convenience function for constructing an element node with specified name.
static XmlElement	withQName(XmlName name) Convenience function for constructing an element node with specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlElement

public XmlElement()

Method Detail

addAttribute

public XmlElement addAttribute(java.lang.String name,
                               java.lang.String value)

Add an attribute to this element.

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

This element.

addAttributeWithQName

public XmlElement addAttributeWithQName(XmlName name,
                                        java.lang.String value)

Add an attribute to this element.

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

This element.

addChild

public XmlElement addChild(XmlNode child)

Add a child node to this element.

See Also:

XmlElement.childNodes.

Parameters:

child - Child node.

Returns:

This element.

addComment

public XmlElement addComment(java.lang.String text)

Add a comment node to this element.

See Also:

XmlElement.childNodes.

Parameters:

text - Comment text.

Returns:

This element.

addElement

public XmlElement addElement(XmlElement child)

Add an element node to this element.

See Also:

XmlElement.childNodes.

Parameters:

child - Child element.

Returns:

This element.

addElements

public XmlElement addElements(XmlElementList elements)

Add a list of elements to this element.

See Also:

XmlElement.childNodes.

Parameters:

elements - Child elements.

Returns:

This element.

addText

public XmlElement addText(java.lang.String text)

Add a text node to this element.

See Also:

XmlElement.childNodes.

Parameters:

text - Text value.

Returns:

This element.

appendTo

public void appendTo(com.sap.cloud.server.odata.core.CharBuffer buffer)

See appendTo(CharBuffer, int).

Parameters:

buffer - Buffer parameter.

appendTo

public void appendTo(com.sap.cloud.server.odata.core.CharBuffer buffer,
                     int indent)

Append the textual representation of this element to a buffer.

See Also:

XmlPretty.

Parameters:

buffer - Buffer to receive textual representation.

indent - Indent level for indented pretty-printing. Pass -1 to disable pretty-printing.

elementsNamed

public XmlElementList elementsNamed(java.lang.String name)

Lookup all child elements with a specified name.

See Also:

XmlElement.childNodes, XmlElement.elements.

Parameters:

name - Element name, to be compared with XmlElement.name and XmlElement.localName of child elements when matching.

Returns:

The matching element nodes. An empty list is returned if no matches are found.

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Lookup the value for the attribute with a specified name.

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name, to be compared with XmlElement.name and XmlElement.localName of attributes when matching.

Returns:

(nullable) The matching attribute value, or `null` if no match is found.

getAttributes

public XmlAttributeList getAttributes()

Return list of attributes for this element.

Returns:

List of attributes for this element.

getChildNodes

public XmlNodeList getChildNodes()

Return list of child nodes for this element.

Returns:

List of child nodes for this element.

getComments

public XmlCommentList getComments()

Return a list of the comment nodes in this element. Note: the list is recalculated every time this property is accessed. For best performance, callers are advised to save the resulting value if it will be used multiple times.

Returns:

A list of the comment nodes in this element.

getElement

public XmlElement getElement(java.lang.String name)

Lookup first child element with a specified name.

See Also:

XmlElement.childNodes, XmlElement.elements.

Parameters:

name - Element name, to be compared with XmlElement.name and XmlElement.localName of child elements when matching.

Returns:

(nullable) The matching child element. A `null` element is returned if no match is found.

getElements

public XmlElementList getElements()

Return a list of the element nodes in this element. Note: the list is recalculated every time this property is accessed. For best performance, callers are advised to save the resulting value if it will be used multiple times.

Returns:

A list of the element nodes in this element.

getLineNumber

public int getLineNumber()

Return line number (starting at 1) if this element was parsed from a file. Otherwise zero.

Returns:

Line number (starting at 1) if this element was parsed from a file. Otherwise zero.

getLocalName

public java.lang.String getLocalName()

Return local element name, without namespace prefix, e.g. "MyElement".

Returns:

Local element name, without namespace prefix, e.g. "MyElement".

getName

public java.lang.String getName()

Return element name, possibly qualified by namespace prefix, e.g. "MyElement" or "myns:MyElement".

Returns:

Element name, possibly qualified by namespace prefix, e.g. "MyElement" or "myns:MyElement".

getNamespaceURI

public java.lang.String getNamespaceURI()

Return (nullable) Namespace URI, if known. Will not be valid unless XmlElement.resolveNamespaces has been called for the element hierarchy containing this element.

See Also:

XmlElement.resolveNamespaces.

Returns:

(nullable) Namespace URI, if known. Will not be valid unless XmlElement.resolveNamespaces has been called for the element hierarchy containing this element.

getPrefix

public java.lang.String getPrefix()

Return (nullable) Optional namespace prefix, e.g. "myns" or null.

Returns:

(nullable) Optional namespace prefix, e.g. "myns" or null.

getRequiredAttribute

public java.lang.String getRequiredAttribute(java.lang.String name)

Lookup the value for the attribute with a specified name.

Throws:

XmlException if no match is found.

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name, to be compared with XmlElement.name and XmlElement.localName of attributes when matching.

Returns:

The matching attribute value.

getRequiredElement

public XmlElement getRequiredElement(java.lang.String name)

Lookup first child element with a specified name.

Throws:

XmlException if no match is found.

See Also:

XmlElement.childNodes, XmlElement.elements.

Parameters:

name - Element name, to be compared with XmlElement.name and XmlElement.localName of child elements when matching.

Returns:

The matching child element.

getSourceFile

public java.lang.String getSourceFile()

Return (nullable) Source file name (if available). Otherwise null.

Returns:

(nullable) Source file name (if available). Otherwise null.

getText

public java.lang.String getText()

Return a combination of all the text nodes in this element. Note: the text is recalculated every time this property is accessed. For best performance, callers are advised to save the resulting value if it will be used multiple times.

Returns:

A combination of all the text nodes in this element.

getType

public int getType()

Return XmlNode.TYPE_ELEMENT.

Specified by:

getType in class XmlNode

Returns:

XmlNode.TYPE_ELEMENT.

hasPrefix

public boolean hasPrefix()

Return is XmlElement.prefix non-null?

Returns:

Is XmlElement.prefix non-null?

parse

public static XmlElement parse(java.lang.String xml)

Parse a string to an element. Equivalent to parseMixed(xml, false)

See Also:

XmlElement.parseMixed.

Parameters:

xml - Text to be parsed.

Returns:

Parsed element.

parseMixed

public static XmlElement parseMixed(java.lang.String xml)

See parseMixed(String, boolean).

Parameters:

xml - Xml parameter.

Returns:

(see linked method).

parseMixed

public static XmlElement parseMixed(java.lang.String xml,
                                    boolean mixed)

Parse a string to an element.

Parameters:

xml - Text to be parsed.

mixed - true if mixed content is permitted, false otherwise. Parsing may be faster with mixed = false, since text nodes can be omitted from elements which have non-text content.

Returns:

Parsed element.

removeAttribute

public void removeAttribute(java.lang.String name)

Remove the value for the attribute with a specified name.

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name, to be compared with XmlElement.name and XmlElement.localName of attributes when matching.

resolveNamespaces

public void resolveNamespaces()

Traverse the element hierachy starting at this element, ensuring that every node has the XmlElement.namespaceURI set according to the "xmlns" attributes and namespace prefixes encountered in the nodes.

setAttribute

public XmlElement setAttribute(java.lang.String name,
                               java.lang.String value)

Set an attribute of this element (replace attribute value if the attribute is already defined, otherwise add the attribute).

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

This element.

setAttributeWithQName

public XmlElement setAttributeWithQName(XmlName name,
                                        java.lang.String value)

Set an attribute of this element (replace attribute value if the attribute is already defined, otherwise add the attribute).

See Also:

XmlElement.attributes.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

This element.

setAttributes

public void setAttributes(XmlAttributeList value)

Set list of attributes for this element.

Parameters:

value - List of attributes for this element.

setChildNodes

public void setChildNodes(XmlNodeList value)

Set list of child nodes for this element.

Parameters:

value - List of child nodes for this element.

setLineNumber

public void setLineNumber(int value)

Set line number (starting at 1) if this element was parsed from a file. Otherwise zero.

Parameters:

value - Line number (starting at 1) if this element was parsed from a file. Otherwise zero.

setLocalName

public void setLocalName(java.lang.String value)

Set local element name, without namespace prefix, e.g. "MyElement".

Parameters:

value - Local element name, without namespace prefix, e.g. "MyElement".

setName

public void setName(java.lang.String value)

Set element name, possibly qualified by namespace prefix, e.g. "MyElement" or "myns:MyElement".

Parameters:

value - Element name, possibly qualified by namespace prefix, e.g. "MyElement" or "myns:MyElement".

setNamespaceURI

public void setNamespaceURI(java.lang.String value)

Set namespace URI, if known. Will not be valid unless XmlElement.resolveNamespaces has been called for the element hierarchy containing this element.

See Also:

XmlElement.resolveNamespaces.

Parameters:

value - Namespace URI, if known. Will not be valid unless XmlElement.resolveNamespaces has been called for the element hierarchy containing this element.

setPrefix

public void setPrefix(java.lang.String value)

Set optional namespace prefix, e.g. "myns" or null.

Parameters:

value - Optional namespace prefix, e.g. "myns" or null.

setSourceFile

public void setSourceFile(java.lang.String value)

Set source file name (if available). Otherwise null.

Parameters:

value - Source file name (if available). Otherwise null.

toString

public java.lang.String toString()

Return the element, without an XML declaration.

See Also:

XmlDocument.toString.

Overrides:

toString in class java.lang.Object

Returns:

The element, without an XML declaration.

withName

public static XmlElement withName(java.lang.String name)

Convenience function for constructing an element node with specified name.

Example

let e = XmlAttribute.withName("e")
     .addAttribute(XmlAttribute.withName("a").andValue("v"))
     .addComment("c")
     .addElement(XmlElement.withName("x"))
     .addText("t");
 

Parameters:

name - The element name.

Returns:

A new XML element node.

withQName

public static XmlElement withQName(XmlName name)

Convenience function for constructing an element node with specified name.

See Also:

XmlElement.withName.

Parameters:

name - The element name.

Returns:

A new XML element node.