OpenJDK 27 · javax.xml.transform.TransformerFactory · APIdia, the JavaDoc alternative

Access	Constructor and Description
protected	TransformerFactory() Default constructor is protected on purpose.

Method Summary

Modifier and Type	Method and Description
public abstract Source	Returns: A `Source` `Object` suitable for passing to the `TransformerFactory`. getAssociatedStylesheet(Source The XML source document. source, String The media attribute to be matched. May be null, in which case the preferred templates will be used (i.e. alternate = no). media, String The value of the title attribute to match. May be null. title, String The value of the charset attribute to match. May be null. charset) Get the stylesheet specification(s) associated with the XML `Source` document via the xml-stylesheet processing instruction that match the given criteria.
public abstract Object	Returns: value The value of the attribute. getAttribute(String The name of the attribute. name) Allows the user to retrieve specific attributes on the underlying implementation.
public abstract ErrorListener	Returns: The current error handler, which should never be null. getErrorListener() Get the error event handler for the TransformerFactory.
public abstract boolean	Returns: The current state of the feature, `true` or `false`. getFeature(String Feature name. name) Look up the value of a feature.
public abstract URIResolver	Returns: The URIResolver that was set with setURIResolver. getURIResolver() Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
public static TransformerFactory	Returns: A new instance of the `TransformerFactory` builtin system-default implementation. newDefaultInstance() Creates a new instance of the `TransformerFactory` builtin system-default implementation.
public static TransformerFactory	Returns: new TransformerFactory instance, never null. newInstance() Obtains a new instance of a `TransformerFactory`.
public static TransformerFactory	Returns: new TransformerFactory instance, never null. newInstance(String fully qualified factory class name that provides implementation of `javax.xml.transform.TransformerFactory`. factoryClassName, ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. classLoader) Obtain a new instance of a `TransformerFactory` from factory class name.
public abstract Templates	Returns: A Templates object capable of being used for transformation purposes, never `null`. newTemplates(Source An object that holds a URL, input stream, etc. source) Process the Source into a Templates object, which is a a compiled representation of the source.
public abstract Transformer	Returns: A `Transformer` object that may be used to perform a transformation in a single `Thread`, never `null`. newTransformer(Source `Source` of XSLT document used to create `Transformer`. Examples of XML `Source`s include `DOMSource`, `SAXSource`, and `StreamSource`. source) Process the `Source` into a `Transformer` `Object`.
public abstract Transformer	Returns: A Transformer object that may be used to perform a transformation in a single thread, never null. newTransformer() Create a new `Transformer` that performs a copy of the `Source` to the `Result`, i.e. the "identity transform".
public abstract void	setAttribute(String The name of the attribute. name, Object The value of the attribute. value) Allows the user to set specific attributes on the underlying implementation.
public abstract void	setErrorListener(ErrorListener The new error listener. listener) Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
public abstract void	setFeature(String Feature name. name, boolean Is feature state `true` or `false`. value) Set a feature for this `TransformerFactory` and `Transformer`s or `Template`s created by this factory.
public abstract void	setURIResolver(URIResolver An object that implements the URIResolver interface, or null. resolver) Set an object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

TransformerFactory	back to summary
protected TransformerFactory() Default constructor is protected on purpose.

Method Detail

getAssociatedStylesheet back to summary

