Movatterモバイル変換

Class SAXParser

java.lang.Object  |  +--javax.xml.parsers.SAXParser

public abstract classSAXParser

extends java.lang.Object

Defines the API that wraps anXMLReader implementation class. In JAXP 1.0, this class wrapped theParser interface, however this interface was replaced by theXMLReader. 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 theSAXParserFactory.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.

As the content is parsed by the underlying parser, methods of the givenHandlerBase or theDefaultHandler are called.

Implementors of this class which wrap an underlying implementation can consider using theParserAdapter class to initially adapt their SAX1 impelemntation to work under this revised class.

An implementation ofSAXParser isNOT 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 theSAXParser per thread or it is upto the application to make sure about the use ofSAXParser from more than one thread.

Since:

JAXP 1.0

SAXParser

protectedSAXParser()

parse

public voidparse(java.io.InputStream is,HandlerBase hb)           throwsSAXException,                  java.io.IOException

Parse the content of the givenInputStream instance as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters:

is - InputStream containing the content to be parsed.

hb - The SAX HandlerBase to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(java.io.InputStream is,HandlerBase hb,                  java.lang.String systemId)           throwsSAXException,                  java.io.IOException

Parse the content of the givenInputStream instance as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters:

is - InputStream containing the content to be parsed.

hb - The SAX HandlerBase to use.

systemId - The systemId which is needed for resolving relative URIs.

Throws:

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.

See Also:

version of this method instead.

parse

public voidparse(java.io.InputStream is,DefaultHandler dh)           throwsSAXException,                  java.io.IOException

Parse the content of the givenInputStream instance as XML using the specifiedDefaultHandler.

Parameters:

is - InputStream containing the content to be parsed.

dh - The SAX DefaultHandler to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(java.io.InputStream is,DefaultHandler dh,                  java.lang.String systemId)           throwsSAXException,                  java.io.IOException

Parse the content of the givenInputStream instance as XML using the specifiedDefaultHandler.

Parameters:

is - InputStream containing the content to be parsed.

dh - The SAX DefaultHandler to use.

systemId - The systemId which is needed for resolving relative URIs.

Throws:

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.

See Also:

version of this method instead.

parse

public voidparse(java.lang.String uri,HandlerBase hb)           throwsSAXException,                  java.io.IOException

Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as theHandlerBase class has been deprecated in SAX 2.0

Parameters:

uri - The location of the content to be parsed.

hb - The SAX HandlerBase to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(java.lang.String uri,DefaultHandler dh)           throwsSAXException,                  java.io.IOException

Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler.

Parameters:

uri - The location of the content to be parsed.

dh - The SAX DefaultHandler to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(java.io.File f,HandlerBase hb)           throwsSAXException,                  java.io.IOException

Parse the content of the file specified as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters:

f - The file containing the XML to parse

hb - The SAX HandlerBase to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(java.io.File f,DefaultHandler dh)           throwsSAXException,                  java.io.IOException

Parse the content of the file specified as XML using the specifiedDefaultHandler.

Parameters:

f - The file containing the XML to parse

dh - The SAX DefaultHandler to use.

Throws:

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.

See Also:

DocumentHandler

parse

public voidparse(InputSource is,HandlerBase hb)           throwsSAXException,                  java.io.IOException

Parse the content givenInputSource as XML using the specifiedHandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0

Parameters:

is - The InputSource containing the content to be parsed.

hb - The SAX HandlerBase to use.

Throws:

java.io.IOException - If any IO errors occur.

java.lang.IllegalArgumentException - If the InputSource is null.

SAXException - If the underlying parser throws a SAXException while parsing.

See Also:

DocumentHandler

parse

public voidparse(InputSource is,DefaultHandler dh)           throwsSAXException,                  java.io.IOException

Parse the content givenInputSource as XML using the specifiedDefaultHandler.

Parameters:

is - The InputSource containing the content to be parsed.

dh - The SAX DefaultHandler to use.

Throws:

java.io.IOException - If any IO errors occur.

java.lang.IllegalArgumentException - If the InputSource is null.

SAXException - If the underlying parser throws a SAXException while parsing.

See Also:

DocumentHandler

getParser

public abstractParsergetParser()                          throwsSAXException

Returns the SAX parser that is encapsultated by the implementation of this class.

Returns:

The SAX parser that is encapsultated by the implementation of this class.

getXMLReader

public abstractXMLReadergetXMLReader()                                throwsSAXException

Returns theXMLReader that is encapsulated by the implementation of this class.

Returns:

The XMLReader that is encapsulated by the implementation of this class.

isNamespaceAware

public abstract booleanisNamespaceAware()

Indicates whether or not this parser is configured to understand namespaces.

Returns:

true if this parser is configured to understand namespaces; false otherwise.

isValidating

public abstract booleanisValidating()

Indicates whether or not this parser is configured to validate XML documents.

Returns:

true if this parser is configured to validate XML documents; false otherwise.

setProperty

public abstract voidsetProperty(java.lang.String name,                                 java.lang.Object value)                          throwsSAXNotRecognizedException,SAXNotSupportedException

Sets the particular property in the underlying implementation ofXMLReader. A list of the core features and properties can be found at http://www.megginson.com/SAX/Java/features.html

Parameters:

name - The name of the property to be set.

value - The value of the property to be set.

Throws:

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.

See Also:

XMLReader.setProperty(java.lang.String, java.lang.Object)

getProperty

public abstract java.lang.ObjectgetProperty(java.lang.String name)                                      throwsSAXNotRecognizedException,SAXNotSupportedException

Returns the particular property requested for in the underlying implementation ofXMLReader.

Parameters:

name - The name of the property to be retrieved.

Returns:

Value of the requested property.

Throws:

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.

See Also:

XMLReader.getProperty(java.lang.String)