TransformerFactory
public
abstract
class
TransformerFactory
extends Object
java.lang.Object | |
↳ | javax.xml.transform.TransformerFactory |
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.
Summary
Protected constructors | |
---|---|
TransformerFactory()
Default constructor is protected on purpose. |
Public methods | |
---|---|
abstract
Source
|
getAssociatedStylesheet(Source source, String media, String title, String charset)
Get the stylesheet specification(s) associated with the
XML |
abstract
Object
|
getAttribute(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(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(String factoryClassName, ClassLoader classLoader)
Returns an instance of the named implementation of |
static
TransformerFactory
|
newInstance()
Returns Android's implementation of |
abstract
Templates
|
newTemplates(Source source)
Process the Source into a Templates object, which is a a compiled representation of the source. |
abstract
Transformer
|
newTransformer(Source source)
Process the |
abstract
Transformer
|
newTransformer()
Create a new |
abstract
void
|
setAttribute(String name, 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(String name, boolean value)
Set a feature for this |
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. |
Inherited methods | |
---|---|
Protected constructors
TransformerFactory
protected TransformerFactory ()
Default constructor is protected on purpose.
Public methods
getAssociatedStylesheet
public abstract Source getAssociatedStylesheet (Source source, String media, String title, String charset)
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 . |
Throws | |
---|---|
TransformerConfigurationException |
An Exception
is thrown if an error occurs during parsing of the
source . |
getAttribute
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. |
getErrorListener
public abstract ErrorListener getErrorListener ()
Get the error event handler for the TransformerFactory.
Returns | |
---|---|
ErrorListener |
The current error handler, which should never be null. |
getFeature
public abstract boolean getFeature (String name)
Look up the value of a feature.
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.
Parameters | |
---|---|
name |
String : Feature name. |
Returns | |
---|---|
boolean |
The current state of the feature, true or false . |
Throws | |
---|---|
NullPointerException |
If the name parameter is null. |
getURIResolver
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. |
newInstance
public static TransformerFactory newInstance (String factoryClassName, ClassLoader classLoader)
Returns an instance of the named implementation of TransformerFactory
.
Parameters | |
---|---|
factoryClassName |
String |
classLoader |
ClassLoader |
Returns | |
---|---|
TransformerFactory |
Throws | |
---|---|
TransformerFactoryConfigurationError |
if factoryClassName is not available or
cannot be instantiated. |
newInstance
public static 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.
Returns | |
---|---|
TransformerFactory |
Throws | |
---|---|
TransformerFactoryConfigurationError |
never. Included for API compatibility with other Java implementations. |
newTemplates
public abstract 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.
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. |
Throws | |
---|---|
TransformerConfigurationException |
May throw this during the parse when it is constructing the Templates object and fails. |
newTransformer
public abstract 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
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
StreamSource ,
SAXSource and
DOMSource . |
Returns | |
---|---|
Transformer |
A Transformer object that may be used to perform
a transformation in a single Thread , never
null . |
Throws | |
---|---|
TransformerConfigurationException |
Thrown if there are errors when
parsing the Source or it is not possible to create a
Transformer instance. |
See also:
newTransformer
public abstract Transformer newTransformer ()
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. |
Throws | |
---|---|
TransformerConfigurationException |
Thrown if it is not
possible to create a Transformer instance. |
setAttribute
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.
Parameters | |
---|---|
name |
String : The name of the attribute. |
value |
Object : The value of the attribute. |
setErrorListener
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. |
setFeature
public abstract void setFeature (String name, boolean value)
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 registeredErrorListener#fatalError(TransformerException exception)
. SeesetErrorListener(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 . |
Throws | |
---|---|
TransformerConfigurationException |
if this TransformerFactory
or the Transformer s or Template s it creates cannot support this feature. |
NullPointerException |
If the name parameter is null. |
setURIResolver
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. |