SAXTransformerFactory
public abstract class TransformerFactory extends 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 | Description |
---|---|---|
protected |
Default constructor is protected on purpose. |
Modifier and Type | Method | Description |
---|---|---|
abstract Source |
getAssociatedStylesheet |
Get the stylesheet specification(s) associated with the XML Source document via the xml-stylesheet processing instruction that match the given criteria. |
abstract Object |
getAttribute |
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 |
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 |
newDefaultInstance() |
Creates a new instance of the TransformerFactory builtin system-default implementation. |
static TransformerFactory |
newInstance() |
Obtains a new instance of a TransformerFactory . |
static TransformerFactory |
newInstance |
Obtain a new instance of a TransformerFactory from factory class name. |
abstract Templates |
newTemplates |
Process the Source into a Templates object, which is a a compiled representation of the source. |
abstract Transformer |
newTransformer() |
Create a new Transformer that performs a copy of the Source to the Result , i.e. the "identity transform". |
abstract Transformer |
newTransformer |
Process the Source into a Transformer Object . |
abstract void |
setAttribute |
Allows the user to set specific attributes on the underlying implementation. |
abstract void |
setErrorListener |
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 |
Set a feature for this TransformerFactory and Transformer s or Template s created by this factory. |
abstract void |
setURIResolver |
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 newDefaultInstance()
TransformerFactory
builtin system-default implementation.TransformerFactory
builtin system-default implementation.public static TransformerFactory newInstance() throws TransformerFactoryConfigurationError
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.
TransformerFactoryConfigurationError
- Thrown in case of service configuration error or if the implementation is not available or cannot be instantiated.public static TransformerFactory newInstance(String factoryClassName, ClassLoader classLoader) throws TransformerFactoryConfigurationError
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.
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 ....
factoryClassName
- fully qualified factory class name that provides implementation of javax.xml.transform.TransformerFactory
.classLoader
- ClassLoader
used to load the factory class. If null
current Thread
's context classLoader is used to load the factory class.TransformerFactoryConfigurationError
- if factoryClassName
is null
, or the factory class cannot be loaded, instantiated.public abstract Transformer newTransformer(Source source) throws TransformerConfigurationException
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.source
- Source
of XSLT document used to create Transformer
. Examples of XML Source
s include DOMSource
, SAXSource
, and StreamSource
.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
Transformer
that performs a copy of the Source
to the Result
, i.e. the "identity transform".TransformerConfigurationException
- When 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.null
.TransformerConfigurationException
- When parsing to construct the Templates object fails.public abstract Source getAssociatedStylesheet(Source source, String media, String title, String charset) throws TransformerConfigurationException
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 occurings 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(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 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 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 Transformer
s or Template
s it creates cannot support this feature.NullPointerException
- If the name
parameter is null.public abstract boolean getFeature(String name)
Feature names are fully qualified 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.
name
- Feature name.true
or false
.NullPointerException
- If the name
parameter is null.public abstract void setAttribute(String name, Object value)
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 XMLConstants.ACCESS_EXTERNAL_DTD
and XMLConstants.ACCESS_EXTERNAL_STYLESHEET
properties.
Access to external DTDs in the source file is restricted to the protocols specified by the XMLConstants.ACCESS_EXTERNAL_DTD
property. If access is denied during transformation due to the restriction of this property, TransformerException
will be thrown by Transformer.transform(Source, Result)
.
Access to external DTDs in the stylesheet is restricted to the protocols specified by the XMLConstants.ACCESS_EXTERNAL_DTD
property. If access is denied during the creation of a new transformer due to the restriction of this property, 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 XMLConstants.ACCESS_EXTERNAL_STYLESHEET
property. If access is denied during the creation of a new transformer due to the restriction of this property, 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, TransformerException
will be thrown by the Transformer.transform(Source, Result)
method.
name
- The name of the attribute.value
- The value of the attribute.IllegalArgumentException
- When implementation does not recognize the attribute.public abstract Object getAttribute(String name)
IllegalArgumentException
is thrown if the underlying implementation doesn't recognize the attribute.name
- The name of the attribute.IllegalArgumentException
- When implementation does not recognize the attribute.public abstract void setErrorListener(ErrorListener listener)
IllegalArgumentException
is thrown if the ErrorListener
listener is null
.listener
- The new error listener.IllegalArgumentException
- When listener
is null
public abstract ErrorListener getErrorListener()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/transform/TransformerFactory.html