getAssociatedStylesheet	back to summary
public abstract Source getAssociatedStylesheet(Source source, String media, String title, 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. 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. Returns:Source A `Source` `Object` suitable for passing to the `TransformerFactory`. Exceptions TransformerConfigurationException: An `Exception` is thrown if an error occurings during parsing of the `source`. See Also Associating Style Sheets with XML documents Version 1.0

public abstract Source getAssociatedStylesheet(Source source, String media, String title, 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.

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.

Returns:Source

A Source Object suitable for passing to the TransformerFactory.

Exceptions

TransformerConfigurationException:: An Exception is thrown if an error occurings during parsing of the source.

getAttribute back to summary

getAttribute	back to summary
public abstract Object getAttribute(String name) 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. Returns:Object value The value of the attribute. Exceptions IllegalArgumentException: When implementation does not recognize the attribute.

public abstract Object getAttribute(String name)

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.

Returns:Object

value The value of the attribute.

Exceptions

IllegalArgumentException:: When implementation does not recognize the attribute.

getErrorListener	back to summary
public abstract ErrorListener getErrorListener() Get the error event handler for the TransformerFactory. Returns:ErrorListener The current error handler, which should never be null.

getErrorListener

back to summary

public abstract ErrorListener getErrorListener()

Get the error event handler for the TransformerFactory.

Returns:ErrorListener: The current error handler, which should never be null.

getFeature back to summary

getFeature	back to summary
public abstract boolean getFeature(String name) Look up the value of a feature. Feature names are fully qualified `java.net.URI`s. Implementations may define their own features. `false` is returned if this `TransformerFactory` or the `Transformer`s or `Template`s 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. Returns:boolean The current state of the feature, `true` or `false`. Exceptions NullPointerException: If the `name` parameter is null.

public abstract boolean getFeature(String name)

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.

Returns:boolean

The current state of the feature, true or false.

Exceptions

NullPointerException:: If the name parameter is null.

getURIResolver	back to summary
public 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. Returns:URIResolver The URIResolver that was set with setURIResolver.

getURIResolver

back to summary

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

Returns:URIResolver: The URIResolver that was set with setURIResolver.

newDefaultInstance back to summary

newDefaultInstance	back to summary
public static TransformerFactory newDefaultInstance() Creates a new instance of the `TransformerFactory` builtin system-default implementation. Returns:TransformerFactory A new instance of the `TransformerFactory` builtin system-default implementation. Since 9

public static TransformerFactory newDefaultInstance()

Creates a new instance of the TransformerFactory builtin system-default implementation.

Returns:TransformerFactory: A new instance of the TransformerFactory builtin system-default implementation.
Since: 9

newInstance back to summary

newInstance	back to summary
public static TransformerFactory newInstance() throws TransformerFactoryConfigurationError Obtains a new instance of a `TransformerFactory`. This method uses the JAXP Lookup Mechanism to determine the `TransformerFactory` implementation class to load. Once an application has obtained a reference to a `TransformerFactory`, it can use the factory to configure and obtain transformer instances. Returns:TransformerFactory new TransformerFactory instance, never null. Exceptions TransformerFactoryConfigurationError: Thrown in case of service configuration error or if the implementation is not available or cannot be instantiated.

public static TransformerFactory newInstance() throws TransformerFactoryConfigurationError

Obtains a new instance of a TransformerFactory. This method uses the JAXP Lookup Mechanism to determine the TransformerFactory implementation class to load.

Once an application has obtained a reference to a TransformerFactory, it can use the factory to configure and obtain transformer instances.

Returns:TransformerFactory

new TransformerFactory instance, never null.

Exceptions

TransformerFactoryConfigurationError:: Thrown in case of service configuration error or if the implementation is not available or cannot be instantiated.

newInstance back to summary

newInstance	back to summary
public static TransformerFactory newInstance(String factoryClassName, ClassLoader classLoader) throws TransformerFactoryConfigurationError Obtain a new instance of a `TransformerFactory` from factory class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded. Once an application has obtained a reference to a `TransformerFactory` it can use the factory to configure and obtain transformer instances. Tip for Trouble-shooting Setting the `jaxp.debug` system property will cause this method to print a lot of debug messages to `System.err` about what it is doing and where it is looking at. If you have problems try: java -Djaxp.debug=1 YourProgram .... Parameters factoryClassName:String fully qualified factory class name that provides implementation of `javax.xml.transform.TransformerFactory`. classLoader:ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. Returns:TransformerFactory new TransformerFactory instance, never null. Exceptions TransformerFactoryConfigurationError: if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated. Since 1.6 See Also `newInstance()`

public static TransformerFactory newInstance(String factoryClassName, ClassLoader classLoader) throws TransformerFactoryConfigurationError

Obtain a new instance of a TransformerFactory from factory class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.

Once an application has obtained a reference to a TransformerFactory it can use the factory to configure and obtain transformer instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems try:

java -Djaxp.debug=1 YourProgram ....

Parameters

factoryClassName:String: fully qualified factory class name that provides implementation of javax.xml.transform.TransformerFactory.
classLoader:ClassLoader: ClassLoader used to load the factory class. If null current Thread's context classLoader is used to load the factory class.

Returns:TransformerFactory

new TransformerFactory instance, never null.

Exceptions

TransformerFactoryConfigurationError:: if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since

1.6

See Also

newInstance()

newTemplates back to summary

newTemplates	back to summary
public abstract Templates newTemplates(Source source) throws TransformerConfigurationException 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. Returns:Templates A Templates object capable of being used for transformation purposes, never `null`. Exceptions TransformerConfigurationException: When parsing to construct the Templates object fails.

public abstract Templates newTemplates(Source source) throws TransformerConfigurationException

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.

Returns:Templates

A Templates object capable of being used for transformation purposes, never null.

Exceptions

TransformerConfigurationException:: When parsing to construct the Templates object fails.

newTransformer back to summary

newTransformer	back to summary
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 `Thread`s running concurrently. Different `TransformerFactories` can be used concurrently by different `Thread`s. Parameters source:Source `Source` of XSLT document used to create `Transformer`. Examples of XML `Source`s include `DOMSource`, `SAXSource`, and `StreamSource`. Returns:Transformer A `Transformer` object that may be used to perform a transformation in a single `Thread`, never `null`. Exceptions TransformerConfigurationException: Thrown if there are errors when parsing the `Source` or it is not possible to create a `Transformer` instance. See Also XSL Transformations (XSLT) Version 1.0

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.

Parameters

source:Source: Source of XSLT document used to create Transformer. Examples of XML Sources include DOMSource, SAXSource, and StreamSource.

Returns:Transformer

A Transformer object that may be used to perform a transformation in a single Thread, never null.

Exceptions

TransformerConfigurationException:: Thrown if there are errors when parsing the Source or it is not possible to create a Transformer instance.

See Also

XSL Transformations (XSLT) Version 1.0

newTransformer back to summary

newTransformer	back to summary
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". Returns:Transformer A Transformer object that may be used to perform a transformation in a single thread, never null. Exceptions TransformerConfigurationException: When 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".

Returns:Transformer

A Transformer object that may be used to perform a transformation in a single thread, never null.

Exceptions

TransformerConfigurationException:: When it is not possible to create a Transformer instance.

setAttribute back to summary

setAttribute	back to summary
public abstract void setAttribute(String name, Object value) 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. All implementations that implement JAXP 1.5 or newer are required to support the `javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD` and `javax.xml.XMLConstants#ACCESS_EXTERNAL_STYLESHEET` properties. Access to external DTDs in the source file is restricted to the protocols specified by the `javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD` property. If access is denied during transformation due to the restriction of this property, `javax.xml.transform.TransformerException` will be thrown by `javax.xml.transform.Transformer#transform(Source, Result)`. Access to external DTDs in the stylesheet is restricted to the protocols specified by the `javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD` property. If access is denied during the creation of a new transformer due to the restriction of this property, `javax.xml.transform.TransformerConfigurationException` will be thrown by the `newTransformer(Source)` method. Access to external reference set by the stylesheet processing instruction, Import and Include element is restricted to the protocols specified by the `javax.xml.XMLConstants#ACCESS_EXTERNAL_STYLESHEET` property. If access is denied during the creation of a new transformer due to the restriction of this property, `javax.xml.transform.TransformerConfigurationException` will be thrown by the `newTransformer(Source)` method. Access to external document through XSLT document function is restricted to the protocols specified by the property. If access is denied during the transformation due to the restriction of this property, `javax.xml.transform.TransformerException` will be thrown by the `javax.xml.transform.Transformer#transform(Source, Result)` method. Parameters name:String The name of the attribute. value:Object The value of the attribute. Exceptions IllegalArgumentException: When implementation does not recognize the attribute.

public abstract void setAttribute(String name, Object value)

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.

All implementations that implement JAXP 1.5 or newer are required to support the javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD and javax.xml.XMLConstants#ACCESS_EXTERNAL_STYLESHEET properties.

Access to external DTDs in the source file is restricted to the protocols specified by the javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD property. If access is denied during transformation due to the restriction of this property, javax.xml.transform.TransformerException will be thrown by javax.xml.transform.Transformer#transform(Source, Result).
Access to external DTDs in the stylesheet is restricted to the protocols specified by the javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD property. If access is denied during the creation of a new transformer due to the restriction of this property, javax.xml.transform.TransformerConfigurationException will be thrown by the newTransformer(Source) method.
Access to external reference set by the stylesheet processing instruction, Import and Include element is restricted to the protocols specified by the javax.xml.XMLConstants#ACCESS_EXTERNAL_STYLESHEET property. If access is denied during the creation of a new transformer due to the restriction of this property, javax.xml.transform.TransformerConfigurationException will be thrown by the newTransformer(Source) method.
Access to external document through XSLT document function is restricted to the protocols specified by the property. If access is denied during the transformation due to the restriction of this property, javax.xml.transform.TransformerException will be thrown by the javax.xml.transform.Transformer#transform(Source, Result) method.

Parameters

name:String: The name of the attribute.
value:Object: The value of the attribute.

Exceptions

IllegalArgumentException:: When implementation does not recognize the attribute.

setErrorListener back to summary

setErrorListener	back to summary
public 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. An `IllegalArgumentException` is thrown if the `ErrorListener` listener is `null`. Parameters listener:ErrorListener The new error listener. Exceptions IllegalArgumentException: When `listener` is `null`

public 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. An IllegalArgumentException is thrown if the ErrorListener listener is null.

Parameters

listener:ErrorListener: The new error listener.

Exceptions

IllegalArgumentException:: When listener is null

setFeature back to summary

setFeature	back to summary
public abstract void setFeature(String name, boolean value) throws TransformerConfigurationException Set a feature for this `TransformerFactory` and `Transformer`s or `Template`s created by this factory. Feature names are fully qualified `java.net.URI`s. Implementations may define their own features. An `TransformerConfigurationException` is thrown if this `TransformerFactory` or the `Transformer`s or `Template`s 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(ErrorListener listener)`. `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 TransformerConfigurationException: if this `TransformerFactory` or the `Transformer`s or `Template`s it creates cannot support this feature. NullPointerException: If the `name` parameter is null.

public abstract void setFeature(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 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(ErrorListener listener).
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

TransformerConfigurationException:: if this TransformerFactory or the Transformers or Templates it creates cannot support this feature.
NullPointerException:: If the name parameter is null.

setURIResolver	back to summary
public 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. Parameters resolver:URIResolver An object that implements the URIResolver interface, or null.

setURIResolver

back to summary

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

Parameters

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

public abstract Class TransformerFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Tip for Trouble-shooting