Added in API level 1

Summary: Protected Ctors | Methods | Inherited Methods

SAXParser

public abstract class SAXParser
extends Object

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

---

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 SAXParserFactory.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(InputSource is, DefaultHandler dh) Parse the content given InputSource 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, String systemId) Parse the content of the given InputStream instance as XML using the specified HandlerBase.
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(File f, HandlerBase hb) Parse the content of the file specified 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, HandlerBase hb) Parse the content of the given InputStream instance as XML using the specified HandlerBase.
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	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.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

SAXParser

Added in API level 1

protected SAXParser ()

Protected constructor to prevent instantiation. Use SAXParserFactory.newSAXParser().

Public methods

getParser

Added in API level 1

public abstract Parser getParser ()

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

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

Throws
SAXException	If any SAX errors occur during processing.

getProperty

Added in API level 1

public abstract Object getProperty (String name)

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

Parameters
name	String: The name of the property to be retrieved.

Returns
Object	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:

• XMLReader.getProperty(String)

getSchema

Added in API level 8

public Schema getSchema ()

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

If no schema is being used, null is returned.

Returns
Schema	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.

getXMLReader

Added in API level 1

public abstract XMLReader getXMLReader ()

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

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

Throws
SAXException	If any SAX errors occur during processing.

isNamespaceAware

Added in API level 1

public abstract boolean isNamespaceAware ()

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

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

isValidating

Added in API level 1

public abstract boolean isValidating ()

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

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

isXIncludeAware

Added in API level 1

public boolean isXIncludeAware ()

Get the XInclude processing mode for this parser.

Returns
boolean	the return value of the SAXParserFactory.isXIncludeAware() when this parser was created from factory.

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

See also:

• SAXParserFactory.setXIncludeAware(boolean)

parse

Added in API level 1

public void parse (InputSource is, 
                DefaultHandler dh)

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

Parameters
is	InputSource: The InputSource containing the content to be parsed.
dh	DefaultHandler: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (InputSource is, 
                HandlerBase hb)

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	InputSource: The InputSource containing the content to be parsed.
hb	HandlerBase: 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:

• DocumentHandler

parse

Added in API level 1

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

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: InputStream containing the content to be parsed.
hb	HandlerBase: The SAX HandlerBase to use.
systemId	String: 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:

• version of this method instead.

parse

Added in API level 1

public void parse (String uri, 
                HandlerBase hb)

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	String: The location of the content to be parsed.
hb	HandlerBase: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (File f, 
                HandlerBase hb)

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	File: The file containing the XML to parse
hb	HandlerBase: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (String uri, 
                DefaultHandler dh)

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

Parameters
uri	String: The location of the content to be parsed.
dh	DefaultHandler: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (File f, 
                DefaultHandler dh)

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

Parameters
f	File: The file containing the XML to parse
dh	DefaultHandler: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (InputStream is, 
                HandlerBase hb)

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: InputStream containing the content to be parsed.
hb	HandlerBase: 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:

• DocumentHandler

parse

Added in API level 1

public void parse (InputStream is, 
                DefaultHandler dh)

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

Parameters
is	InputStream: InputStream containing the content to be parsed.
dh	DefaultHandler: 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:

• DocumentHandler

parse

Added in API level 1

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

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

Parameters
is	InputStream: InputStream containing the content to be parsed.
dh	DefaultHandler: The SAX DefaultHandler to use.
systemId	String: 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:

• version of this method instead.

reset

Added in API level 1

public void reset ()

Reset this SAXParser to its original configuration.

SAXParser is reset to the same state as when it was created with SAXParserFactory.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. Object.equals(Object obj). It is guaranteed to have a functionally equal Schema.

setProperty

Added in API level 1

public abstract void setProperty (String name, 
                Object value)

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	String: The name of the property to be set.
value	Object: 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:

• XMLReader.setProperty(String, Object)