SAXParserFactory

SAXParserFactory

protected SAXParserFactory()

Protected constructor to force use of newInstance().

getFeature

abstract fun getFeature(name: String!): Boolean

Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.

getSchema

open fun getSchema(): Schema!

Gets the Schema object specified through the setSchema(javax.xml.validation.Schema) method.

isNamespaceAware

open fun isNamespaceAware(): Boolean

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

isValidating

open fun isValidating(): Boolean

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

isXIncludeAware

open fun isXIncludeAware(): Boolean

Get state of XInclude processing.

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.

newInstance

open static fun newInstance(
    factoryClassName: String!, 
    classLoader: ClassLoader!
): SAXParserFactory!

Returns an instance of the named implementation of SAXParserFactory.

newSAXParser

abstract fun newSAXParser(): SAXParser!

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

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). 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.

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.

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.

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.

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.