|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.parsers.SAXParser
public abstract class SAXParser
Defines the API that represents a simple SAX parser. 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 an InputStream
As the content is parsed by the underlying parser, methods of the given DefaultHandler are called.
An implementation of SAXParser is NOT guaranteed to behave as per the specification if it is used concurrently by two or more threads. It is recommended to have one instance of the SAXParser per thread or it is upto the application to make sure about the use of SAXParser from more than one thread.
Constructor Summary | |
---|---|
protected |
SAXParser()
Constructor for SAXParser. |
Method Summary | |
---|---|
abstract Parser |
getParser()
Deprecated. Parser class is deprecated, use instead getXMLReader() |
abstract java.lang.Object |
getProperty(java.lang.String name)
Returns the particular property requested for in the underlying implementation of XMLReader . |
abstract XMLReader |
getXMLReader()
Returns the XMLReader that 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. |
void |
parse(java.io.File file,
DefaultHandler dh)
Parse the content of the file specified as XML using the specified DefaultHandler . |
abstract void |
parse(InputSource is,
DefaultHandler dh)
Parse the content of the given InputStream instance as XML using the specified DefaultHandler. |
void |
parse(java.io.InputStream is,
DefaultHandler dh)
Parse the content of the given InputStream
instance as XML using the specified
DefaultHandler . |
void |
parse(java.io.InputStream is,
DefaultHandler dh,
java.lang.String systemId)
Parse the content of the given InputStream
instance as XML using the specified
DefaultHandler . |
void |
parse(java.lang.String uri,
DefaultHandler dh)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler . |
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()
Method Detail |
---|
public abstract void parse(InputSource is, DefaultHandler dh) throws SAXException, java.io.IOException
is
- - InputStream containing the content to be parsed.dh
- - The SAX DefaultHandler to use.
java.io.IOException
- - If any IO errors occur.
java.lang.IllegalArgumentException
- - If the given InputStream is null.
SAXException
- - If the underlying parser throws a SAXException while parsing.public abstract boolean isNamespaceAware()
public abstract boolean isValidating()
public abstract XMLReader getXMLReader() throws SAXException
XMLReader
that is encapsulated by the
implementation of this class.
SAXException
public abstract void setProperty(java.lang.String name, java.lang.Object value) throws SAXNotRecognizedException, SAXNotSupportedException
XMLReader
.
A list of the core features and properties can be found at
http://www.megginson.com/SAX/Java/features.html
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.XMLReader.setProperty(java.lang.String, java.lang.Object)
public abstract java.lang.Object getProperty(java.lang.String name) throws SAXNotRecognizedException, SAXNotSupportedException
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.XMLReader.getProperty(java.lang.String)
public void parse(java.io.File file, DefaultHandler dh) throws SAXException, java.io.IOException
DefaultHandler
.
f
- The file containing the XML to parsedh
- The SAX DefaultHandler to use.
java.io.IOException
- If any IO errors occur.
java.lang.IllegalArgumentException
- If the File object is null.
SAXException
- If the underlying parser throws a
SAXException while parsing.public void parse(java.io.InputStream is, DefaultHandler dh) throws 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.io.IOException
- If any IO errors occur.
java.lang.IllegalArgumentException
- If the given InputStream is null.
SAXException
- If the underlying parser throws a
SAXException while parsing.public void parse(java.io.InputStream is, DefaultHandler dh, java.lang.String systemId) throws 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.io.IOException
- If any IO errors occur.
java.lang.IllegalArgumentException
- If the given InputStream is null.
SAXException
- If the underlying parser throws a
SAXException while parsing.
version of this method instead.public void parse(java.lang.String uri, DefaultHandler dh) throws SAXException, java.io.IOException
DefaultHandler
.
uri
- The location of the content to be parsed.dh
- The SAX DefaultHandler to use.
java.io.IOException
- If any IO errors occur.
java.lang.IllegalArgumentException
- If the uri is null.
SAXException
- If the underlying parser throws a
SAXException while parsing.public abstract Parser getParser() throws SAXException
SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |