javax.xml.parsers
Class SAXParser

java.lang.Object
  extended by javax.xml.parsers.SAXParser

public abstract class SAXParser
extends Object

Convenience class for using or accessing a SAX version 1 or 2 parser. Instances of this class are not guaranteed to be thread safe.


Constructor Summary
protected SAXParser()
           
 
Method Summary
abstract  Parser getParser()
          Returns the underlying SAX1 parser.
abstract  Object getProperty(String name)
          Returns the value of the specified SAX2 parser property.
 Schema getSchema()
          Returns the schema in use by this parser.
abstract  XMLReader getXMLReader()
          Returns the underlying SAX2 parser.
abstract  boolean isNamespaceAware()
          Indicates whether this parser is XML Namespace aware.
abstract  boolean isValidating()
          Indicates whether this parser will validate its input.
 boolean isXIncludeAware()
          Indicates whether this parser is XInclude-aware.
 void parse(File f, DefaultHandler dh)
          Parse the content of the specified file, reporting SAX2 events to the given handler.
 void parse(File f, HandlerBase hb)
          Parse the content of the specified file, reporting SAX1 events to the given handler.
 void parse(InputSource is, DefaultHandler dh)
          Parse the specified input source, reporting SAX2 events to the given handler.
 void parse(InputSource is, HandlerBase hb)
          Parse the specified input source, reporting SAX1 events to the given handler.
 void parse(InputStream is, DefaultHandler dh)
          Parse the specified input stream, reporting SAX2 events to the given handler.
 void parse(InputStream is, DefaultHandler dh, String systemId)
          Parse the specified input stream, reporting SAX2 events to the given handler.
 void parse(InputStream is, HandlerBase hb)
          Parse the specifed input stream, reporting SAX1 events to the given handler.
 void parse(InputStream is, HandlerBase hb, String systemId)
          Parse the specified input stream, reporting SAX1 events to the given handler.
 void parse(String uri, DefaultHandler dh)
          Parse the content of the specified URI, reporting SAX2 events to the given handler.
 void parse(String uri, HandlerBase hb)
          Parse the content of the specified URI, reporting SAX1 events to the given handler.
 void reset()
          Resets this parser to its original configuration.
abstract  void setProperty(String name, Object value)
          Sets the specified SAX2 parser property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAXParser

protected SAXParser()
Method Detail

parse

public void parse(InputStream is,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the specifed input stream, reporting SAX1 events to the given handler. Prefer the SAX2 version of this method, since the HandlerBase class is now deprecated. Also prefer the version of this method that specifies a system ID, in order to resolve external references correctly.

Parameters:
is - an XML input stream
hb - the SAX1 handler
Throws:
IllegalArgumentException - if the input stream is null
SAXException
IOException
See Also:
parse(java.io.InputStream,org.xml.sax.helpers.DefaultHandler)

parse

public void parse(InputStream is,
                  HandlerBase hb,
                  String systemId)
           throws SAXException,
                  IOException
Parse the specified input stream, reporting SAX1 events to the given handler. Prefer the SAX2 version of this method, since the HandlerBase class is now deprecated.

Parameters:
is - an XML input stream
hb - the SAX1 handler
systemId - the system ID of the XML document
Throws:
IllegalArgumentException - if the input stream is null
SAXException
IOException
See Also:
parse(java.io.InputStream,org.xml.sax.helpers.DefaultHandler,java.lang.String)

parse

public void parse(InputStream is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the specified input stream, reporting SAX2 events to the given handler. Prefer the version of this method that specifies a system ID, in order to resolve external references correctly.

Parameters:
is - an XML input stream
dh - the SAX2 handler
Throws:
IllegalArgumentException - if the input stream is null
SAXException
IOException

parse

public void parse(InputStream is,
                  DefaultHandler dh,
                  String systemId)
           throws SAXException,
                  IOException
Parse the specified input stream, reporting SAX2 events to the given handler.

Parameters:
is - an XML input stream
dh - the SAX2 handler
systemId - the system ID of the XML document
Throws:
IllegalArgumentException - if the input stream is null
SAXException
IOException

parse

public void parse(String uri,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the content of the specified URI, reporting SAX1 events to the given handler. Prefer the SAX2 version of this method, since the HandlerBase class is now deprecated.

Parameters:
uri - an XML system ID
hb - the SAX1 handler
Throws:
IllegalArgumentException - if the URI is null
SAXException
IOException
See Also:
parse(java.lang.String,org.xml.sax.helpers.DefaultHandler)

parse

public void parse(String uri,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the content of the specified URI, reporting SAX2 events to the given handler.

Parameters:
uri - an XML system ID
dh - the SAX2 handler
Throws:
IllegalArgumentException - if the URI is null
SAXException
IOException

parse

public void parse(File f,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the content of the specified file, reporting SAX1 events to the given handler. Prefer the SAX2 version of this method, since the HandlerBase class is now deprecated.

Parameters:
f - an XML file
hb - the SAX1 handler
Throws:
IllegalArgumentException - if the file is null
SAXException
IOException
See Also:
parse(java.io.File,org.xml.sax.helpers.DefaultHandler)

parse

public void parse(File f,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the content of the specified file, reporting SAX2 events to the given handler.

Parameters:
f - an XML file
dh - the SAX2 handler
Throws:
IllegalArgumentException - if the file is null
SAXException
IOException

parse

public void parse(InputSource is,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the specified input source, reporting SAX1 events to the given handler. Prefer the SAX2 version of this method, since the HandlerBase class is now deprecated.

Parameters:
is - the SAX input source
hb - the SAX1 handler
Throws:
IllegalArgumentException - if the input source is null
SAXException
IOException
See Also:
parse(org.xml.sax.InputSource,org.xml.sax.helpers.DefaultHandler)

parse

public void parse(InputSource is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the specified input source, reporting SAX2 events to the given handler.

Parameters:
is - an XML file
dh - the SAX2 handler
Throws:
IllegalArgumentException - if the input source is null
SAXException
IOException

getParser

public abstract Parser getParser()
                          throws SAXException
Returns the underlying SAX1 parser.

Throws:
SAXException

getXMLReader

public abstract XMLReader getXMLReader()
                                throws SAXException
Returns the underlying SAX2 parser.

Throws:
SAXException
Since:
1.1

isNamespaceAware

public abstract boolean isNamespaceAware()
Indicates whether this parser is XML Namespace aware.


isValidating

public abstract boolean isValidating()
Indicates whether this parser will validate its input.


setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws SAXNotRecognizedException,
                                 SAXNotSupportedException
Sets the specified SAX2 parser property.

Parameters:
name - the name of the property
value - the value of the property
Throws:
SAXNotRecognizedException
SAXNotSupportedException

getProperty

public abstract Object getProperty(String name)
                            throws SAXNotRecognizedException,
                                   SAXNotSupportedException
Returns the value of the specified SAX2 parser property.

Parameters:
name - the name of the property
Throws:
SAXNotRecognizedException
SAXNotSupportedException

reset

public void reset()
Resets this parser to its original configuration.

Since:
1.3

getSchema

public Schema getSchema()
Returns the schema in use by this parser.

Since:
1.3

isXIncludeAware

public boolean isXIncludeAware()
Indicates whether this parser is XInclude-aware.

Since:
1.3