SAXParser (Java SE 11 & JDK 11 ) (original) (raw)

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

public abstract class SAXParser
extends Object
Defines the API that wraps an XMLReader implementation class. In JAXP 1.0, this class wrapped theParser 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 theSAXParserFactory.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 theDefaultHandler are called.
Implementors 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.
Since:
1.4

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SAXParser()	Protected constructor to prevent instantiation.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods

Modifier and Type	Method	Description
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(File f,HandlerBase hb)	Parse the content of the file specified as XML using the specified HandlerBase.
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,HandlerBase hb,String systemId)	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 specifiedDefaultHandler.
void	parse(InputStream is,DefaultHandler dh,String systemId)	Parse the content of the given InputStream instance as XML using the specifiedDefaultHandler.
void	parse(String uri,HandlerBase hb)	Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase.
void	parse(String uri,DefaultHandler dh)	Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler.
void	parse(InputSource is,HandlerBase hb)	Parse the content given InputSource as XML using the specifiedHandlerBase.
void	parse(InputSource is,DefaultHandler dh)	Parse the content given InputSource as XML using the specifiedDefaultHandler.
void	reset()	Reset this SAXParser to its original configuration.
abstract void	setProperty(String name,Object value)	Sets the particular property in the underlying implementation ofXMLReader.

   * ### Methods declared in class java.lang.[Object](../../../../java.base/java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)`

Constructor Detail

 * #### SAXParser  
 protected SAXParser()

Method Detail

