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.
As the content is parsed by the underlying parser, methods of the
given
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.
getParser
public abstract Parser getParser()
throws SAXException
Returns the SAX parser that is encapsultated by the
implementation of this class.
- The SAX parser that is encapsultated by the
implementation of this class.
getProperty
public abstract Object getProperty(String name)
throws SAXNotRecognizedException,
SAXNotSupportedException
Returns the particular property requested for in the underlying
implementation of
XMLReader
.
name
- The name of the property to be retrieved.
- Value of the requested property.
getSchema
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
getXMLReader
public abstract XMLReader getXMLReader()
throws SAXException
Returns the
XMLReader
that is encapsulated by the
implementation of this class.
- The XMLReader that is encapsulated by the
implementation of this class.
isNamespaceAware
public abstract boolean isNamespaceAware()
Indicates whether or not this parser is configured to
understand namespaces.
- true if this parser is configured to
understand namespaces; false otherwise.
isValidating
public abstract boolean isValidating()
Indicates whether or not this parser is configured to
validate XML documents.
- true if this parser is configured to
validate XML documents; false otherwise.
isXIncludeAware
public boolean isXIncludeAware()
Get the XInclude processing mode for this parser.
parse
public void parse(File f,
HandlerBase hb)
throws SAXException,
IOException
Parse the content of the file specified 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
f
- The file containing the XML to parsehb
- The SAX HandlerBase to use.
parse
public void parse(File f,
DefaultHandler dh)
throws SAXException,
IOException
Parse the content of the file specified as XML using the
specified
DefaultHandler
.
f
- The file containing the XML to parsedh
- The SAX DefaultHandler to use.
parse
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
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.
parse
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
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.
parse
public void parse(InputStream is,
DefaultHandler dh)
throws SAXException,
IOException
Parse the content of the given
java.io.InputStream
instance as XML using the specified
DefaultHandler
.
is
- InputStream containing the content to be parsed.dh
- The SAX DefaultHandler to use.
parse
public void parse(InputStream is,
DefaultHandler dh,
String systemId)
throws SAXException,
IOException
Parse the content of the given
java.io.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.
parse
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
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.
parse
public void parse(String uri,
DefaultHandler dh)
throws SAXException,
IOException
Parse the content described by the giving Uniform Resource
Identifier (URI) as XML using the specified
DefaultHandler
.
uri
- The location of the content to be parsed.dh
- The SAX DefaultHandler to use.
parse
public void parse(InputSource is,
HandlerBase hb)
throws SAXException,
IOException
Parse the content given
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.
reset
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
SAXParser
s
thus saving resources associated with the creation of new
SAXParser
s.
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
.