| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.xml.parsers.SAXParser
Defines the API that wraps an XMLReader
 implementation class. In JAXP 1.0, this class wrapped the
 Parser 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 the
 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.
HandlerBase or the
 DefaultHandler are called.
 Implementors of this class which wrap an underlaying implementation
 can consider using the ParserAdapter
 class to initially adapt their SAX1 impelemntation to work under
 this revised class.
| Constructor Summary | |
| protected  | SAXParser()Protected constructor to prevent instaniation. | 
| Method Summary | |
| abstract  org.xml.sax.Parser | getParser()Returns the SAX parser that is encapsultated by the implementation of this class. | 
| abstract  java.lang.Object | getProperty(java.lang.String name)Returns the particular property requested for in the underlying implementation of XMLReader. | 
|  Schema | getSchema()Get a reference to the the Schemabeing used by
 the XML processor. | 
| abstract  org.xml.sax.XMLReader | getXMLReader()Returns the XMLReaderthat 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(java.io.File f,
      org.xml.sax.helpers.DefaultHandler dh)Parse the content of the file specified as XML using the specified DefaultHandler. | 
|  void | parse(java.io.File f,
      org.xml.sax.HandlerBase hb)Parse the content of the file specified as XML using the specified HandlerBase. | 
|  void | parse(org.xml.sax.InputSource is,
      org.xml.sax.helpers.DefaultHandler dh)Parse the content given InputSourceas XML using the specifiedDefaultHandler. | 
|  void | parse(org.xml.sax.InputSource is,
      org.xml.sax.HandlerBase hb)Parse the content given InputSourceas XML using the specifiedHandlerBase. | 
|  void | parse(java.io.InputStream is,
      org.xml.sax.helpers.DefaultHandler dh)Parse the content of the given InputStreaminstance as XML using the specifiedDefaultHandler. | 
|  void | parse(java.io.InputStream is,
      org.xml.sax.helpers.DefaultHandler dh,
      java.lang.String systemId)Parse the content of the given InputStreaminstance as XML using the specifiedDefaultHandler. | 
|  void | parse(java.io.InputStream is,
      org.xml.sax.HandlerBase hb)Parse the content of the given InputStreaminstance as XML using the specifiedHandlerBase. | 
|  void | parse(java.io.InputStream is,
      org.xml.sax.HandlerBase hb,
      java.lang.String systemId)Parse the content of the given InputStreaminstance as XML using the specifiedHandlerBase. | 
|  void | parse(java.lang.String uri,
      org.xml.sax.helpers.DefaultHandler dh)Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler. | 
|  void | parse(java.lang.String uri,
      org.xml.sax.HandlerBase hb)Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified HandlerBase. | 
|  void | reset()Reset this SAXParserto its original configuration. | 
| abstract  void | setProperty(java.lang.String name,
            java.lang.Object value)Sets the particular property in the underlying implementation of XMLReader. | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
protected SAXParser()
Protected constructor to prevent instaniation.
 Use SAXParserFactory.newSAXParser().
| Method Detail | 
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.
public void parse(java.io.InputStream is,
                  org.xml.sax.HandlerBase hb)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Parse the content of the given InputStream
 instance as XML using the specified HandlerBase.
  Use of the DefaultHandler version of this method is recommended as
 the HandlerBase class has been deprecated in SAX 2.0.
is - InputStream containing the content to be parsed.hb - The SAX HandlerBase to use.
java.lang.IllegalArgumentException - If the given InputStream is null.
org.xml.sax.SAXException - If parse produces a SAX error.
java.io.IOException - If an IO error occurs interacting with the
   InputStream.DocumentHandler
public void parse(java.io.InputStream is,
                  org.xml.sax.HandlerBase hb,
                  java.lang.String systemId)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Parse the content of the given InputStream
 instance as XML using the specified HandlerBase.
  Use of the DefaultHandler version of this method is recommended as
 the HandlerBase class has been deprecated in SAX 2.0.
is - InputStream containing the content to be parsed.hb - The SAX HandlerBase to use.systemId - The systemId which is needed for resolving relative URIs.
java.lang.IllegalArgumentException - If the given InputStream is
   null.
java.io.IOException - If any IO error occurs interacting with the
   InputStream.
org.xml.sax.SAXException - If any SAX errors occur during processing.version of this method instead.
public void parse(java.io.InputStream is,
                  org.xml.sax.helpers.DefaultHandler dh)
           throws org.xml.sax.SAXException,
                  java.io.IOException
InputStream
 instance as XML using the specified
 DefaultHandler.
is - InputStream containing the content to be parsed.dh - The SAX DefaultHandler to use.
java.lang.IllegalArgumentException - If the given InputStream is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(java.io.InputStream is,
                  org.xml.sax.helpers.DefaultHandler dh,
                  java.lang.String systemId)
           throws org.xml.sax.SAXException,
                  java.io.IOException
