public abstract class TransformerFactory
extends java.lang.Object
A TransformerFactory instance can be used to create
 Transformer and
 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.
| Modifier | Constructor and Description | 
|---|---|
| protected  | TransformerFactory()Default constructor is protected on purpose. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract Source | getAssociatedStylesheet(Source source,
                       java.lang.String media,
                       java.lang.String title,
                       java.lang.String charset)Get the stylesheet specification(s) associated with the
 XML  Sourcedocument via the
 
 xml-stylesheet processing instruction that match the given criteria. | 
| abstract java.lang.Object | getAttribute(java.lang.String name)Allows the user to retrieve specific attributes on the underlying
 implementation. | 
| abstract ErrorListener | getErrorListener()Get the error event handler for the TransformerFactory. | 
| abstract boolean | getFeature(java.lang.String name)Look up the value of a feature. | 
| abstract URIResolver | getURIResolver()Get the object that is used by default during the transformation
 to resolve URIs used in document(), xsl:import, or xsl:include. | 
| static TransformerFactory | newInstance()Obtain a new instance of a  TransformerFactory. | 
| static TransformerFactory | newInstance(java.lang.String factoryClassName,
           java.lang.ClassLoader classLoader) | 
| abstract Templates | newTemplates(Source source)Process the Source into a Templates object, which is a
 a compiled representation of the source. | 
| abstract Transformer | newTransformer()Create a new  Transformerthat performs a copy
 of theSourceto theResult. | 
| abstract Transformer | newTransformer(Source source)Process the  Sourceinto aTransformerObject. | 
| abstract void | setAttribute(java.lang.String name,
            java.lang.Object value)Allows the user to set specific attributes on the underlying
 implementation. | 
| abstract void | setErrorListener(ErrorListener listener)Set the error event listener for the TransformerFactory, which
 is used for the processing of transformation instructions,
 and not for the transformation itself. | 
| abstract void | setFeature(java.lang.String name,
          boolean value)Set a feature for this  TransformerFactoryandTransformers
 orTemplates created by this factory. | 
| abstract void | setURIResolver(URIResolver resolver)Set an object that is used by default during the transformation
 to resolve URIs used in document(), xsl:import, or xsl:include. | 
protected TransformerFactory()
public static TransformerFactory newInstance() throws TransformerFactoryConfigurationError
TransformerFactory.
 This static method creates a new factory instance
 This method uses the following ordered lookup procedure to determine
 the TransformerFactory implementation class to
 load:
 javax.xml.transform.TransformerFactory system
 property.
 java.util.Properties
  format and contains the fully qualified name of the
 implementation class with the key being the system property defined
 above.
 
 The jaxp.properties file is read only once by the JAXP implementation
 and it's values are then cached for future use.  If the file does not exist
 when the first attempt is made to read from it, no further attempts are
 made to check for its existence.  It is not possible to change the value
 of any property in jaxp.properties after it has been read for the first time.
 META-INF/services/javax.xml.transform.TransformerFactory
 in jars available to the runtime.
 TransformerFactory instance.
 
 TransformerFactory it can use the factory to configure
 and obtain parser instances.TransformerFactoryConfigurationError - Thrown if the implementation
    is not available or cannot be instantiated.public static TransformerFactory newInstance(java.lang.String factoryClassName, java.lang.ClassLoader classLoader) throws TransformerFactoryConfigurationError
TransformerFactoryConfigurationError - Thrown if the implementation
    is not available or cannot be instantiated.public abstract Transformer newTransformer(Source source) throws TransformerConfigurationException
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.
source - Source  of XSLT document used to create
   Transformer.
   Examples of XML Sources include
   StreamSource,
   SAXSource,
   DOMSource and
   StAXSource.Transformer object that may be used to perform
   a transformation in a single Thread, never
   null.TransformerConfigurationException - Thrown if there are errors when
    parsing the Source or it is not possible to create a
   Transformer instance.public abstract Transformer newTransformer() throws TransformerConfigurationException
Create a new Transformer that performs a copy
 of the Source to the Result.
 i.e. the "identity transform".
TransformerConfigurationException - Thrown if it is not
   possible to create a Transformer instance.public abstract Templates newTemplates(Source source) throws TransformerConfigurationException
source - An object that holds a URL, input stream, etc.TransformerConfigurationException - May throw this during the
 parse when it is constructing the Templates object and fails.public abstract Source getAssociatedStylesheet(Source source, java.lang.String media, java.lang.String title, java.lang.String charset) throws TransformerConfigurationException
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.
source - The XML source document.media - The media attribute to be matched.  May be null, in which
      case the preferred templates will be used (i.e. alternate = no).title - The value of the title attribute to match.  May be null.charset - The value of the charset attribute to match.  May be null.Source Object suitable for passing
   to the TransformerFactory.TransformerConfigurationException - An Exception
   is thrown if an error occurs during parsing of the
   source.public abstract void setURIResolver(URIResolver resolver)
resolver - An object that implements the URIResolver interface,
 or null.public abstract URIResolver getURIResolver()
public abstract void setFeature(java.lang.String name,
              boolean value)
                         throws TransformerConfigurationException
Set a feature for this TransformerFactory and Transformers
 or Templates created by this factory.
 Feature names are fully qualified 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 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(ErrorListener listener).
   false: the implementation will processing XML according to the XML specifications without
     regard to possible implementation limits.
   name - Feature name.value - Is feature state true or false.TransformerConfigurationException - if this TransformerFactory
   or the Transformers or Templates it creates cannot support this feature.java.lang.NullPointerException - If the name parameter is null.public abstract boolean getFeature(java.lang.String name)
 Feature names are fully qualified 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.
 
name - Feature name.true or false.java.lang.NullPointerException - If the name parameter is null.public abstract void setAttribute(java.lang.String name,
                java.lang.Object value)
IllegalArgumentException is thrown if the underlying
 implementation doesn't recognize the attribute.name - The name of the attribute.value - The value of the attribute.public abstract java.lang.Object getAttribute(java.lang.String name)
IllegalArgumentException is thrown if the underlying
 implementation doesn't recognize the attribute.name - The name of the attribute.public abstract void setErrorListener(ErrorListener listener)
IllegalArgumentException is thrown if the
 ErrorListener listener is null.listener - The new error listener.public abstract ErrorListener getErrorListener()
Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.