OpenJDK 27 · javax.xml.parsers.SAXParserFactory · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final String	DEFAULT_IMPL
private boolean	namespaceAware Should Parsers be namespace aware?
private boolean	validating Should Parsers be validating?

Access	Constructor and Description
protected	SAXParserFactory() Protected constructor to force use of `newInstance()`.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: Value of the requested property. getFeature(String The name of the property to be retrieved. name) Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
public Schema	Returns: the `Schema` object that was last set through the `setSchema(Schema)` method, or null if the method was not invoked since a `SAXParserFactory` is created. getSchema() Gets the `Schema` object specified through the `setSchema(Schema schema)` method.
public boolean	Returns: true if the factory is configured to produce parsers which are namespace aware; false otherwise. isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware.
public boolean	Returns: true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise. isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
public boolean	Returns: current state of XInclude processing isXIncludeAware() Get state of XInclude processing.
private static SAXParserFactory	makeNSAware(SAXParserFactory spf)
public static SAXParserFactory	Returns: A new instance of the `SAXParserFactory` builtin system-default implementation. newDefaultInstance() Creates a new instance of the `SAXParserFactory` builtin system-default implementation.
public static SAXParserFactory	Returns: a new instance of the `SAXParserFactory` builtin system-default implementation. newDefaultNSInstance() Creates a new NamespaceAware instance of the `SAXParserFactory` builtin system-default implementation.
public static SAXParserFactory	Returns: A new instance of a SAXParserFactory. newInstance() Obtains a new instance of a `SAXParserFactory`.
public static SAXParserFactory	Returns: New instance of a `SAXParserFactory` newInstance(String fully qualified factory class name that provides implementation of `javax.xml.parsers.SAXParserFactory`. factoryClassName, ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. classLoader) Obtain a new instance of a `SAXParserFactory` from class name.
public static SAXParserFactory	Returns: a new instance of the `SAXParserFactory` newNSInstance() Creates a new NamespaceAware instance of a `SAXParserFactory`.
public static SAXParserFactory	Returns: a new instance of the `SAXParserFactory` newNSInstance(String a fully qualified factory class name that provides implementation of `javax.xml.parsers.SAXParserFactory`. factoryClassName, ClassLoader the `ClassLoader` used to load the factory class. If it is `null`, the current `Thread`'s context classLoader is used to load the factory class. classLoader) Creates a new NamespaceAware instance of a `SAXParserFactory` from the class name.
public abstract SAXParser	Returns: A new instance of a SAXParser. newSAXParser() Creates a new instance of a SAXParser using the currently configured factory parameters.
public abstract void	setFeature(String The name of the feature to be set. name, boolean The value of the feature to be set. value) Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.
public void	setNamespaceAware(boolean true if the parser produced by this code will provide support for XML namespaces; false otherwise. awareness) Specifies that the parser produced by this code will provide support for XML namespaces.
public void	setSchema(Schema `Schema` to use, `null` to remove a schema. schema) Set the `Schema` to be used by parsers created from this factory.
public void	setValidating(boolean true if the parser produced by this code will validate documents as they are parsed; false otherwise. validating) Specifies that the parser produced by this code will validate documents as they are parsed.
public void	setXIncludeAware(final boolean Set XInclude processing to `true` or `false` state) Set state of XInclude processing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_IMPL	back to summary
private static final String DEFAULT_IMPL

namespaceAware	back to summary
private boolean namespaceAware Should Parsers be namespace aware?

validating	back to summary
private boolean validating Should Parsers be validating?

SAXParserFactory	back to summary
protected SAXParserFactory() Protected constructor to force use of `newInstance()`.

Method Detail

getFeature back to summary

getFeature	back to summary
public 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:String The name of the property to be retrieved. Returns:boolean Value of the requested property. Exceptions 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 `org.xml.sax.XMLReader#getProperty`

public 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:String: The name of the property to be retrieved.

Returns:boolean

Value of the requested property.

Exceptions

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

org.xml.sax.XMLReader#getProperty

getSchema back to summary

getSchema	back to summary
public Schema getSchema() Gets the `Schema` object specified through the `setSchema(Schema schema)` method. Returns:Schema the `Schema` object that was last set through the `setSchema(Schema)` method, or null if the method was not invoked since a `SAXParserFactory` is created. Exceptions UnsupportedOperationException: When implementation does not override this method Since 1.5

public Schema getSchema()

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:Schema

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a SAXParserFactory is created.

Exceptions

UnsupportedOperationException:: When implementation does not override this method

Since

1.5

isNamespaceAware	back to summary
public boolean isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware. Returns:boolean true if the factory is configured to produce parsers which are namespace aware; false otherwise.

isNamespaceAware

back to summary

public boolean isNamespaceAware()

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

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

isValidating	back to summary
public boolean isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse. Returns:boolean true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isValidating

back to summary

public boolean isValidating()

Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

Returns:boolean: true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isXIncludeAware	back to summary
public boolean isXIncludeAware() Get state of XInclude processing. Returns:boolean current state of XInclude processing Exceptions UnsupportedOperationException: When implementation does not override this method Since 1.5

isXIncludeAware

back to summary

public boolean isXIncludeAware()

Get state of XInclude processing.

Returns:boolean

current state of XInclude processing

Exceptions

UnsupportedOperationException:: When implementation does not override this method

Since

1.5

makeNSAware	back to summary
private static SAXParserFactory makeNSAware(SAXParserFactory spf)

newDefaultInstance back to summary

newDefaultInstance	back to summary
public static SAXParserFactory newDefaultInstance() Creates a new instance of the `SAXParserFactory` builtin system-default implementation. Returns:SAXParserFactory A new instance of the `SAXParserFactory` builtin system-default implementation. Since 9

public static SAXParserFactory newDefaultInstance()

Creates a new instance of the SAXParserFactory builtin system-default implementation.

Returns:SAXParserFactory: A new instance of the SAXParserFactory builtin system-default implementation.
Since: 9

newDefaultNSInstance back to summary

newDefaultNSInstance	back to summary
public static SAXParserFactory newDefaultNSInstance() Creates a new NamespaceAware instance of the `SAXParserFactory` builtin system-default implementation. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newDefaultInstance()`, this method must set NamespaceAware to true. Returns:SAXParserFactory a new instance of the `SAXParserFactory` builtin system-default implementation. Since 13

public static SAXParserFactory newDefaultNSInstance()

Creates a new NamespaceAware instance of the SAXParserFactory builtin system-default implementation. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newDefaultInstance(), this method must set NamespaceAware to true.

Returns:SAXParserFactory: a new instance of the SAXParserFactory builtin system-default implementation.
Since: 13

newInstance back to summary

newInstance	back to summary
public static SAXParserFactory newInstance() Obtains a new instance of a `SAXParserFactory`. This method uses the JAXP Lookup Mechanism to determine the `SAXParserFactory` implementation class to load. Once an application has obtained a reference to a `SAXParserFactory`, it can use the factory to configure and obtain parser instances. Tip for Trouble-shooting Setting the `jaxp.debug` system property will cause this method to print a lot of debug messages to `System.err` about what it is doing and where it is looking at. If you have problems loading `SAXParser`s, try: java -Djaxp.debug=1 YourProgram .... Returns:SAXParserFactory A new instance of a SAXParserFactory. Exceptions FactoryConfigurationError: in case of service configuration error or if the implementation is not available or cannot be instantiated.

public static SAXParserFactory newInstance()

Obtains a new instance of a SAXParserFactory. This method uses the JAXP Lookup Mechanism to determine the SAXParserFactory implementation class to load.

Once an application has obtained a reference to a SAXParserFactory, it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems loading SAXParsers, try:

java -Djaxp.debug=1 YourProgram ....

Returns:SAXParserFactory

A new instance of a SAXParserFactory.

Exceptions

FactoryConfigurationError:: in case of service configuration error or if the implementation is not available or cannot be instantiated.

newInstance back to summary

newInstance	back to summary
public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader) Obtain a new instance of a `SAXParserFactory` from 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 `SAXParserFactory` it can use the factory to configure and obtain parser instances. Tip for Trouble-shooting Setting the `jaxp.debug` system property will cause this method to print a lot of debug messages to `System.err` about what it is doing and where it is looking at. If you have problems, try: java -Djaxp.debug=1 YourProgram .... Parameters factoryClassName:String fully qualified factory class name that provides implementation of `javax.xml.parsers.SAXParserFactory`. classLoader:ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. Returns:SAXParserFactory New instance of a `SAXParserFactory` Exceptions FactoryConfigurationError: if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated. Since 1.6 See Also `newInstance()`

public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader)

Obtain a new instance of a SAXParserFactory from 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 SAXParserFactory it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems, try:

java -Djaxp.debug=1 YourProgram ....

Parameters

factoryClassName:String: fully qualified factory class name that provides implementation of javax.xml.parsers.SAXParserFactory.
classLoader:ClassLoader: ClassLoader used to load the factory class. If null current Thread's context classLoader is used to load the factory class.

Returns:SAXParserFactory

New instance of a SAXParserFactory

Exceptions

FactoryConfigurationError:: if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since

1.6

See Also

newInstance()

newNSInstance back to summary

newNSInstance	back to summary
public static SAXParserFactory newNSInstance() Creates a new NamespaceAware instance of a `SAXParserFactory`. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newInstance()`, this method must set NamespaceAware to true. Returns:SAXParserFactory a new instance of the `SAXParserFactory` Exceptions FactoryConfigurationError: in case of service configuration error or if the implementation is not available or cannot be instantiated. Since 13

public static SAXParserFactory newNSInstance()

Creates a new NamespaceAware instance of a SAXParserFactory. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newInstance(), this method must set NamespaceAware to true.

Returns:SAXParserFactory

a new instance of the SAXParserFactory

Exceptions

FactoryConfigurationError:: in case of service configuration error or if the implementation is not available or cannot be instantiated.

Since

newNSInstance back to summary

newNSInstance	back to summary
public static SAXParserFactory newNSInstance(String factoryClassName, ClassLoader classLoader) Creates a new NamespaceAware instance of a `SAXParserFactory` from the class name. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newInstance(java.lang.String, java.lang.ClassLoader)`, this method must set NamespaceAware to true. Parameters factoryClassName:String a fully qualified factory class name that provides implementation of `javax.xml.parsers.SAXParserFactory`. classLoader:ClassLoader the `ClassLoader` used to load the factory class. If it is `null`, the current `Thread`'s context classLoader is used to load the factory class. Returns:SAXParserFactory a new instance of the `SAXParserFactory` Exceptions FactoryConfigurationError: if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated. Since 13

public static SAXParserFactory newNSInstance(String factoryClassName, ClassLoader classLoader)

Creates a new NamespaceAware instance of a SAXParserFactory from the class name. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newInstance(java.lang.String, java.lang.ClassLoader), this method must set NamespaceAware to true.

Parameters

factoryClassName:String: a fully qualified factory class name that provides implementation of javax.xml.parsers.SAXParserFactory.
classLoader:ClassLoader: the ClassLoader used to load the factory class. If it is null, the current Thread's context classLoader is used to load the factory class.

Returns:SAXParserFactory

a new instance of the SAXParserFactory

Exceptions

FactoryConfigurationError:: if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since

newSAXParser	back to summary
public abstract SAXParser newSAXParser() throws ParserConfigurationException, SAXException Creates a new instance of a SAXParser using the currently configured factory parameters. Returns:SAXParser A new instance of a SAXParser. Exceptions ParserConfigurationException: if a parser cannot be created which satisfies the requested configuration. SAXException: for SAX errors.

newSAXParser

back to summary

public abstract SAXParser newSAXParser() throws ParserConfigurationException, SAXException

Creates a new instance of a SAXParser using the currently configured factory parameters.

Returns:SAXParser

A new instance of a SAXParser.

Exceptions

ParserConfigurationException:: if a parser cannot be created which satisfies the requested configuration.
SAXException:: for SAX errors.

setFeature back to summary

setFeature	back to summary
public 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 `javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING` feature. 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 registered `org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)`. See `SAXParser` `parse` methods 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:String The name of the feature to be set. value:boolean The value of the feature to be set. Exceptions 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 `name` parameter is null. See Also `org.xml.sax.XMLReader#setFeature`

