SAXParserFactory
abstract class SAXParserFactory
kotlin.Any | |
↳ | javax.xml.parsers.SAXParserFactory |
Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.
Summary
Protected constructors | |
---|---|
Protected constructor to force use of |
Public methods | |
---|---|
abstract Boolean |
getFeature(name: String!) Returns the particular property requested for in the underlying implementation of org. |
open Schema! |
Gets the |
open Boolean |
Indicates whether or not the factory is configured to produce parsers which are namespace aware. |
open Boolean |
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse. |
open Boolean |
Get state of XInclude processing. |
open static SAXParserFactory! |
Returns Android's implementation of |
open static SAXParserFactory! |
newInstance(factoryClassName: String!, classLoader: ClassLoader!) Returns an instance of the named implementation of |
abstract SAXParser! |
Creates a new instance of a SAXParser using the currently configured factory parameters. |
abstract Unit |
setFeature(name: String!, value: Boolean) Sets the particular feature in the underlying implementation of org. |
open Unit |
setNamespaceAware(awareness: Boolean) Specifies that the parser produced by this code will provide support for XML namespaces. |
open Unit |
Set the |
open Unit |
setValidating(validating: Boolean) Specifies that the parser produced by this code will validate documents as they are parsed. |
open Unit |
setXIncludeAware(state: Boolean) Set state of XInclude processing. |
Protected constructors
SAXParserFactory
protected SAXParserFactory()
Protected constructor to force use of newInstance()
.
Public methods
getFeature
abstract fun getFeature(name: String!): Boolean
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. |
Return | |
---|---|
Boolean |
Value of the requested property. |
Exceptions | |
---|---|
javax.xml.parsers.ParserConfigurationException |
if a parser cannot be created which satisfies the requested configuration. |
org.xml.sax.SAXNotRecognizedException |
When the underlying XMLReader does not recognize the property name. |
org.xml.sax.SAXNotSupportedException |
When the underlying XMLReader recognizes the property name but doesn't support the property. |
See Also
getSchema
open fun getSchema(): Schema!
Gets the Schema
object specified through the setSchema(javax.xml.validation.Schema)
method.
Return | |
---|---|
Schema! |
the Schema object that was last set through the setSchema(javax.xml.validation.Schema) method, or null if the method was not invoked since a SAXParserFactory is created. |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
isNamespaceAware
open fun isNamespaceAware(): Boolean
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
Return | |
---|---|
Boolean |
true if the factory is configured to produce parsers which are namespace aware; false otherwise. |
isValidating
open fun isValidating(): Boolean
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
Return | |
---|---|
Boolean |
true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise. |
isXIncludeAware
open fun isXIncludeAware(): Boolean
Get state of XInclude processing.
Return | |
---|---|
Boolean |
current state of XInclude processing |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
newInstance
open static fun newInstance(): SAXParserFactory!
Returns Android's implementation of SAXParserFactory
. Unlike other Java implementations, this method does not consult system properties, property files, or the services API.
Return | |
---|---|
SAXParserFactory! |
a new SAXParserFactory. |
Exceptions | |
---|---|
javax.xml.parsers.FactoryConfigurationError |
never. Included for API compatibility with other Java implementations. |
newInstance
open static fun newInstance(
factoryClassName: String!,
classLoader: ClassLoader!
): SAXParserFactory!
Returns an instance of the named implementation of SAXParserFactory
.
Exceptions | |
---|---|
javax.xml.parsers.FactoryConfigurationError |
if factoryClassName is not available or cannot be instantiated. |
newSAXParser
abstract fun newSAXParser(): SAXParser!
Creates a new instance of a SAXParser using the currently configured factory parameters.
Return | |
---|---|
SAXParser! |
A new instance of a SAXParser. |
Exceptions | |
---|---|
javax.xml.parsers.ParserConfigurationException |
if a parser cannot be created which satisfies the requested configuration. |
org.xml.sax.SAXException |
for SAX errors. |
setFeature
abstract fun setFeature(
name: String!,
value: Boolean
): Unit
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). SeeSAXParser
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 | |
---|---|
java.lang.NullPointerException |
If the name parameter is null. |
javax.xml.parsers.ParserConfigurationException |
if a parser cannot be created which satisfies the requested configuration. |
org.xml.sax.SAXNotRecognizedException |
When the underlying XMLReader does not recognize the property name. |
org.xml.sax.SAXNotSupportedException |
When the underlying XMLReader recognizes the property name but doesn't support the property. |
See Also
setNamespaceAware
open fun setNamespaceAware(awareness: Boolean): Unit
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
open fun setSchema(schema: Schema!): Unit
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 | |
---|---|
java.lang.UnsupportedOperationException |
For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |
setValidating
open fun setValidating(validating: Boolean): Unit
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. See here for more details.)
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(javax.xml.validation.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
open fun setXIncludeAware(state: Boolean): Unit
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 | |
---|---|
java.lang.UnsupportedOperationException |
For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown. |