net.rim.device.api.xml.jaxp
Class XMLParser

java.lang.Object
  net.rim.device.api.xml.parsers.SAXParser
      net.rim.device.api.xml.jaxp.XMLParser

All Implemented Interfaces:

Locator, XMLReader

public class XMLParser
extends SAXParser
implements Locator, XMLReader

An XML1.0 SAX parser. Note: This is not a validating parser.

Since:

BlackBerry API 4.0.0

Constructor Summary

XMLParser()

Method Summary
boolean	getAllowUndefinedNamespaces() Determines whether this parser allows undefined namespaces.
int	getColumnNumber() Return the column number where the current document event ends.
int	getLineNumber() Return the line number where the current document event ends.
String	getPublicId() Return the public identifier for the current document event.
String	getSystemId() Return the system identifier for the current document event.
boolean	isNamespaceAware() Determines whether this parser understands namespaces.
boolean	isValidating() Determines whether this parser validates documents.
void	parse(InputStream is, DefaultHandler handler) Parses the given InputStream.
void	parse(InputSource is, DefaultHandler handler) Parses the given InputSource.
void	setAllowUndefinedNamespaces(boolean allowUndefinedNamespaces) Configures this parser to allow or disallow undefined namespaces.
void	setNamespaceAware(boolean aware) Configures this parser to be namespace aware or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.XMLReader

getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getProperty, parse, parse, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty

Constructor Detail

XMLParser

public XMLParser()

Since:

BlackBerry API 4.0.0

Method Detail

isValidating

public boolean isValidating()

Description copied from class: SAXParser

Determines whether this parser validates documents.

Specified by:

isValidating in class SAXParser

Returns:

True if this parser validatates documents, false otherwise.

Since:

BlackBerry API 4.0.0

isNamespaceAware

public boolean isNamespaceAware()

Description copied from class: SAXParser

Determines whether this parser understands namespaces.

Specified by:

isNamespaceAware in class SAXParser

Returns:

True if this parser understands namespaces, false otherwise.

Since:

BlackBerry API 4.0.0

setNamespaceAware

public void setNamespaceAware(boolean aware)

Description copied from class: SAXParser

Configures this parser to be namespace aware or not.

Specified by:

setNamespaceAware in class SAXParser

Parameters:

aware - True to configure this parser to be namespace aware; false otherwise.

Since:

BlackBerry API 4.3.0

parse

public void parse(InputStream is,
                  DefaultHandler handler)
           throws SAXException,
                  IOException

Description copied from class: SAXParser

Parses the given InputStream.

Specified by:

parse in class SAXParser

Parameters:

is - Input stream to parse.

handler - The SAX DefaultHandler to call.

Throws:

SAXException - Thrown when the underlying parser throws a SAXException.

IOException - Thrown when an IO error occurs.

Since:

BlackBerry API 4.0.0

parse

public void parse(InputSource is,
                  DefaultHandler handler)
           throws SAXException,
                  IOException

Description copied from class: SAXParser

Parses the given InputSource.

Specified by:

parse in class SAXParser

Parameters:

is - Input stream to parse.

handler - The SAX DefaultHandler to call.

Throws:

SAXException - Thrown when the underlying parser throws a SAXException.

IOException - Thrown when an IO error occurs.

Since:

BlackBerry API 4.0.0

getAllowUndefinedNamespaces

public boolean getAllowUndefinedNamespaces()

Description copied from class: SAXParser

Determines whether this parser allows undefined namespaces.

Specified by:

getAllowUndefinedNamespaces in class SAXParser

Returns:

True if this parser allows undfined namespaces, false otherwise.

Since:

BlackBerry API 4.0.0

setAllowUndefinedNamespaces

public void setAllowUndefinedNamespaces(boolean allowUndefinedNamespaces)

Description copied from class: SAXParser

Configures this parser to allow or disallow undefined namespaces.

Specified by:

setAllowUndefinedNamespaces in class SAXParser

Parameters:

allowUndefinedNamespaces - True to configure this parser to allow undefined namespaces, false otherwise.

Since:

BlackBerry API 4.0.0

getPublicId

public String getPublicId()

Description copied from interface: Locator

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

Specified by:

getPublicId in interface Locator

Returns:

A string containing the public identifier, or null if none is available.

See Also:

Locator.getSystemId()

Since:

BlackBerry API 4.0.0

getSystemId

public String getSystemId()

Description copied from interface: Locator

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases.

Specified by:

getSystemId in interface Locator

Returns:

A string containing the system identifier, or null if none is available.

See Also:

Locator.getPublicId()

Since:

BlackBerry API 4.0.0

getLineNumber

public int getLineNumber()

Description copied from interface: Locator

Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

Specified by:

getLineNumber in interface Locator

Returns:

The line number, or -1 if none is available.

See Also:

Locator.getColumnNumber()

Since:

BlackBerry API 4.0.0

getColumnNumber

public int getColumnNumber()

Description copied from interface: Locator

Return the column number where the current document event ends. This is one-based number of Java char values since the last line end.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

Specified by:

getColumnNumber in interface Locator

Returns:

The column number, or -1 if none is available.

See Also:

Locator.getLineNumber()

Since:

BlackBerry API 4.0.0