Home » xml-commons-external-1.4.01-src » javax » xml » parsers » [javadoc | source]
javax.xml.parsers
abstract public class: SAXParser [javadoc | source]
java.lang.Object
   javax.xml.parsers.SAXParser
Defines the API that wraps an org.xml.sax.XMLReader implementation class. In JAXP 1.0, this class wrapped the org.xml.sax.Parser interface, however this interface was replaced by the 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 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.

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 org.xml.sax.HandlerBase or the org.xml.sax.helpers.DefaultHandler are called.

Implementors of this class which wrap an underlaying implementation can consider using the org.xml.sax.helpers.ParserAdapter class to initially adapt their SAX1 implementation to work under this revised class.

Constructor:
 protected SAXParser() 
Method from javax.xml.parsers.SAXParser Summary:
getParser,   getProperty,   getSchema,   getXMLReader,   isNamespaceAware,   isValidating,   isXIncludeAware,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   reset,   setProperty
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.parsers.SAXParser Detail:
 abstract public Parser getParser() throws SAXException
    Returns the SAX parser that is encapsulated by the implementation of this class.
 abstract public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

    Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader .

 public Schema getSchema() 

    Get a reference to the the Schema being used by the XML processor.

    If no schema is being used, null is returned.

 abstract public XMLReader getXMLReader() throws SAXException
 abstract public boolean isNamespaceAware()
    Indicates whether or not this parser is configured to understand namespaces.
 abstract public boolean isValidating()
    Indicates whether or not this parser is configured to validate XML documents.
 public boolean isXIncludeAware() 

    Get the XInclude processing mode for this parser.

 public  void parse(InputStream is,
    HandlerBase hb) throws SAXException, IOException 

    Parse the content of the given java.io.InputStream instance as XML using the specified 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.

 public  void parse(InputStream is,
    DefaultHandler dh) throws SAXException, IOException 
 public  void parse(String uri,
    HandlerBase hb) throws SAXException, IOException 
    Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified 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
 public  void parse(String uri,
    DefaultHandler dh) throws SAXException, IOException 
 public  void parse(File f,
    HandlerBase hb) throws SAXException, IOException 
    Parse the content of the file specified as XML using the specified 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
 public  void parse(File f,
    DefaultHandler dh) throws SAXException, IOException 
 public  void parse(InputSource is,
    HandlerBase hb) throws SAXException, IOException 
 public  void parse(InputSource is,
    DefaultHandler dh) throws SAXException, IOException 
 public  void parse(InputStream is,
    HandlerBase hb,
    String systemId) throws SAXException, IOException 

    Parse the content of the given java.io.InputStream instance as XML using the specified 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.

 public  void parse(InputStream is,
    DefaultHandler dh,
    String systemId) throws SAXException, IOException 
 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() . reset() is designed to allow the reuse of existing SAXParsers thus saving resources associated with the creation of new SAXParsers.

    The reset SAXParser is not guaranteed to have the same Schema Object, e.g. Object#equals(Object obj) . It is guaranteed to have a functionally equal Schema.

 abstract public  void setProperty(String name,
    Object value) throws SAXNotRecognizedException, SAXNotSupportedException