public 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 javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING feature. 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 registered org.xml.sax.ErrorHandler#fatalError(SAXParseException exception). See SAXParser parse methods 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:String: The name of the feature to be set.
value:boolean: The value of the feature to be set.

Exceptions

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 name parameter is null.

See Also

org.xml.sax.XMLReader#setFeature

setNamespaceAware back to summary

setNamespaceAware	back to summary
public 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 to `false`. Parameters awareness:boolean true if the parser produced by this code will provide support for XML namespaces; false otherwise.

public 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 to false.

Parameters

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

setSchema back to summary

setSchema	back to summary
public void setSchema(Schema schema) Set the `Schema` to be used by parsers created from this factory. When a `Schema` is 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 `org.xml.sax.ErrorHandler` is 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, `null` is set as the `Schema`. This processing will take effect even if the `isValidating()` method returns `false`. It is an error to use the `http://java.sun.com/xml/jaxp/properties/schemaSource` property and/or the `http://java.sun.com/xml/jaxp/properties/schemaLanguage` property in conjunction with a non-null `Schema` object. Such configuration will cause a `SAXException` exception when those properties are set on a `SAXParser`. Note for implementors A parser must be able to work with any `Schema` implementation. 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:Schema `Schema` to use, `null` to remove a schema. Exceptions UnsupportedOperationException: When implementation does not override this method Since 1.5

public void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is 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 org.xml.sax.ErrorHandler is 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, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a non-null Schema object. Such configuration will cause a SAXException exception when those properties are set on a SAXParser.

Note for implementors

A parser must be able to work with any Schema implementation. 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:Schema: Schema to use, null to remove a schema.

Exceptions

UnsupportedOperationException:: When implementation does not override this method

Since

1.5

setValidating back to summary

setValidating	back to summary
public 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 to `false`. 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)` method `false`, then use the `setSchema(Schema)` method to associate a schema to a parser. Parameters validating:boolean true if the parser produced by this code will validate documents as they are parsed; false otherwise.

public 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 to false.

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) method false, then use the setSchema(Schema) method to associate a schema to a parser.

Parameters

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

setXIncludeAware back to summary

setXIncludeAware	back to summary
public void setXIncludeAware(final 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:boolean Set XInclude processing to `true` or `false` Exceptions UnsupportedOperationException: When implementation does not override this method Since 1.5

public void setXIncludeAware(final 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:boolean: Set XInclude processing to true or false

Exceptions

UnsupportedOperationException:: When implementation does not override this method

Since

1.5

public abstract Class SAXParserFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Tip for Trouble-shooting

Tip for Trouble-shooting

Note for implementors