com.sap.cloud.server.odata.xml

Class XmlDocument

java.lang.Object

com.sap.cloud.server.odata.xml.XmlDocument

public class XmlDocument
extends java.lang.Object

Represents an XML document.

Constructor Summary

Constructors

Constructor and Description
XmlDocument()

Method Summary

Modifier and Type	Method and Description
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 document to a buffer.
java.lang.String	getDeclaration() Return (nullable) The XML declaration, or null.
XmlProcessingInstructionList	getProcessingInstructions() Return the XML processing instructions (if any).
XmlElement	getRootElement() Return the document root element.
boolean	getWasDecompressed() Return was this document parsed from a compressed XML?
static XmlDocument	parse(java.lang.String xml) Parse a string to a document.
static XmlDocument	parseMixed(java.lang.String xml, boolean mixed) Parse a string to a document.
void	resolveNamespaces() Traverse the element hierachy starting at the XmlDocument.rootElement, ensuring that every node has the XmlElement.namespaceURI set according to the "xmlns" attributes and namespace prefixes encountered in the nodes.
void	setDeclaration(java.lang.String value) Set the XML declaration, or null.
void	setProcessingInstructions(XmlProcessingInstructionList value) Set the XML processing instructions (if any).
void	setRootElement(XmlElement value) Set the document root element.
void	setWasDecompressed(boolean value) Set was this document parsed from a compressed XML?
java.lang.String	toString() Return the root element, preceeded by an XML declaration and processing instructions (if any).

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDocument

public XmlDocument()

Method Detail

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 document to a buffer.

See Also:

XmlPretty.

Parameters:

buffer - Buffer to receive textual representation.

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

getDeclaration

public java.lang.String getDeclaration()

Return (nullable) The XML declaration, or null.

Returns:

(nullable) The XML declaration, or null.

getProcessingInstructions

public XmlProcessingInstructionList getProcessingInstructions()

Return the XML processing instructions (if any).

Returns:

The XML processing instructions (if any).

getRootElement

public XmlElement getRootElement()

Return the document root element.

Returns:

The document root element.

getWasDecompressed

public boolean getWasDecompressed()

Return was this document parsed from a compressed XML?

See Also:

XmlCompression.

Returns:

Was this document parsed from a compressed XML?

parse

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

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

See Also:

XmlDocument.parseMixed.

Parameters:

xml - Text to be parsed.

Returns:

Parsed document.

parseMixed

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

Parse a string to a document.

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

resolveNamespaces

public void resolveNamespaces()

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

See Also:

XmlElement.resolveNamespaces.

setDeclaration

public void setDeclaration(java.lang.String value)

Set the XML declaration, or null.

Parameters:

value - The XML declaration, or null.

setProcessingInstructions

public void setProcessingInstructions(XmlProcessingInstructionList value)

Set the XML processing instructions (if any).

Parameters:

value - The XML processing instructions (if any).

setRootElement

public void setRootElement(XmlElement value)

Set the document root element.

Parameters:

value - The document root element.

setWasDecompressed

public void setWasDecompressed(boolean value)

Set was this document parsed from a compressed XML?

See Also:

XmlCompression.

Parameters:

value - Was this document parsed from a compressed XML?

toString

public java.lang.String toString()

Return the root element, preceeded by an XML declaration and processing instructions (if any).

See Also:

XmlElement.toString.

Overrides:

toString in class java.lang.Object

Returns:

The root element, preceeded by an XML declaration and processing instructions (if any).