javax.xml.parsers

Class SAXParser

public abstract class SAXParser extends Object

Defines the API that wraps an {@link org.xml.sax.XMLReader} implementation class. In JAXP 1.0, this class wrapped the {@link org.xml.sax.Parser} interface, however this interface was replaced by the {@link org.xml.sax.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 {@link javax.xml.parsers.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 {@link org.xml.sax.HandlerBase} or the {@link org.xml.sax.helpers.DefaultHandler} are called.

Implementors of this class which wrap an underlying implementation can consider using the {@link org.xml.sax.helpers.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.

Since: JAXP 1.0

Version: 1.0

Constructor Summary
protected SAXParser()
Method Summary
abstract ParsergetParser()
Returns the SAX parser that is encapsultated by the implementation of this class.
abstract ObjectgetProperty(String name)
Returns the particular property requested for in the underlying implementation of {@link org.xml.sax.XMLReader}.
abstract XMLReadergetXMLReader()
Returns the {@link org.xml.sax.XMLReader} that is encapsulated by the implementation of this class.
abstract booleanisNamespaceAware()
Indicates whether or not this parser is configured to understand namespaces.
abstract booleanisValidating()
Indicates whether or not this parser is configured to validate XML documents.
voidparse(InputStream is, HandlerBase hb)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}.
voidparse(InputStream is, HandlerBase hb, String systemId)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}.
voidparse(InputStream is, DefaultHandler dh)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.
voidparse(InputStream is, DefaultHandler dh, String systemId)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.
voidparse(String uri, HandlerBase hb)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.HandlerBase}.
voidparse(String uri, DefaultHandler dh)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.
voidparse(File f, HandlerBase hb)
Parse the content of the file specified as XML using the specified {@link org.xml.sax.HandlerBase}.
voidparse(File f, DefaultHandler dh)
Parse the content of the file specified as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.
voidparse(InputSource is, HandlerBase hb)
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.HandlerBase}.
voidparse(InputSource is, DefaultHandler dh)
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.
abstract voidsetProperty(String name, Object value)
Sets the particular property in the underlying implementation of {@link org.xml.sax.XMLReader}.

Constructor Detail

SAXParser

protected SAXParser()

Method Detail

getParser

public abstract Parser getParser()
Returns the SAX parser that is encapsultated by the implementation of this class.

Returns: The SAX parser that is encapsultated by the implementation of this class.

getProperty

public abstract Object getProperty(String name)
Returns the particular property requested for in the underlying implementation of {@link org.xml.sax.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: XMLReader

getXMLReader

public abstract XMLReader getXMLReader()
Returns the {@link org.xml.sax.XMLReader} that is encapsulated by the implementation of this class.

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

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.

parse

public void parse(InputStream is, HandlerBase hb)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.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: IOException If any IO errors occur. IllegalArgumentException If the given InputStream is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(InputStream is, HandlerBase hb, String systemId)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.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: IOException If any IO errors occur. IllegalArgumentException If the given InputStream is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: version of this method instead.

parse

public void parse(InputStream is, DefaultHandler dh)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters: is InputStream containing the content to be parsed. dh The SAX DefaultHandler to use.

Throws: IOException If any IO errors occur. IllegalArgumentException If the given InputStream is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(InputStream is, DefaultHandler dh, String systemId)
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.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: IOException If any IO errors occur. IllegalArgumentException If the given InputStream is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: version of this method instead.

parse

public void parse(String uri, HandlerBase hb)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.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: IOException If any IO errors occur. IllegalArgumentException If the uri is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(String uri, DefaultHandler dh)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters: uri The location of the content to be parsed. dh The SAX DefaultHandler to use.

Throws: IOException If any IO errors occur. IllegalArgumentException If the uri is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(File f, HandlerBase hb)
Parse the content of the file specified as XML using the specified {@link org.xml.sax.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: IOException If any IO errors occur. IllegalArgumentException If the File object is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(File f, DefaultHandler dh)
Parse the content of the file specified as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters: f The file containing the XML to parse dh The SAX DefaultHandler to use.

Throws: IOException If any IO errors occur. IllegalArgumentException If the File object is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(InputSource is, HandlerBase hb)
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.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: IOException If any IO errors occur. IllegalArgumentException If the InputSource is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

parse

public void parse(InputSource is, DefaultHandler dh)
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters: is The InputSource containing the content to be parsed. dh The SAX DefaultHandler to use.

Throws: IOException If any IO errors occur. IllegalArgumentException If the InputSource is null. SAXException If the underlying parser throws a SAXException while parsing.

See Also: DocumentHandler

setProperty

public abstract void setProperty(String name, Object value)
Sets the particular property in the underlying implementation of {@link org.xml.sax.XMLReader}. A list of the core features and properties can be found at http://www.megginson.com/SAX/Java/features.html

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: XMLReader