* #### reset  
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()](SAXParserFactory.html#newSAXParser%28%29).`reset()` is designed to allow the reuse of existing `SAXParser`s thus saving resources associated with the creation of new `SAXParser`s.  
The reset `SAXParser` is not guaranteed to have the same [Schema](../validation/Schema.html "class in javax.xml.validation") `Object`, e.g. [Object.equals(Object obj)](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29). It is guaranteed to have a functionally equal`Schema`.  
Throws:  
`[UnsupportedOperationException](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")` \- When Implementations do not override this method  
Since:  
1.5  
* #### parse  
public void parse([InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") is,  
                  [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax") hb)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content of the given [InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") instance as XML using the specified [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax"). _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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the given InputStream is null.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If parse produces a SAX error.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If an IO error occurs interacting with the`InputStream`.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") is,  
                  [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax") hb,  
                  [String](../../../../java.base/java/lang/String.html "class in java.lang") systemId)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content of the given [InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") instance as XML using the specified [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax"). _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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the given `InputStream` is`null`.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO error occurs interacting with the`InputStream`.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[version of this method instead.](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") is,  
                  [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers") dh)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parameters:  
`is` \- InputStream containing the content to be parsed.  
`dh` \- The SAX DefaultHandler to use.  
Throws:  
`[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the given InputStream is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([InputStream](../../../../java.base/java/io/InputStream.html "class in java.io") is,  
                  [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers") dh,  
                  [String](../../../../java.base/java/lang/String.html "class in java.lang") systemId)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the given InputStream is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[version of this method instead.](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([String](../../../../java.base/java/lang/String.html "class in java.lang") uri,  
                  [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax") hb)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified[HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax"). _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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the uri is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([String](../../../../java.base/java/lang/String.html "class in java.lang") uri,  
                  [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers") dh)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified[DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers").  
Parameters:  
`uri` \- The location of the content to be parsed.  
`dh` \- The SAX DefaultHandler to use.  
Throws:  
`[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the uri is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([File](../../../../java.base/java/io/File.html "class in java.io") f,  
                  [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax") hb)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content of the file specified as XML using the specified [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax"). _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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the File object is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([File](../../../../java.base/java/io/File.html "class in java.io") f,  
                  [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers") dh)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content of the file specified as XML using the specified [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers").  
Parameters:  
`f` \- The file containing the XML to parse  
`dh` \- The SAX DefaultHandler to use.  
Throws:  
`[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the File object is null.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([InputSource](../../../org/xml/sax/InputSource.html "class in org.xml.sax") is,  
                  [HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax") hb)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parse the content given [InputSource](../../../org/xml/sax/InputSource.html "class in org.xml.sax") as XML using the specified[HandlerBase](../../../org/xml/sax/HandlerBase.html "class in org.xml.sax"). _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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the `InputSource` object is `null`.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### parse  
public void parse([InputSource](../../../org/xml/sax/InputSource.html "class in org.xml.sax") is,  
                  [DefaultHandler](../../../org/xml/sax/helpers/DefaultHandler.html "class in org.xml.sax.helpers") dh)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax"),  
                  [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
Parameters:  
`is` \- The InputSource containing the content to be parsed.  
`dh` \- The SAX DefaultHandler to use.  
Throws:  
`[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")` \- If the `InputSource` object is `null`.  
`[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If any IO errors occur.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
See Also:  
[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")  
* #### getParser  
public abstract [Parser](../../../org/xml/sax/Parser.html "interface in org.xml.sax") getParser()  
                          throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
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](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
* #### getXMLReader  
public abstract [XMLReader](../../../org/xml/sax/XMLReader.html "interface in org.xml.sax") getXMLReader()  
                                throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Returns the [XMLReader](../../../org/xml/sax/XMLReader.html "interface in org.xml.sax") that is encapsulated by the implementation of this class.  
Returns:  
The XMLReader that is encapsulated by the implementation of this class.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If any SAX errors occur during processing.  
* #### 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.  
* #### setProperty  
public abstract void setProperty([String](../../../../java.base/java/lang/String.html "class in java.lang") name,  
                                 [Object](../../../../java.base/java/lang/Object.html "class in java.lang") value)  
                          throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                                 [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Parameters:  
`name` \- The name of the property to be set.  
`value` \- The value of the property to be set.  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- When the underlying XMLReader does not recognize the property name.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the underlying XMLReader recognizes the property name but doesn't support the property.  
See Also:  
[XMLReader.setProperty(java.lang.String, java.lang.Object)](../../../org/xml/sax/XMLReader.html#setProperty%28java.lang.String,java.lang.Object%29)  
* #### getProperty  
public abstract [Object](../../../../java.base/java/lang/Object.html "class in java.lang") getProperty([String](../../../../java.base/java/lang/String.html "class in java.lang") name)  
                            throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                                   [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Returns the particular property requested for in the underlying implementation of [XMLReader](../../../org/xml/sax/XMLReader.html "interface in org.xml.sax").  
Parameters:  
`name` \- The name of the property to be retrieved.  
Returns:  
Value of the requested property.  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- When the underlying XMLReader does not recognize the property name.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the underlying XMLReader recognizes the property name but doesn't support the property.  
See Also:  
[XMLReader.getProperty(java.lang.String)](../../../org/xml/sax/XMLReader.html#getProperty%28java.lang.String%29)  
* #### getSchema  
public [Schema](../validation/Schema.html "class in javax.xml.validation") getSchema()  
Get a reference to the the [Schema](../validation/Schema.html "class in javax.xml.validation") being used by the XML processor.  
If no schema is being used, `null` is returned.  
Returns:  
[Schema](../validation/Schema.html "class in javax.xml.validation") being used or `null` if none in use  
Throws:  
`[UnsupportedOperationException](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")` \- When implementation does not override this method  
Since:  
1.5  
* #### isXIncludeAware  
public boolean isXIncludeAware()  
Get the XInclude processing mode for this parser.  
Returns:  
the return value of the [SAXParserFactory.isXIncludeAware()](SAXParserFactory.html#isXIncludeAware%28%29) when this parser was created from factory.  
Throws:  
`[UnsupportedOperationException](../../../../java.base/java/lang/UnsupportedOperationException.html "class in java.lang")` \- When implementation does not override this method  
Since:  
1.5  
See Also:  
[SAXParserFactory.setXIncludeAware(boolean)](SAXParserFactory.html#setXIncludeAware%28boolean%29)

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

SAXParser (Java SE 11 & JDK 11 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail