FileDocCategorySizeDatePackage
SAXParserFactory.javaAPI DocphoneME MR2 API (J2ME)7748Wed May 02 18:00:34 BST 2007javax.xml.parsers

SAXParserFactory

public abstract class SAXParserFactory extends Object
Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.

An implementation of the SAXParserFactory class is NOT guaranteed to be thread safe. It is up to the user application to make sure about the use of the SAXParserFactory from more than one thread. Alternatively the application can have one instance of the SAXParserFactory per thread. An application can use the same instance of the factory to obtain one or more instances of the SAXParser provided the instance of the factory isn't being used in more than one thread at a time.

The static newInstance method returns a new concrete implementation of this class.

since
JAXP 1.0
version
1.0

Fields Summary
private boolean
namespaceAware
private boolean
validating
Constructors Summary
protected SAXParserFactory()


      
    
Methods Summary
public abstract booleangetFeature(java.lang.String name)
Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.

param
name The name of the property to be retrieved.
return
Value of the requested property.
exception
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
exception
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
see
org.xml.sax.XMLReader#getProperty

public booleanisNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.

return
true if the factory is configured to produce parsers which are namespace aware; false otherwise.

        return namespaceAware;
    
public booleanisValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

return
true if the factory is configured to produce parsers which validate the XML content during parse.

        return validating;
    
public static javax.xml.parsers.SAXParserFactorynewInstance()
Obtain a new instance of a SAXParserFactory. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine the SAXParserFactory implementation class to load:
  • Use the javax.xml.parsers.SAXParserFactory system property.
  • Use the properties file "lib/jaxp.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above.
  • Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.parsers.SAXParserFactory in jars available to the runtime.
  • Platform default SAXParserFactory instance.
Once an application has obtained a reference to a SAXParserFactory it can use the factory to configure and obtain parser instances.

return
A new instance of a SAXParserFactory.
exception
FactoryConfigurationError if the implementation is not available or cannot be instantiated.

          return new com.sun.ukit.jaxp.ParserFactory();
    
public abstract javax.xml.parsers.SAXParsernewSAXParser()
Creates a new instance of a SAXParser using the currently configured factory parameters.

return
A new instance of a SAXParser.
exception
ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.

public abstract voidsetFeature(java.lang.String name, boolean value)
Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader. A list of the core features and properties can be found at http://www.saxproject.org/?selected=get-set

param
name The name of the feature to be set.
param
value The value of the feature to be set.
exception
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
exception
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
see
org.xml.sax.XMLReader#setFeature

public voidsetNamespaceAware(boolean awareness)
Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false.

param
awareness true if the parser produced by this code will provide support for XML namespaces; false otherwise.

        namespaceAware = awareness;
    
public voidsetValidating(boolean validating)
Specifies that the parser produced by this code will validate documents as they are parsed. By default the value of this is set to false.

param
validating true if the parser produced by this code will validate documents as they are parsed; false otherwise.

 
        // NOTE: the factory does not currently support a validating parser
        validating = false;