Added in API level 8

SAXTransformerFactory

abstract class SAXTransformerFactory : TransformerFactory

This class extends TransformerFactory to provide SAX-specific factory methods. It provides two types of ContentHandlers, one for creating Transformers, the other for creating Templates objects.

If an application wants to set the ErrorHandler or EntityResolver for an XMLReader used during a transformation, it should use a URIResolver to return the SAXSource which provides (with getXMLReader) a reference to the XMLReader.

Summary

Constants
static String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the TransformerFactory returned from javax.

static String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the newXMLFilter(javax.xml.transform.Source) and newXMLFilter(javax.xml.transform.Templates) methods are supported.

Protected constructors

The default constructor is protected on purpose.

Public methods
abstract TemplatesHandler!

Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

abstract TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result.

abstract TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.

abstract TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.

abstract XMLFilter!

Create an XMLFilter that uses the given Source as the transformation instructions.

abstract XMLFilter!
newXMLFilter(templates: Templates!)

Create an XMLFilter, based on the Templates argument.

Inherited functions
Source! getAssociatedStylesheet(source: Source!, media: String!, title: String!, charset: String!)

Get the stylesheet specification(s) associated with the XML Source document via the xml-stylesheet processing instruction that match the given criteria. Note that it is possible to return several stylesheets, in which case they are applied as if they were a list of imports or cascades in a single stylesheet.

Any! getAttribute(name: String!)

Allows the user to retrieve specific attributes on the underlying implementation. An IllegalArgumentException is thrown if the underlying implementation doesn't recognize the attribute.

ErrorListener! getErrorListener()

Get the error event handler for the TransformerFactory.

Boolean getFeature(name: String!)

Look up the value of a feature.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. false is returned if this TransformerFactory or the Transformers or Templates it creates cannot support the feature. It is possible for an TransformerFactory to expose a feature value but be unable to change its state.

URIResolver! getURIResolver()

Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.

TransformerFactory! newInstance()

Returns Android's implementation of TransformerFactory. Unlike other Java implementations, this method does not consult system properties, properties files, or the services API.

TransformerFactory! newInstance(factoryClassName: String!, classLoader: ClassLoader!)

Returns an instance of the named implementation of TransformerFactory.

Templates! newTemplates(source: Source!)

Process the Source into a Templates object, which is a a compiled representation of the source. This Templates object may then be used concurrently across multiple threads. Creating a Templates object allows the TransformerFactory to do detailed performance optimization of transformation instructions, without penalizing runtime transformation.

Transformer! newTransformer()

Create a new Transformer that performs a copy of the Source to the Result. i.e. the "identity transform".

Transformer! newTransformer(source: Source!)

Process the Source into a Transformer Object. The Source is an XSLT document that conforms to XSL Transformations (XSLT) Version 1.0. Care must be taken not to use this Transformer in multiple Threads running concurrently. Different TransformerFactories can be used concurrently by different Threads.

Unit setAttribute(name: String!, value: Any!)

Allows the user to set specific attributes on the underlying implementation. An attribute in this context is defined to be an option that the implementation provides. An IllegalArgumentException is thrown if the underlying implementation doesn't recognize the attribute.

Unit setErrorListener(listener: ErrorListener!)

Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself. An IllegalArgumentException is thrown if the ErrorListener listener is null.

Unit setFeature(name: String!, value: Boolean)

Set a feature for this TransformerFactory and Transformers or Templates created by this factory.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. An TransformerConfigurationException is thrown if this TransformerFactory or the Transformers or Templates it creates cannot support the feature. It is possible for an TransformerFactory to expose a feature value but be unable to change its state.

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 and behave in a secure fashion as defined by the implementation. Examples include resolving user defined style sheets and functions. If XML processing is limited for security reasons, it will be reported via a call to the registered ErrorListener.fatalError(TransformerException exception). See setErrorListener(javax.xml.transform.ErrorListener).
  • false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Unit setURIResolver(resolver: URIResolver!)

Set an object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.

Constants

FEATURE

Added in API level 8
static val FEATURE: String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the TransformerFactory returned from javax.xml.transform.TransformerFactory#newInstance may be safely cast to a SAXTransformerFactory.

Value: "http://javax.xml.transform.sax.SAXTransformerFactory/feature"

FEATURE_XMLFILTER

Added in API level 8
static val FEATURE_XMLFILTER: String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the newXMLFilter(javax.xml.transform.Source) and newXMLFilter(javax.xml.transform.Templates) methods are supported.

Value: "http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter"

Protected constructors

SAXTransformerFactory

Added in API level 8
protected SAXTransformerFactory()

The default constructor is protected on purpose.

Public methods

newTemplatesHandler

Added in API level 8
abstract fun newTemplatesHandler(): TemplatesHandler!

Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

Return
TemplatesHandler! A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.

newTransformerHandler

Added in API level 8
abstract fun newTransformerHandler(): TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result. The transformation is defined as an identity (or copy) transformation, for example to copy a series of SAX parse events into a DOM tree.

Return
TransformerHandler! A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TransformerHandler cannot be created.

newTransformerHandler

Added in API level 8
abstract fun newTransformerHandler(src: Source!): TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.

Parameters
src Source!: The Source of the transformation instructions.
Return
TransformerHandler! TransformerHandler ready to transform SAX events.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newTransformerHandler

Added in API level 8
abstract fun newTransformerHandler(templates: Templates!): TransformerHandler!

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.

Parameters
templates Templates!: The compiled transformation instructions.
Return
TransformerHandler! TransformerHandler ready to transform SAX events.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newXMLFilter

Added in API level 8
abstract fun newXMLFilter(src: Source!): XMLFilter!

Create an XMLFilter that uses the given Source as the transformation instructions.

Parameters
src Source!: The Source of the transformation instructions.
Return
XMLFilter! An XMLFilter object, or null if this feature is not supported.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.

newXMLFilter

Added in API level 8
abstract fun newXMLFilter(templates: Templates!): XMLFilter!

Create an XMLFilter, based on the Templates argument..

Parameters
templates Templates!: The compiled transformation instructions.
Return
XMLFilter! An XMLFilter object, or null if this feature is not supported.
Exceptions
javax.xml.transform.TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.