org.springframework.xml.transform
Class TransformerHelper

java.lang.Object
  org.springframework.xml.transform.TransformerHelper

public class TransformerHelper
extends java.lang.Object

Helper class for Transformer usage. Provides createTransformer() and transform(Source, Result).

Since:

3.0

Author:

Arjen Poutsma

Constructor Summary

TransformerHelper()
Initializes a new instance of the TransformerHelper.

TransformerHelper(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass)
Initializes a new instance of the TransformerHelper with the specified TransformerFactory class.

TransformerHelper(javax.xml.transform.TransformerFactory transformerFactory)
Initializes a new instance of the TransformerHelper with the specified TransformerFactory.

Method Summary

javax.xml.transform.Transformer	createTransformer() Creates a new Transformer.
javax.xml.transform.TransformerFactory	getTransformerFactory() Returns the TransformerFactory.
protected javax.xml.transform.TransformerFactory	newTransformerFactory(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass) Instantiate a new TransformerFactory.
void	setTransformerFactoryClass(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass) Specify the TransformerFactory class to use.
void	transform(javax.xml.transform.Source source, javax.xml.transform.Result result) Transforms the given Source to the given Result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransformerHelper

public TransformerHelper()

Initializes a new instance of the TransformerHelper.

TransformerHelper

public TransformerHelper(javax.xml.transform.TransformerFactory transformerFactory)

Initializes a new instance of the TransformerHelper with the specified TransformerFactory.

TransformerHelper

public TransformerHelper(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass)

Initializes a new instance of the TransformerHelper with the specified TransformerFactory class.

Method Detail

setTransformerFactoryClass

public void setTransformerFactoryClass(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass)

Specify the TransformerFactory class to use.

newTransformerFactory

protected javax.xml.transform.TransformerFactory newTransformerFactory(java.lang.Class<? extends javax.xml.transform.TransformerFactory> transformerFactoryClass)

Instantiate a new TransformerFactory.

The default implementation simply calls TransformerFactory.newInstance(). If a transformerFactoryClass has been specified explicitly, the default constructor of the specified class will be called instead.

Can be overridden in subclasses.

Parameters:

transformerFactoryClass - the specified factory class (if any)

Returns:

the new TransactionFactory instance

See Also:

setTransformerFactoryClass(java.lang.Class), getTransformerFactory()

getTransformerFactory

public javax.xml.transform.TransformerFactory getTransformerFactory()

Returns the TransformerFactory.

Returns:

the transformer factory

createTransformer

public javax.xml.transform.Transformer createTransformer()
                                                  throws javax.xml.transform.TransformerConfigurationException

Creates a new Transformer. Must be called per thread, as transformers are not thread-safe.

Returns:

the created transformer

Throws:

javax.xml.transform.TransformerConfigurationException - if thrown by JAXP methods

transform

public void transform(javax.xml.transform.Source source,
                      javax.xml.transform.Result result)
               throws javax.xml.transform.TransformerException

Transforms the given Source to the given Result. Creates a new Transformer for every call, as transformers are not thread-safe.

Parameters:

source - the source to transform from

result - the result to transform to

Throws:

javax.xml.transform.TransformerException - if thrown by JAXP methods