This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.xml.parsers
class SAXParser

java.lang.Object extended by javax.xml.parsers.SAXParser
Most common way to construct:

SAXParserFactory factory = …;

SAXParser parser = factory.newSAXParser();

Based on 222 examples 

public abstract class SAXParser
extends Object

Defines the API that wraps an {@link org.xml.sax.XMLReader} implementation class. In JAXP 1.0, this class wrapped the {@link org.xml.sax.Parser} interface, however this interface was replaced by the {@link org.xml.sax.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 {@link javax.xml.parsers.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 {@link org.xml.sax.HandlerBase} or the {@link org.xml.sax.helpers.DefaultHandler} are called.

Implementors of this class which wrap an underlaying implementation can consider using the {@link org.xml.sax.helpers.ParserAdapter} class to initially adapt their SAX1 impelemntation to work under this revised class.

Constructor Summary
protected
SAXParser()

          Protected constructor to prevent instaniation.
 
Method Summary
abstract Parser
getParser()

          Returns the SAX parser that is encapsultated by the implementation of this class.
abstract Object
getProperty(String name)

          Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
 Schema
getSchema()

          Get a reference to the the javax.xml.validation.Schema being used by the XML processor.
abstract XMLReader
getXMLReader()

          Returns the org.xml.sax.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.
 boolean
isXIncludeAware()

          Get the XInclude processing mode for this parser.
 void
parse(File f, DefaultHandler dh)

          Parse the content of the file specified as XML using the specified org.xml.sax.helpers.DefaultHandler.
 void
parse(File f, HandlerBase hb)

          Parse the content of the file specified as XML using the specified org.xml.sax.HandlerBase.
 void
parse(InputSource is, DefaultHandler dh)

          Parse the content given org.xml.sax.InputSource as XML using the specified org.xml.sax.helpers.DefaultHandler.
 void
parse(InputSource is, HandlerBase hb)

          Parse the content given org.xml.sax.InputSource as XML using the specified org.xml.sax.HandlerBase.
 void
parse(InputStream is, DefaultHandler dh)

          Parse the content of the given java.io.InputStream instance as XML using the specified org.xml.sax.helpers.DefaultHandler.
 void
parse(InputStream is, DefaultHandler dh, String systemId)

          Parse the content of the given java.io.InputStream instance as XML using the specified org.xml.sax.helpers.DefaultHandler.
 void
parse(InputStream is, HandlerBase hb)

          Parse the content of the given java.io.InputStream instance as XML using the specified org.xml.sax.HandlerBase.
 void
parse(InputStream is, HandlerBase hb, String systemId)

          Parse the content of the given java.io.InputStream instance as XML using the specified org.xml.sax.HandlerBase.
 void
parse(String uri, DefaultHandler dh)

          Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified org.xml.sax.helpers.DefaultHandler.
 void
parse(String uri, HandlerBase hb)

          Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified org.xml.sax.HandlerBase.
 void
reset()

          Reset this SAXParser to its original configuration.
abstract void
setProperty(String name, Object value)

          Sets the particular property in the underlying implementation of org.xml.sax.XMLReader.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAXParser

protected SAXParser()

Protected constructor to prevent instaniation. Use {@link javax.xml.parsers.SAXParserFactory#newSAXParser()}.

Method Detail

getParser

public abstract Parser getParser()
                          throws SAXException
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.
Throws:
SAXException - If any SAX errors occur during processing.

getProperty

public abstract Object getProperty(String name)
                            throws SAXNotRecognizedException,
                                   SAXNotSupportedException

Returns the particular property requested for in the underlying implementation of {@link org.xml.sax.XMLReader}.

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.

getSchema

public Schema getSchema()

Get a reference to the the {@link Schema} being used by the XML processor.

If no schema is being used, null is returned.

Returns:
{@link Schema} being used or null if none in use

getXMLReader

public abstract XMLReader getXMLReader()
                                throws SAXException
Returns the {@link org.xml.sax.XMLReader} that is encapsulated by the implementation of this class.

Returns:
The XMLReader that is encapsulated by the implementation of this class.
Throws:
SAXException - If any SAX errors occur during processing.

isNamespaceAware

public abstract boolean isNamespaceAware()
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 boolean isValidating()
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.

isXIncludeAware

public boolean isXIncludeAware()

Get the XInclude processing mode for this parser.

Returns:
the return value of the {@link SAXParserFactory#isXIncludeAware()} when this parser was created from factory.

parse

public void parse(File f,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the content of the file specified as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters:
f - The file containing the XML to parse
dh - The SAX DefaultHandler to use.
Throws:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(File f,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the content of the file specified as XML using the specified {@link org.xml.sax.HandlerBase}. 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:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(InputSource is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters:
is - The InputSource containing the content to be parsed.
dh - The SAX DefaultHandler to use.
Throws:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(InputSource is,
                  HandlerBase hb)
           throws SAXException,
                  IOException
Parse the content given {@link org.xml.sax.InputSource} as XML using the specified {@link org.xml.sax.HandlerBase}. 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:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(InputStream is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

Parameters:
is - InputStream containing the content to be parsed.
dh - The SAX DefaultHandler to use.
Throws:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(InputStream is,
                  DefaultHandler dh,
                  String systemId)
           throws SAXException,
                  IOException
Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.helpers.DefaultHandler}.

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:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

parse

public void parse(InputStream is,
                  HandlerBase hb)
           throws SAXException,
                  IOException

Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}. 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:
SAXException - If parse produces a SAX error.
IOException - If an IO error occurs interacting with the InputStream.

parse

public void parse(InputStream is,
                  HandlerBase hb,
                  String systemId)
           throws SAXException,
                  IOException

Parse the content of the given {@link java.io.InputStream} instance as XML using the specified {@link org.xml.sax.HandlerBase}. 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:
SAXException - If any SAX errors occur during processing.
IOException - If any IO error occurs interacting with the InputStream.

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 {@link org.xml.sax.helpers.DefaultHandler}.

Parameters:
uri - The location of the content to be parsed.
dh - The SAX DefaultHandler to use.
Throws:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

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 {@link org.xml.sax.HandlerBase}. Use of the DefaultHandler version of this method is recommended as the HandlerBase 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:
SAXException - If any SAX errors occur during processing.
IOException - If any IO errors occur.

reset

public void reset()

Reset this SAXParser to its original configuration.

SAXParser is reset to the same state as when it was created with {@link SAXParserFactory#newSAXParser()}. reset() is designed to allow the reuse of existing SAXParsers thus saving resources associated with the creation of new SAXParsers.

The reset SAXParser is not guaranteed to have the same {@link Schema} Object, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal Schema.

setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws SAXNotRecognizedException,
                                 SAXNotSupportedException

Sets the particular property in the underlying implementation of {@link org.xml.sax.XMLReader}. A list of the core features and properties can be found at http://sax.sourceforge.net/?selected=get-set.

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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.