- java.lang.Object
- 
- javax.xml.parsers.SAXParser
 
- 
 public abstract class SAXParser extends Object Defines the API that wraps anXMLReaderimplementation class. In JAXP 1.0, this class wrapped theParserinterface, however this interface was replaced by theXMLReader. 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 As the content is parsed by the underlying parser, methods of the given"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.HandlerBaseor theDefaultHandlerare called.Implementors of this class which wrap an underlying implementation can consider using the ParserAdapterclass to initially adapt their SAX1 implementation to work under this revised class.- Since:
- 1.4
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedSAXParser()Protected constructor to prevent instantiation.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ParsergetParser()Returns the SAX parser that is encapsulated by the implementation of this class.abstract ObjectgetProperty(String name)Returns the particular property requested for in the underlying implementation ofXMLReader.SchemagetSchema()Get a reference to the theSchemabeing used by the XML processor.abstract XMLReadergetXMLReader()Returns theXMLReaderthat 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.booleanisXIncludeAware()Get the XInclude processing mode for this parser.voidparse(File f, HandlerBase hb)Parse the content of the file specified as XML using the specifiedHandlerBase.voidparse(File f, DefaultHandler dh)Parse the content of the file specified as XML using the specifiedDefaultHandler.voidparse(InputStream is, HandlerBase hb)Parse the content of the givenInputStreaminstance as XML using the specifiedHandlerBase.voidparse(InputStream is, HandlerBase hb, String systemId)Parse the content of the givenInputStreaminstance as XML using the specifiedHandlerBase.voidparse(InputStream is, DefaultHandler dh)Parse the content of the givenInputStreaminstance as XML using the specifiedDefaultHandler.voidparse(InputStream is, DefaultHandler dh, String systemId)Parse the content of the givenInputStreaminstance as XML using the specifiedDefaultHandler.voidparse(String uri, HandlerBase hb)Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase.voidparse(String uri, DefaultHandler dh)Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler.voidparse(InputSource is, HandlerBase hb)Parse the content givenInputSourceas XML using the specifiedHandlerBase.voidparse(InputSource is, DefaultHandler dh)Parse the content givenInputSourceas XML using the specifiedDefaultHandler.voidreset()Reset thisSAXParserto its original configuration.abstract voidsetProperty(String name, Object value)Sets the particular property in the underlying implementation ofXMLReader.
 
- 
- 
- 
Constructor Detail- 
SAXParserprotected SAXParser() Protected constructor to prevent instantiation. Use SAXParserFactory.newSAXParser().
 
- 
 - 
Method Detail- 
resetpublic void reset() Reset this SAXParserto its original configuration.SAXParseris reset to the same state as when it was created withSAXParserFactory.newSAXParser().reset()is designed to allow the reuse of existingSAXParsers thus saving resources associated with the creation of newSAXParsers.The reset SAXParseris not guaranteed to have the sameSchemaObject, e.g.Object.equals(Object obj). It is guaranteed to have a functionally equalSchema.- Throws:
- UnsupportedOperationException- When Implementations do not override this method
- Since:
- 1.5
 
 - 
parsepublic void parse(InputStream is, HandlerBase hb) throws SAXException, IOException Parse the content of the given InputStreaminstance as XML using the specifiedHandlerBase. 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:
- DocumentHandler
 
 - 
parsepublic void parse(InputStream is, HandlerBase hb, String systemId) throws SAXException, IOException Parse the content of the given InputStreaminstance as XML using the specifiedHandlerBase. 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- InputStreamis- 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.
 
 - 
parsepublic void parse(InputStream is, DefaultHandler dh) throws SAXException, IOException Parse the content of the givenInputStreaminstance as XML using the specifiedDefaultHandler.- 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:
- DocumentHandler
 
 - 
parsepublic void parse(InputStream is, DefaultHandler dh, String systemId) throws SAXException, IOException Parse the content of the givenInputStreaminstance as XML using the specifiedDefaultHandler.- 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:
- version of this method instead.
 
 - 
parsepublic void parse(String uri, HandlerBase hb) throws SAXException, IOException Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as theHandlerBaseclass 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:
- DocumentHandler
 
 - 
parsepublic void parse(String uri, DefaultHandler dh) throws SAXException, IOException Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler.- 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:
- DocumentHandler
 
 - 
parsepublic void parse(File f, HandlerBase hb) throws SAXException, IOException Parse the content of the file specified as XML using the specifiedHandlerBase. 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:
- DocumentHandler
 
 - 
parsepublic void parse(File f, DefaultHandler dh) throws SAXException, IOException Parse the content of the file specified as XML using the specifiedDefaultHandler.- 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:
- DocumentHandler
 
 - 
parsepublic void parse(InputSource is, HandlerBase hb) throws SAXException, IOException Parse the content givenInputSourceas XML using the specifiedHandlerBase. 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- InputSourceobject is- null.
- IOException- If any IO errors occur.
- SAXException- If any SAX errors occur during processing.
- See Also:
- DocumentHandler
 
 - 
parsepublic void parse(InputSource is, DefaultHandler dh) throws SAXException, IOException Parse the content givenInputSourceas XML using the specifiedDefaultHandler.- Parameters:
- is- The InputSource containing the content to be parsed.
- dh- The SAX DefaultHandler to use.
- Throws:
- IllegalArgumentException- If the- InputSourceobject is- null.
- IOException- If any IO errors occur.
- SAXException- If any SAX errors occur during processing.
- See Also:
- DocumentHandler
 
 - 
getParserpublic abstract Parser getParser() throws SAXException 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.
 
 - 
getXMLReaderpublic abstract XMLReader getXMLReader() throws SAXException Returns theXMLReaderthat 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.
 
 - 
isNamespaceAwarepublic 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.
 
 - 
isValidatingpublic 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.
 
 - 
setPropertypublic abstract void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException 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.All implementations that implement JAXP 1.5 or newer are required to support the XMLConstants.ACCESS_EXTERNAL_DTDandXMLConstants.ACCESS_EXTERNAL_SCHEMAproperties.- 
      Setting the XMLConstants.ACCESS_EXTERNAL_DTDproperty restricts the access to external DTDs, external Entity References to the protocols specified by the property. If access is denied during parsing due to the restriction of this property,SAXExceptionwill be thrown by the parse methods defined bySAXParser.Setting the XMLConstants.ACCESS_EXTERNAL_SCHEMAproperty restricts the access to external Schema set by the schemaLocation attribute to the protocols specified by the property. If access is denied during parsing due to the restriction of this property,SAXExceptionwill be thrown by the parse methods defined by theSAXParser.
 - 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.setProperty(java.lang.String, java.lang.Object)
 
- 
      
 - 
getPropertypublic abstract Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException 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:
- XMLReader.getProperty(java.lang.String)
 
 - 
getSchemapublic Schema getSchema() Get a reference to the the Schemabeing used by the XML processor.If no schema is being used, nullis returned.- Returns:
- Schemabeing used or- nullif none in use
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
 
 - 
isXIncludeAwarepublic boolean isXIncludeAware() Get the XInclude processing mode for this parser. - Returns:
- the return value of
      the SAXParserFactory.isXIncludeAware()when this parser was created from factory.
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
- See Also:
- SAXParserFactory.setXIncludeAware(boolean)
 
 
- 
 
-