com.sap.cloud.server.odata.xml

Class XmlParser

java.lang.Object

com.sap.cloud.server.odata.xml.XmlParser

public class XmlParser
extends java.lang.Object

Parser for XML. Supports parsing into an XmlDocument or XmlElement. Parsing options are complete (XmlParser.parseDocument, XmlParser.parseElement) and streamed (XmlParser.startDocument, XmlParser.startElement).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlParser.Options XMP parser options

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeclaration() Return (nullable) The parsed XML declaration.
XmlElement	getRootElement() Return the parsed root element.
XmlNode	nextChild(XmlElement element, boolean parseNested) Return (nullable) The next child node of element, or null if element has ended.
XmlElement	nextChildElement(XmlElement element, boolean parseNested) Return (nullable) The next child element of element, or null if element has ended.
XmlElement	nextElement() Assuming an element appears next in the stream, parse its start tag.
static XmlDocument	parseDocument(CharStream stream) See parseDocument(CharStream, boolean, Options).
static XmlDocument	parseDocument(CharStream stream, boolean mixed) See parseDocument(CharStream, boolean, Options).
static XmlDocument	parseDocument(CharStream stream, boolean mixed, XmlParser.Options options) Parse a stream to a document.
XmlElement	parseElement() Return the next element in the stream.
void	readChildren(XmlElement element) Read all of the children of a started element, and read the element's end tag.
void	setDeclaration(java.lang.String value) Set the parsed XML declaration.
void	setRootElement(XmlElement value) Set the parsed root element.
static XmlParser	startDocument(CharStream stream) See startDocument(CharStream, boolean, Options).
static XmlParser	startDocument(CharStream stream, boolean mixed) See startDocument(CharStream, boolean, Options).
static XmlParser	startDocument(CharStream stream, boolean mixed, XmlParser.Options options) Start parsing a stream to a document.
static XmlParser	startElement(CharStream stream) See startElement(CharStream, boolean, Options).
static XmlParser	startElement(CharStream stream, boolean mixed) See startElement(CharStream, boolean, Options).
static XmlParser	startElement(CharStream stream, boolean mixed, XmlParser.Options options) Start parsing a stream to an element.
static XmlElement	static_parseElement(CharStream stream) See static_parseElement(CharStream, boolean, Options).
static XmlElement	static_parseElement(CharStream stream, boolean mixed) See static_parseElement(CharStream, boolean, Options).
static XmlElement	static_parseElement(CharStream stream, boolean mixed, XmlParser.Options options) Parse a stream to an element.

Methods inherited from class java.lang.Object

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

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return (nullable) The parsed XML declaration.

Returns:

(nullable) The parsed XML declaration.

getRootElement

public XmlElement getRootElement()

Return the parsed root element.

Returns:

The parsed root element.

nextChild

public XmlNode nextChild(XmlElement element,
                         boolean parseNested)

Return (nullable) The next child node of element, or null if element has ended.

Parameters:

element - Parent element, which must have already been started.

parseNested - true if child elements should be XmlParser.parseElement, false if they should be XmlParser.startElement.

Returns:

(nullable) The next child node of element, or null if element has ended.

nextChildElement

public XmlElement nextChildElement(XmlElement element,
                                   boolean parseNested)

Return (nullable) The next child element of element, or null if element has ended. Any non-element child nodes (e.g. comment nodes, text nodes) will be ignored.

Parameters:

element - Parent element, which must have already been started.

parseNested - true if child elements should be XmlParser.parseElement, false if they should be XmlParser.startElement.

Returns:

(nullable) The next child element of element, or null if element has ended.

nextElement

public XmlElement nextElement()

Assuming an element appears next in the stream, parse its start tag.

See Also:

XmlParser.startDocument, XmlParser.startElement.

Returns:

Element with only the start tag parsed.

parseDocument

public static XmlDocument parseDocument(CharStream stream)

See parseDocument(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

Returns:

(see linked method).

parseDocument

public static XmlDocument parseDocument(CharStream stream,
                                        boolean mixed)

See parseDocument(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

mixed - Mixed parameter.

Returns:

(see linked method).

parseDocument

public static XmlDocument parseDocument(CharStream stream,
                                        boolean mixed,
                                        XmlParser.Options options)

Parse a stream to a document.

Parameters:

stream - Stream to be parsed.

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

options - Additional parser options (if any).

Returns:

Parsed document.

parseElement

public XmlElement parseElement()

Return the next element in the stream.

See Also:

XmlParser.startDocument, XmlParser.startElement.

Returns:

The next element in the stream.

readChildren

public void readChildren(XmlElement element)

Read all of the children of a started element, and read the element's end tag.

See Also:

XmlParser.startDocument, XmlParser.startElement.

Parameters:

element - Parent element, which must have already been started.

setDeclaration

public void setDeclaration(java.lang.String value)

Set the parsed XML declaration.

Parameters:

value - The parsed XML declaration.

setRootElement

public void setRootElement(XmlElement value)

Set the parsed root element.

Parameters:

value - The parsed root element.

startDocument

public static XmlParser startDocument(CharStream stream)

See startDocument(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

Returns:

(see linked method).

startDocument

public static XmlParser startDocument(CharStream stream,
                                      boolean mixed)

See startDocument(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

mixed - Mixed parameter.

Returns:

(see linked method).

startDocument

public static XmlParser startDocument(CharStream stream,
                                      boolean mixed,
                                      XmlParser.Options options)

Start parsing a stream to a document.

Parameters:

stream - Stream to be parsed.

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

options - Additional parser options (if any).

Returns:

Document with only the start tag parsed.

startElement

public static XmlParser startElement(CharStream stream)

See startElement(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

Returns:

(see linked method).

startElement

public static XmlParser startElement(CharStream stream,
                                     boolean mixed)

See startElement(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

mixed - Mixed parameter.

Returns:

(see linked method).

startElement

public static XmlParser startElement(CharStream stream,
                                     boolean mixed,
                                     XmlParser.Options options)

Start parsing a stream to an element.

Parameters:

stream - Stream to be parsed.

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

options - Additional parser options (if any).

Returns:

Element with only the start tag parsed.

static_parseElement

public static XmlElement static_parseElement(CharStream stream)

See static_parseElement(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

Returns:

(see linked method).

static_parseElement

public static XmlElement static_parseElement(CharStream stream,
                                             boolean mixed)

See static_parseElement(CharStream, boolean, Options).

Parameters:

stream - Stream parameter.

mixed - Mixed parameter.

Returns:

(see linked method).

static_parseElement

public static XmlElement static_parseElement(CharStream stream,
                                             boolean mixed,
                                             XmlParser.Options options)

Parse a stream to an element.

Parameters:

stream - Stream to be parsed.

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

options - Additional parser options (if any).

Returns:

Parsed element.