/**@class javax.xml.parsers.SAXParser @extends java.lang.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.<p> 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.<p> The system property that controls which Factory implementation to create is named <code>"javax.xml.parsers.SAXParserFactory"</code>. 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.</p> 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.<p> Implementations of this class which wrap an underlying implementation can consider using the {@link org.xml.sax.helpers.ParserAdapter} class to initially adapt their SAX1 implementation to work under this revised class. @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a> @version $Revision: 584483 $, $Date: 2007-10-13 19:54:48 -0700 (Sat, 13 Oct 2007) $ */ var SAXParser = { /**<p>Reset this <code>SAXParser</code> to its original configuration.</p> <p><code>SAXParser</code> is reset to the same state as when it was created with {@link javax.xml.parsers.SAXParserFactory#newjavax.xml.parsers.SAXParser()}. <code>reset()</code> is designed to allow the reuse of existing <code>SAXParser</code>s thus saving resources associated with the creation of new <code>SAXParser</code>s.</p> <p>The reset <code>SAXParser</code> is not guaranteed to have the same {@link Schema} <code>Object</code>, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal <code>Schema</code>.</p> @since 1.5 */ reset : function( ) {}, /**<p>Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}. <i> Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0</i>.</p> @param {Object {InputStream}} is InputStream containing the content to be parsed. @param {Object {HandlerBase}} hb The SAX HandlerBase to use. @throws IllegalArgumentException If the given InputStream is null. @throws SAXException If parse produces a SAX error. @throws IOException If an IO error occurs interacting with the <code>InputStream</code>. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**<p>Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}. <i> Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0</i>.</p> @param {Object {InputStream}} is InputStream containing the content to be parsed. @param {Object {HandlerBase}} hb The SAX HandlerBase to use. @param {String} systemId The systemId which is needed for resolving relative URIs. @throws IllegalArgumentException If the given <code>InputStream</code> is <code>null</code>. @throws IOException If any IO error occurs interacting with the <code>InputStream</code>. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler version of this method instead. */ parse : function( ) {}, /**Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}. @param {Object {InputStream}} is InputStream containing the content to be parsed. @param {Object {DefaultHandler}} dh The SAX DefaultHandler to use. @throws IllegalArgumentException If the given InputStream is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}. @param {Object {InputStream}} is InputStream containing the content to be parsed. @param {Object {DefaultHandler}} dh The SAX DefaultHandler to use. @param {String} systemId The systemId which is needed for resolving relative URIs. @throws IllegalArgumentException If the given InputStream is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler version of this method instead. */ parse : function( ) {}, /**Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.HandlerBase}. <i> Use of the DefaultHandler version of this method is recommended as the <code>HandlerBase</code> class has been deprecated in SAX 2.0</i> @param {String} uri The location of the content to be parsed. @param {Object {HandlerBase}} hb The SAX HandlerBase to use. @throws IllegalArgumentException If the uri is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}. @param {String} uri The location of the content to be parsed. @param {Object {DefaultHandler}} dh The SAX DefaultHandler to use. @throws IllegalArgumentException If the uri is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content of the file specified as XML using the specified {@link org.xml.sax.HandlerBase}. <i> Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0</i> @param {Object {File}} f The file containing the XML to parse @param {Object {HandlerBase}} hb The SAX HandlerBase to use. @throws IllegalArgumentException If the File object is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content of the file specified as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}. @param {Object {File}} f The file containing the XML to parse @param {Object {DefaultHandler}} dh The SAX DefaultHandler to use. @throws IllegalArgumentException If the File object is null. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.HandlerBase}. <i> Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0</i> @param {Object {InputSource}} is The InputSource containing the content to be parsed. @param {Object {HandlerBase}} hb The SAX HandlerBase to use. @throws IllegalArgumentException If the <code>InputSource</code> object is <code>null</code>. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}. @param {Object {InputSource}} is The InputSource containing the content to be parsed. @param {Object {DefaultHandler}} dh The SAX DefaultHandler to use. @throws IllegalArgumentException If the <code>InputSource</code> object is <code>null</code>. @throws IOException If any IO errors occur. @throws SAXException If any SAX errors occur during processing. @see org.xml.sax.DocumentHandler */ parse : function( ) {}, /**Returns the SAX parser that is encapsulated by the implementation of this class. @return {Object {org.xml.sax.Parser}} The SAX parser that is encapsulated by the implementation of this class. @throws SAXException If any SAX errors occur during processing. */ getParser : function( ) {}, /**Returns the {@link org.xml.sax.XMLReader} that is encapsulated by the implementation of this class. @return {Object {org.xml.sax.XMLReader}} The XMLReader that is encapsulated by the implementation of this class. @throws SAXException If any SAX errors occur during processing. */ getXMLReader : function( ) {}, /**Indicates whether or not this parser is configured to understand namespaces. @return {Boolean} true if this parser is configured to understand namespaces; false otherwise. */ isNamespaceAware : function( ) {}, /**Indicates whether or not this parser is configured to validate XML documents. @return {Boolean} true if this parser is configured to validate XML documents; false otherwise. */ isValidating : function( ) {}, /**<p>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 <a href="http://sax.sourceforge.net/?selected=get-set"> http://sax.sourceforge.net/?selected=get-set</a>.</p> @param {String} name The name of the property to be set. @param {Object {Object}} value The value of the property to be set. @throws SAXNotRecognizedException When the underlying XMLReader does not recognize the property name. @throws SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property. @see org.xml.sax.XMLReader#setProperty */ setProperty : function( ) {}, /**<p>Returns the particular property requested for in the underlying implementation of {@link org.xml.sax.XMLReader}.</p> @param {String} name The name of the property to be retrieved. @return {Object {java.lang.Object}} Value of the requested property. @throws SAXNotRecognizedException When the underlying XMLReader does not recognize the property name. @throws SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property. @see org.xml.sax.XMLReader#getProperty */ getProperty : function( ) {}, /**<p>Get a reference to the the {@link Schema} being used by the XML processor.</p> <p>If no schema is being used, <code>null</code> is returned.</p> @return {Object {javax.xml.validation.Schema}} {@link Schema} being used or <code>null</code> if none in use @throws UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. @since 1.5 */ getSchema : function( ) {}, /**<p>Get the XInclude processing mode for this parser.</p> @return {Boolean} the return value of the {@link 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. @since 1.5 @see SAXParserFactory#setXIncludeAware(boolean) */ isXIncludeAware : function( ) {}, };