public abstract class

SAXParser

extends Object
java.lang.Object
   ↳ javax.xml.parsers.SAXParser

Class Overview

Defines the API that wraps an XMLReader implementation class. In JAXP 1.0, this class wrapped the Parser interface, however this interface was replaced by the XMLReader. For ease of transition, this class continues to support the same name and interface as well as supporting new methods. An instance of this class can be obtained from the newSAXParser() method. Once an instance of this class is obtained, XML can be parsed from a variety of input sources. These input sources are InputStreams, Files, URLs, and SAX InputSources.

This static method creates a new factory instance based on a system property setting or uses the platform default if no property has been defined.

The system property that controls which Factory implementation to create is named "javax.xml.parsers.SAXParserFactory". This property names a class that is a concrete subclass of this abstract class. If no property is defined, a platform default will be used.

As the content is parsed by the underlying parser, methods of the given HandlerBase or the DefaultHandler are called.

Implementations of this class which wrap an underlying implementation can consider using the ParserAdapter class to initially adapt their SAX1 implementation to work under this revised class.

Summary

Protected Constructors
SAXParser()

Protected constructor to prevent instantiation.

Public Methods
abstract Parser getParser()
Returns the SAX parser that is encapsulated by the implementation of this class.
abstract Object getProperty(String name)

Returns the particular property requested for in the underlying implementation of XMLReader.

Schema getSchema()

Get a reference to the the Schema being used by the XML processor.

abstract XMLReader getXMLReader()
Returns the XMLReader that is encapsulated by the implementation of this class.
abstract boolean isNamespaceAware()
Indicates whether or not this parser is configured to understand namespaces.
abstract boolean isValidating()
Indicates whether or not this parser is configured to validate XML documents.
boolean isXIncludeAware()

Get the XInclude processing mode for this parser.

void parse(InputStream is, HandlerBase hb, String systemId)

Parse the content of the given InputStream instance as XML using the specified HandlerBase.

void parse(InputSource is, DefaultHandler dh)
Parse the content given InputSource as XML using the specified DefaultHandler.
void parse(String uri, HandlerBase hb)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified HandlerBase.
void parse(String uri, DefaultHandler dh)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler.
void parse(File f, DefaultHandler dh)
Parse the content of the file specified as XML using the specified DefaultHandler.
void parse(InputStream is, DefaultHandler dh)
Parse the content of the given InputStream instance as XML using the specified DefaultHandler.
void parse(InputStream is, DefaultHandler dh, String systemId)
Parse the content of the given InputStream instance as XML using the specified DefaultHandler.
void parse(InputSource is, HandlerBase hb)
Parse the content given InputSource as XML using the specified HandlerBase.
void parse(InputStream is, HandlerBase hb)

Parse the content of the given InputStream instance as XML using the specified HandlerBase.

void parse(File f, HandlerBase hb)
Parse the content of the file specified as XML using the specified HandlerBase.
void reset()

Reset this SAXParser to its original configuration.

abstract void setProperty(String name, Object value)

Sets the particular property in the underlying implementation of XMLReader.

