javax.xml.parsers

Class SAXParserFactory

Known Direct Subclasses:
GnomeSAXParserFactory, JAXPFactory, SAXParserFactory

public abstract class SAXParserFactory
extends Object

Factory for obtaining SAX parsers. Instances of this class are not guaranteed to be thread safe.

Constructor Summary

SAXParserFactory()

Method Summary

abstract boolean
getFeature(String name)
Returns the specified feature for SAX2 parsers obtained from this factory.
Schema
getSchema()
Returns the schema.
boolean
isNamespaceAware()
Indicates whether parsers obtained from this factory will be XML Namespace aware.
boolean
isValidating()
Indicates whether parsers obtained from this factory will validate their input.
boolean
isXIncludeAware()
Indicates whether parsers obtained from this factory will be XInclude aware.
static SAXParserFactory
newInstance()
Creates a new factory instance.
abstract SAXParser
newSAXParser()
Creates a new parser instance using the currently specified factory configuration.
abstract void
setFeature(String name, boolean value)
Sets the specified feature for SAX2 parsers obtained from this factory.
void
setNamespaceAware(boolean awareness)
Sets whether parsers obtained from this factory will be XML Namespace aware.
void
setSchema(Schema schema)
Sets the schema.
void
setValidating(boolean validating)
Sets whether parsers obtained from this factory will validate their input.
void
setXIncludeAware(boolean state)
Sets whether parsers obtained from this factory will be XInclude aware.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SAXParserFactory

protected SAXParserFactory()

Method Details

getFeature

public abstract boolean getFeature(String name)
            throws ParserConfigurationException,
                   SAXNotRecognizedException,
                   SAXNotSupportedException
Returns the specified feature for SAX2 parsers obtained from this factory.
Parameters:
name - the feature name

getSchema

public Schema getSchema()
Returns the schema.
Since:
1.3

isNamespaceAware

public boolean isNamespaceAware()
Indicates whether parsers obtained from this factory will be XML Namespace aware.

isValidating

public boolean isValidating()
Indicates whether parsers obtained from this factory will validate their input.

isXIncludeAware

public boolean isXIncludeAware()
Indicates whether parsers obtained from this factory will be XInclude aware.
Since:
1.3

newInstance

public static SAXParserFactory newInstance()
            throws FactoryConfigurationError
Creates a new factory instance. The implementation class to load is the first found in the following locations:
  1. the javax.xml.parsers.SAXParserFactory system property
  2. the above named property value in the $JAVA_HOME/lib/jaxp.properties file
  3. the class name specified in the META-INF/services/javax.xml.parsers.SAXParserFactory system resource
  4. the default factory class

newSAXParser

public abstract SAXParser newSAXParser()
            throws ParserConfigurationException,
                   SAXException
Creates a new parser instance using the currently specified factory configuration.
Throws:
ParserConfigurationException - if the specified configuration is not supported

setFeature

public abstract void setFeature(String name,
                                boolean value)
            throws ParserConfigurationException,
                   SAXNotRecognizedException,
                   SAXNotSupportedException
Sets the specified feature for SAX2 parsers obtained from this factory.
Parameters:
name - the feature name
value - the featurevalue

setNamespaceAware

public void setNamespaceAware(boolean awareness)
Sets whether parsers obtained from this factory will be XML Namespace aware.

setSchema

public void setSchema(Schema schema)
Sets the schema.
Since:
1.3
See Also:
getSchema()

setValidating

public void setValidating(boolean validating)
Sets whether parsers obtained from this factory will validate their input.

setXIncludeAware

public void setXIncludeAware(boolean state)
Sets whether parsers obtained from this factory will be XInclude aware.
Since:
1.3

SAXParserFactory.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.