InputStream
 instance as XML using the specified
 DefaultHandler.
is - InputStream containing the content to be parsed.dh - The SAX DefaultHandler to use.systemId - The systemId which is needed for resolving relative URIs.
java.lang.IllegalArgumentException - If the given InputStream is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.version of this method instead.
public void parse(java.lang.String uri,
                  org.xml.sax.HandlerBase hb)
           throws org.xml.sax.SAXException,
                  java.io.IOException
HandlerBase.
  Use of the DefaultHandler version of this method is recommended as
 the HandlerBase class has been deprecated in SAX 2.0
uri - The location of the content to be parsed.hb - The SAX HandlerBase to use.
java.lang.IllegalArgumentException - If the uri is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(java.lang.String uri,
                  org.xml.sax.helpers.DefaultHandler dh)
           throws org.xml.sax.SAXException,
                  java.io.IOException
DefaultHandler.
uri - The location of the content to be parsed.dh - The SAX DefaultHandler to use.
java.lang.IllegalArgumentException - If the uri is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(java.io.File f,
                  org.xml.sax.HandlerBase hb)
           throws org.xml.sax.SAXException,
                  java.io.IOException
HandlerBase.
  Use of the DefaultHandler version of this method is recommended as
 the HandlerBase class has been deprecated in SAX 2.0
f - The file containing the XML to parsehb - The SAX HandlerBase to use.
java.lang.IllegalArgumentException - If the File object is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(java.io.File f,
                  org.xml.sax.helpers.DefaultHandler dh)
           throws org.xml.sax.SAXException,
                  java.io.IOException
DefaultHandler.
f - The file containing the XML to parsedh - The SAX DefaultHandler to use.
java.lang.IllegalArgumentException - If the File object is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(org.xml.sax.InputSource is,
                  org.xml.sax.HandlerBase hb)
           throws org.xml.sax.SAXException,
                  java.io.IOException
InputSource
 as XML using the specified
 HandlerBase.
  Use of the DefaultHandler version of this method is recommended as
 the HandlerBase class has been deprecated in SAX 2.0
is - The InputSource containing the content to be parsed.hb - The SAX HandlerBase to use.
java.lang.IllegalArgumentException - If the InputSource object
   is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public void parse(org.xml.sax.InputSource is,
                  org.xml.sax.helpers.DefaultHandler dh)
           throws org.xml.sax.SAXException,
                  java.io.IOException
InputSource
 as XML using the specified
 DefaultHandler.
is - The InputSource containing the content to be parsed.dh - The SAX DefaultHandler to use.
java.lang.IllegalArgumentException - If the InputSource object
   is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.DocumentHandler
public abstract org.xml.sax.Parser getParser()
                                      throws org.xml.sax.SAXException
org.xml.sax.SAXException - If any SAX errors occur during processing.
public abstract org.xml.sax.XMLReader getXMLReader()
                                            throws org.xml.sax.SAXException
XMLReader that is encapsulated by the
 implementation of this class.
org.xml.sax.SAXException - If any SAX errors occur during processing.public abstract boolean isNamespaceAware()
public abstract boolean isValidating()
public abstract void setProperty(java.lang.String name,
                                 java.lang.Object value)
                          throws org.xml.sax.SAXNotRecognizedException,
                                 org.xml.sax.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.
name - The name of the property to be set.value - The value of the property to be set.
org.xml.sax.SAXNotRecognizedException - When the underlying XMLReader does
   not recognize the property name.
org.xml.sax.SAXNotSupportedException - When the underlying XMLReader
  recognizes the property name but doesn't support the property.XMLReader.setProperty(java.lang.String, java.lang.Object)
public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws org.xml.sax.SAXNotRecognizedException,
                                             org.xml.sax.SAXNotSupportedException
Returns the particular property requested for in the underlying
 implementation of XMLReader.
name - The name of the property to be retrieved.
org.xml.sax.SAXNotRecognizedException - When the underlying XMLReader does
    not recognize the property name.
org.xml.sax.SAXNotSupportedException - When the underlying XMLReader
  recognizes the property name but doesn't support the property.XMLReader.getProperty(java.lang.String)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.
Schema being used or null
  if none in use
java.lang.UnsupportedOperationException - For backward compatibility, when implementations for
      earlier versions of JAXP is used, this exception will be
      thrown.public boolean isXIncludeAware()
Get the XInclude processing mode for this parser.
SAXParserFactory.isXIncludeAware()
      when this parser was created from factory.
java.lang.UnsupportedOperationException - For backward compatibility, when implementations for
      earlier versions of JAXP is used, this exception will be
      thrown.SAXParserFactory.setXIncludeAware(boolean)| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||