[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected SAXParser ()

Since: API Level 1

Protected constructor to prevent instantiation. Use newSAXParser().

Public Methods

public abstract Parser getParser ()

Since: API Level 1

Returns the SAX parser that is encapsulated by the implementation of this class.

Returns
  • The SAX parser that is encapsulated by the implementation of this class.
Throws
SAXException If any SAX errors occur during processing.

public abstract Object getProperty (String name)

Since: API Level 1

Returns the particular property requested for in the underlying implementation of XMLReader.

Parameters
name The name of the property to be retrieved.
Returns
  • Value of the requested property.
Throws
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
See Also

public Schema getSchema ()

Since: API Level 8

Get a reference to the the Schema being used by the XML processor.

If no schema is being used, null is returned.

Returns
  • Schema being used or null if none in use
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

public abstract XMLReader getXMLReader ()

Since: API Level 1

Returns the XMLReader that is encapsulated by the implementation of this class.

Returns
  • The XMLReader that is encapsulated by the implementation of this class.
Throws
SAXException If any SAX errors occur during processing.

public abstract boolean isNamespaceAware ()

Since: API Level 1

Indicates whether or not this parser is configured to understand namespaces.

Returns
  • true if this parser is configured to understand namespaces; false otherwise.

public abstract boolean isValidating ()

Since: API Level 1

Indicates whether or not this parser is configured to validate XML documents.

Returns
  • true if this parser is configured to validate XML documents; false otherwise.

public boolean isXIncludeAware ()

Since: API Level 1

Get the XInclude processing mode for this parser.

Returns
Throws
UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.
See Also

public void parse (InputStream is, HandlerBase hb, String systemId)

Since: API Level 1

Parse the content of the given InputStream instance as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0.

Parameters
is InputStream containing the content to be parsed.
hb The SAX HandlerBase to use.
systemId The systemId which is needed for resolving relative URIs.
Throws
IllegalArgumentException If the given InputStream is null.
IOException If any IO error occurs interacting with the InputStream.
SAXException If any SAX errors occur during processing.
See Also

public void parse (InputSource is, DefaultHandler dh)

Since: API Level 1

Parse the content given InputSource as XML using the specified DefaultHandler.

Parameters
is The InputSource containing the content to be parsed.
dh The SAX DefaultHandler to use.
Throws
IllegalArgumentException If the InputSource object is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (String uri, HandlerBase hb)

Since: API Level 1

Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters
uri The location of the content to be parsed.
hb The SAX HandlerBase to use.
Throws
IllegalArgumentException If the uri is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (String uri, DefaultHandler dh)

Since: API Level 1

Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler.

Parameters
uri The location of the content to be parsed.
dh The SAX DefaultHandler to use.
Throws
IllegalArgumentException If the uri is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (File f, DefaultHandler dh)

Since: API Level 1

Parse the content of the file specified as XML using the specified DefaultHandler.

Parameters
f The file containing the XML to parse
dh The SAX DefaultHandler to use.
Throws
IllegalArgumentException If the File object is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (InputStream is, DefaultHandler dh)

Since: API Level 1

Parse the content of the given InputStream instance as XML using the specified DefaultHandler.

Parameters
is InputStream containing the content to be parsed.
dh The SAX DefaultHandler to use.
Throws
IllegalArgumentException If the given InputStream is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (InputStream is, DefaultHandler dh, String systemId)

Since: API Level 1

Parse the content of the given InputStream instance as XML using the specified DefaultHandler.

Parameters
is InputStream containing the content to be parsed.
dh The SAX DefaultHandler to use.
systemId The systemId which is needed for resolving relative URIs.
Throws
IllegalArgumentException If the given InputStream is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (InputSource is, HandlerBase hb)

Since: API Level 1

Parse the content given InputSource as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters
is The InputSource containing the content to be parsed.
hb The SAX HandlerBase to use.
Throws
IllegalArgumentException If the InputSource object is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void parse (InputStream is, HandlerBase hb)

Since: API Level 1

Parse the content of the given InputStream instance as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0.

Parameters
is InputStream containing the content to be parsed.
hb The SAX HandlerBase to use.
Throws
IllegalArgumentException If the given InputStream is null.
SAXException If parse produces a SAX error.
IOException If an IO error occurs interacting with the InputStream.
See Also

public void parse (File f, HandlerBase hb)

Since: API Level 1

Parse the content of the file specified as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters
f The file containing the XML to parse
hb The SAX HandlerBase to use.
Throws
IllegalArgumentException If the File object is null.
IOException If any IO errors occur.
SAXException If any SAX errors occur during processing.
See Also

public void reset ()

Since: API Level 1

Reset this SAXParser to its original configuration.

SAXParser is reset to the same state as when it was created with newSAXParser(). reset() is designed to allow the reuse of existing SAXParsers thus saving resources associated with the creation of new SAXParsers.

The reset SAXParser is not guaranteed to have the same Schema Object, e.g. equals(Object). It is guaranteed to have a functionally equal Schema.

public abstract void setProperty (String name, Object value)

Since: API Level 1

Sets the particular property in the underlying implementation of XMLReader. A list of the core features and properties can be found at http://sax.sourceforge.net/?selected=get-set.

Parameters
name The name of the property to be set.
value The value of the property to be set.
Throws
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
See Also