- java.lang.Object
- 
- javax.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.- Since:
- 1.4
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedSAXParserFactory()Protected constructor to force use ofnewInstance().
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract booleangetFeature(String name)Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.SchemagetSchema()Gets theSchemaobject specified through thesetSchema(Schema schema)method.booleanisNamespaceAware()Indicates whether or not the factory is configured to produce parsers which are namespace aware.booleanisValidating()Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.booleanisXIncludeAware()Get state of XInclude processing.static SAXParserFactorynewDefaultInstance()Creates a new instance of theSAXParserFactorybuiltin system-default implementation.static SAXParserFactorynewInstance()Obtain a new instance of aSAXParserFactory.static SAXParserFactorynewInstance(String factoryClassName, ClassLoader classLoader)Obtain a new instance of aSAXParserFactoryfrom class name.abstract SAXParsernewSAXParser()Creates a new instance of a SAXParser using the currently configured factory parameters.abstract voidsetFeature(String name, boolean value)Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.voidsetNamespaceAware(boolean awareness)Specifies that the parser produced by this code will provide support for XML namespaces.voidsetSchema(Schema schema)Set theSchemato be used by parsers created from this factory.voidsetValidating(boolean validating)Specifies that the parser produced by this code will validate documents as they are parsed.voidsetXIncludeAware(boolean state)Set state of XInclude processing.
 
- 
- 
- 
Constructor Detail- 
SAXParserFactoryprotected SAXParserFactory() Protected constructor to force use ofnewInstance().
 
- 
 - 
Method Detail- 
newDefaultInstancepublic static SAXParserFactory newDefaultInstance() Creates a new instance of theSAXParserFactorybuiltin system-default implementation.- Returns:
- A new instance of the SAXParserFactorybuiltin system-default implementation.
- Since:
- 9
 
 - 
newInstancepublic static SAXParserFactory newInstance() Obtain a new instance of aSAXParserFactory. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine theSAXParserFactoryimplementation class to load:- 
 Use the javax.xml.parsers.SAXParserFactorysystem property.
- 
 Use the configuration file "jaxp.properties". The file is in standard Propertiesformat and typically located in theconfdirectory of the Java installation. It contains the fully qualified name of the implementation class with the key being the system property defined above.The jaxp.properties file is read only once by the JAXP implementation and its values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in jaxp.properties after it has been read for the first time. 
- 
 Use the service-provider loading facility, defined by the ServiceLoaderclass, to attempt to locate and load an implementation of the service using the default loading mechanism: the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used.
- 
 Otherwise, the system-default implementation is returned. 
 Once an application has obtained a reference to a SAXParserFactoryit can use the factory to configure and obtain parser instances.Tip for Trouble-shootingSetting the jaxp.debugsystem property will cause this method to print a lot of debug messages toSystem.errabout what it is doing and where it is looking at.If you have problems loading SAXParsers, try:java -Djaxp.debug=1 YourProgram .... - Returns:
- A new instance of a SAXParserFactory.
- Throws:
- FactoryConfigurationError- in case of service configuration error or if the implementation is not available or cannot be instantiated.
 
- 
 Use the 
 - 
newInstancepublic static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader) Obtain a new instance of aSAXParserFactoryfrom class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.Once an application has obtained a reference to a SAXParserFactoryit can use the factory to configure and obtain parser instances.Tip for Trouble-shootingSetting the jaxp.debugsystem property will cause this method to print a lot of debug messages toSystem.errabout what it is doing and where it is looking at.If you have problems, try: java -Djaxp.debug=1 YourProgram .... - Parameters:
- factoryClassName- fully qualified factory class name that provides implementation of- javax.xml.parsers.SAXParserFactory.
- classLoader-- ClassLoaderused to load the factory class. If- nullcurrent- Thread's context classLoader is used to load the factory class.
- Returns:
- New instance of a SAXParserFactory
- Throws:
- FactoryConfigurationError- if- factoryClassNameis- null, or the factory class cannot be loaded, instantiated.
- Since:
- 1.6
- See Also:
- newInstance()
 
 - 
newSAXParserpublic abstract SAXParser newSAXParser() throws ParserConfigurationException, SAXException Creates a new instance of a SAXParser using the currently configured factory parameters.- Returns:
- A new instance of a SAXParser.
- Throws:
- ParserConfigurationException- if a parser cannot be created which satisfies the requested configuration.
- SAXException- for SAX errors.
 
 - 
setNamespaceAwarepublic void setNamespaceAware(boolean awareness) Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set tofalse.- Parameters:
- awareness- true if the parser produced by this code will provide support for XML namespaces; false otherwise.
 
 - 
setValidatingpublic void setValidating(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 tofalse.Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2.) To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the setValidating(boolean)methodfalse, then use thesetSchema(Schema)method to associate a schema to a parser.- Parameters:
- validating- true if the parser produced by this code will validate documents as they are parsed; false otherwise.
 
 - 
isNamespaceAwarepublic boolean isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware.- Returns:
- true if the factory is configured to produce parsers which are namespace aware; false otherwise.
 
 - 
isValidatingpublic boolean isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.- Returns:
- true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.
 
 - 
setFeaturepublic abstract void setFeature(String name, boolean value) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException 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/All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSINGfeature. When the feature is- 
     true: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registeredErrorHandler.fatalError(SAXParseException exception). SeeSAXParserparsemethods for handler specification.
- 
     When the feature is false, the implementation will processing XML according to the XML specifications without regard to possible implementation limits.
 - Parameters:
- name- The name of the feature to be set.
- value- The value of the feature to be set.
- Throws:
- ParserConfigurationException- if a parser cannot be created which satisfies the requested configuration.
- 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.
- NullPointerException- If the- nameparameter is null.
- See Also:
- XMLReader.setFeature(java.lang.String, boolean)
 
- 
     
 - 
getFeaturepublic abstract boolean getFeature(String name) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.- Parameters:
- name- The name of the property to be retrieved.
- Returns:
- Value of the requested property.
- Throws:
- ParserConfigurationException- if a parser cannot be created which satisfies the requested configuration.
- 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)
 
 - 
getSchemapublic Schema getSchema() Gets theSchemaobject specified through thesetSchema(Schema schema)method.- Returns:
- the Schemaobject that was last set through thesetSchema(Schema)method, or null if the method was not invoked since aSAXParserFactoryis created.
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
 
 - 
setSchemapublic void setSchema(Schema schema) Set theSchemato be used by parsers created from this factory.When a Schemais non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.When warnings/errors/fatal errors are found by the validator, the parser must handle them as if those errors were found by the parser itself. In other words, if the user-specified ErrorHandleris set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.A validator may modify the SAX event stream (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive those modified event stream. Initially, nullis set as theSchema.This processing will take effect even if the isValidating()method returnsfalse.It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSourceproperty and/or thehttp://java.sun.com/xml/jaxp/properties/schemaLanguageproperty in conjunction with a non-nullSchemaobject. Such configuration will cause aSAXExceptionexception when those properties are set on aSAXParser.Note for implementorsA parser must be able to work with any Schemaimplementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.- Parameters:
- schema-- Schemato use,- nullto remove a schema.
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
 
 - 
setXIncludeAwarepublic void setXIncludeAware(boolean state) Set state of XInclude processing.If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0. XInclude processing defaults to false.- Parameters:
- state- Set XInclude processing to- trueor- false
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
 
 - 
isXIncludeAwarepublic boolean isXIncludeAware() Get state of XInclude processing.- Returns:
- current state of XInclude processing
- Throws:
- UnsupportedOperationException- When implementation does not override this method
- Since:
- 1.5
 
 
- 
 
-