javax.xml.parsers
Class SAXParser

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

Direct Known Subclasses:

SAXParserImpl

public abstract class SAXParser

extends java.lang.Object

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.

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

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

An implementation of SAXParser is NOT guaranteed to behave as per the specification if it is used concurrently by two or more threads. It is recommended to have one instance of the SAXParser per thread or it is upto the application to make sure about the use of SAXParser from more than one thread.

Author:

Ias (iasandcb@tmax.co.kr)

Constructor Summary

protected

SAXParser()

Method Summary

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.
abstract void	parse(InputSource is, DefaultHandler dh) Parse the content given InputSource as XML using the specified DefaultHandler.
abstract void	parse(java.io.InputStream is, DefaultHandler dh) Parse the content of the given InputStream instance as XML using the specified DefaultHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXParser

protected SAXParser()

Method Detail

parse

public abstract void parse(java.io.InputStream is,
                           DefaultHandler dh)
                    throws SAXException,
                           java.io.IOException

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:

java.io.IOException - If any IO errors occur.

java.lang.IllegalArgumentException - If the given InputStream is null.

SAXException - If the underlying parser throws a SAXException while parsing.

See Also:

DocumentHandler

parse

public abstract void parse(InputSource is,
                           DefaultHandler dh)
                    throws SAXException,
                           java.io.IOException

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:

java.io.IOException - If any IO errors occur.

java.lang.IllegalArgumentException - If the InputSource is null.

SAXException - If the underlying parser throws a SAXException while parsing.

See Also:

DocumentHandler

isNamespaceAware

public abstract boolean isNamespaceAware()

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

Returns:

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

isValidating

public abstract boolean isValidating()

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.