Added in API level 8

TransformerFactory

abstract class TransformerFactory
kotlin.Any
   ↳ javax.xml.transform.TransformerFactory

A TransformerFactory instance can be used to create javax.xml.transform.Transformer and javax.xml.transform.Templates objects.

The system property that determines which Factory implementation to create is named "javax.xml.transform.TransformerFactory". This property names a concrete subclass of the TransformerFactory abstract class. If the property is not defined, a platform default is be used.

Summary

Protected constructors

Default constructor is protected on purpose.

Public methods
abstract 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.

abstract Any!

Allows the user to retrieve specific attributes on the underlying implementation.

abstract ErrorListener!

Get the error event handler for the TransformerFactory.

abstract Boolean

Look up the value of a feature.

abstract URIResolver!

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

open static TransformerFactory!

Returns Android's implementation of TransformerFactory.

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

Returns an instance of the named implementation of TransformerFactory.

abstract Templates!
newTemplates(source: Source!)

Process the Source into a Templates object, which is a a compiled representation of the source.

abstract Transformer!

Process the Source into a Transformer Object.

abstract Transformer!

Create a new Transformer that performs a copy of the Source to the Result.

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

Allows the user to set specific attributes on the underlying implementation.

abstract Unit

Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.

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

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

abstract Unit

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

Protected constructors

TransformerFactory

Added in API level 8
protected TransformerFactory()

Default constructor is protected on purpose.

Public methods

getAssociatedStylesheet

Added in API level 8
abstract fun getAssociatedStylesheet(
    source: Source!,
    media: String!,
    title: String!,
    charset: String!
): Source!

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.

Parameters
source Source!: The XML source document.
media String!: The media attribute to be matched. May be null, in which case the preferred templates will be used (i.e. alternate = no).
title String!: The value of the title attribute to match. May be null.
charset String!: The value of the charset attribute to match. May be null.
Return
Source! A Source Object suitable for passing to the TransformerFactory.
Exceptions
javax.xml.transform.TransformerConfigurationException An Exception is thrown if an error occurs during parsing of the source.

See Also

    getAttribute

    Added in API level 8
    abstract fun getAttribute(name: String!): Any!

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

    Parameters
    name String!: The name of the attribute.
    Return
    Any! value The value of the attribute.

    getErrorListener

    Added in API level 8
    abstract fun getErrorListener(): ErrorListener!

    Get the error event handler for the TransformerFactory.

    Return
    ErrorListener! The current error handler, which should never be null.

    getFeature

    Added in API level 8
    abstract fun getFeature(name: String!): Boolean

    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.

    Parameters
    name String!: Feature name.
    Return
    Boolean The current state of the feature, true or false.
    Exceptions
    java.lang.NullPointerException If the name parameter is null.

    getURIResolver

    Added in API level 8
    abstract fun getURIResolver(): URIResolver!

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

    Return
    URIResolver! The URIResolver that was set with setURIResolver.

    newInstance

    Added in API level 8
    open static fun newInstance(): TransformerFactory!

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

    Exceptions
    javax.xml.transform.TransformerFactoryConfigurationError never. Included for API compatibility with other Java implementations.

    newInstance

    Added in API level 9
    open static fun newInstance(
        factoryClassName: String!,
        classLoader: ClassLoader!
    ): TransformerFactory!

    Returns an instance of the named implementation of TransformerFactory.

    Exceptions
    javax.xml.transform.TransformerFactoryConfigurationError if factoryClassName is not available or cannot be instantiated.

    newTemplates

    Added in API level 8
    abstract fun newTemplates(source: Source!): Templates!

    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.

    Parameters
    source Source!: An object that holds a URL, input stream, etc.
    Return
    Templates! A Templates object capable of being used for transformation purposes, never null.
    Exceptions
    javax.xml.transform.TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.

    newTransformer

    Added in API level 8
    abstract fun newTransformer(source: Source!): Transformer!

    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.

    Parameters
    source Source!: Source of XSLT document used to create Transformer. Examples of XML Sources include StreamSource, SAXSource and DOMSource.
    Return
    Transformer! A Transformer object that may be used to perform a transformation in a single Thread, never null.
    Exceptions
    javax.xml.transform.TransformerConfigurationException Thrown if there are errors when parsing the Source or it is not possible to create a Transformer instance.

    See Also

      newTransformer

      Added in API level 8
      abstract fun newTransformer(): Transformer!

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

      Return
      Transformer! A Transformer object that may be used to perform a transformation in a single thread, never null.
      Exceptions
      javax.xml.transform.TransformerConfigurationException Thrown if it is not possible to create a Transformer instance.

      setAttribute

      Added in API level 8
      abstract fun setAttribute(
          name: String!,
          value: Any!
      ): Unit

      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.

      Parameters
      name String!: The name of the attribute.
      value Any!: The value of the attribute.

      setErrorListener

      Added in API level 8
      abstract fun setErrorListener(listener: ErrorListener!): Unit

      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.

      Parameters
      listener ErrorListener!: The new error listener.

      setFeature

      Added in API level 8
      abstract fun setFeature(
          name: String!,
          value: Boolean
      ): Unit

      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.
      Parameters
      name String!: Feature name.
      value Boolean: Is feature state true or false.
      Exceptions
      javax.xml.transform.TransformerConfigurationException if this TransformerFactory or the Transformers or Templates it creates cannot support this feature.
      java.lang.NullPointerException If the name parameter is null.

      setURIResolver

      Added in API level 8
      abstract fun setURIResolver(resolver: URIResolver!): Unit

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

      Parameters
      resolver URIResolver!: An object that implements the URIResolver interface, or null.