java.lang.Object | |
↳ | javax.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
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.
Implementations of this class which wrap an underlying implementation
can consider using the ParserAdapter
class to initially adapt their SAX1 implementation to work under
this revised class.
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Protected constructor to prevent instantiation. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the SAX parser that is encapsulated by the
implementation of this class.
| |||||||||||
Returns the particular property requested for in the underlying
implementation of | |||||||||||
Get a reference to the the | |||||||||||
Returns the
XMLReader that is encapsulated by the
implementation of this class. | |||||||||||
Indicates whether or not this parser is configured to
understand namespaces.
| |||||||||||
Indicates whether or not this parser is configured to
validate XML documents.
| |||||||||||
Get the XInclude processing mode for this parser. | |||||||||||
Parse the content of the given | |||||||||||
Parse the content given
InputSource
as XML using the specified
DefaultHandler . | |||||||||||
Parse the content described by the giving Uniform Resource
Identifier (URI) as XML using the specified
HandlerBase . | |||||||||||
Parse the content described by the giving Uniform Resource
Identifier (URI) as XML using the specified
DefaultHandler . | |||||||||||
Parse the content of the file specified as XML using the
specified
DefaultHandler . | |||||||||||
Parse the content of the given
InputStream
instance as XML using the specified
DefaultHandler . | |||||||||||
Parse the content of the given
InputStream
instance as XML using the specified
DefaultHandler . | |||||||||||
Parse the content given
InputSource
as XML using the specified
HandlerBase . | |||||||||||
Parse the content of the given | |||||||||||
Parse the content of the file specified as XML using the
specified
HandlerBase . | |||||||||||
Reset this | |||||||||||
Sets the particular property in the underlying implementation of
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Protected constructor to prevent instantiation.
Use newSAXParser()
.
Returns the SAX parser that is encapsulated by the implementation of this class.
SAXException | If any SAX errors occur during processing. |
---|
Returns the particular property requested for in the underlying
implementation of XMLReader
.
name | The name of the property to be retrieved. |
---|
SAXNotRecognizedException | When the underlying XMLReader does not recognize the property name. |
---|---|
SAXNotSupportedException | When the underlying XMLReader recognizes the property name but doesn't support the property. |
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 useUnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|
Returns the XMLReader
that is encapsulated by the
implementation of this class.
SAXException | If any SAX errors occur during processing. |
---|
Indicates whether or not this parser is configured to understand namespaces.
Indicates whether or not this parser is configured to validate XML documents.
Get the XInclude processing mode for this parser.
isXIncludeAware()
when this parser was created from factory.UnsupportedOperationException | For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
---|
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. |
IllegalArgumentException | If the given InputStream is
null . |
---|---|
IOException | If any IO error occurs interacting with the
InputStream . |
SAXException | If any SAX errors occur during processing. |
Parse the content given InputSource
as XML using the specified
DefaultHandler
.
is | The InputSource containing the content to be parsed. |
---|---|
dh | The SAX DefaultHandler to use. |
IllegalArgumentException | If the InputSource object
is null . |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
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. |
IllegalArgumentException | If the uri is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
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. |
IllegalArgumentException | If the uri is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
Parse the content of the file specified as XML using the
specified DefaultHandler
.
f | The file containing the XML to parse |
---|---|
dh | The SAX DefaultHandler to use. |
IllegalArgumentException | If the File object is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
Parse the content of the given InputStream
instance as XML using the specified
DefaultHandler
.
is | InputStream containing the content to be parsed. |
---|---|
dh | The SAX DefaultHandler to use. |
IllegalArgumentException | If the given InputStream is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
Parse the content of the given 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. |
IllegalArgumentException | If the given InputStream is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
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. |
IllegalArgumentException | If the InputSource object
is null . |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
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. |
IllegalArgumentException | If the given InputStream is null. |
---|---|
SAXException | If parse produces a SAX error. |
IOException | If an IO error occurs interacting with the
InputStream . |
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 parse |
---|---|
hb | The SAX HandlerBase to use. |
IllegalArgumentException | If the File object is null. |
---|---|
IOException | If any IO errors occur. |
SAXException | If any SAX errors occur during processing. |
Reset this SAXParser
to its original configuration.
SAXParser
is reset to the same state as when it was created with
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. equals(Object)
. It is guaranteed to have a functionally equal
Schema
.
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. |
SAXNotRecognizedException | When the underlying XMLReader does not recognize the property name. |
---|---|
SAXNotSupportedException | When the underlying XMLReader recognizes the property name but doesn't support the property. |