com.phloc.commons.xml.transform.XMLTransformerFactory Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.xml.transform;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.xml.transform.ErrorListener;
import javax.xml.transform.Source;
import javax.xml.transform.Templates;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.TransformerFactoryConfigurationError;
import javax.xml.transform.URIResolver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.phloc.commons.CGlobal;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.exceptions.InitializationException;
import com.phloc.commons.io.IReadableResource;
/**
* A global factory for XML transformation objects.
*
* @author Philip Helger
*/
@Immutable
public final class XMLTransformerFactory
{
private static final Logger s_aLogger = LoggerFactory.getLogger (XMLTransformerFactory.class);
private static final TransformerFactory s_aDefaultFactory;
static
{
s_aDefaultFactory = createTransformerFactory (new LoggingTransformErrorListener (CGlobal.DEFAULT_LOCALE),
new DefaultTransformURIResolver ());
}
@PresentForCodeCoverage
@SuppressWarnings ("unused")
private static final XMLTransformerFactory s_aInstance = new XMLTransformerFactory ();
private XMLTransformerFactory ()
{}
@Nonnull
public static TransformerFactory createTransformerFactory (@Nullable final ErrorListener aErrorListener,
@Nullable final URIResolver aURIResolver)
{
try
{
final TransformerFactory aFactory = TransformerFactory.newInstance ();
if (aErrorListener != null)
aFactory.setErrorListener (aErrorListener);
if (aURIResolver != null)
aFactory.setURIResolver (aURIResolver);
return aFactory;
}
catch (final TransformerFactoryConfigurationError ex)
{
throw new InitializationException ("Failed to create XML TransformerFactory", ex);
}
}
/**
* @return The default transformer factory.
*/
@Nonnull
public static TransformerFactory getDefaultTransformerFactory ()
{
return s_aDefaultFactory;
}
/**
* Create a new XSLT transformer for no specific resource. This uses the
* central not thread safe transformer factory.
*
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer ()
{
return newTransformer (s_aDefaultFactory);
}
/**
* Create a new XSLT transformer for no specific resource.
*
* @param aTransformerFactory
* The transformer factory to be used. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer (@Nonnull final TransformerFactory aTransformerFactory)
{
ValueEnforcer.notNull (aTransformerFactory, "TransformerFactory");
try
{
return aTransformerFactory.newTransformer ();
}
catch (final TransformerConfigurationException ex)
{
s_aLogger.error ("Failed to create transformer", ex);
return null;
}
}
/**
* Create a new XSLT transformer for the passed resource. This uses the
* central not thread safe transformer factory.
*
* @param aResource
* The resource to be transformed. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer (@Nonnull final IReadableResource aResource)
{
return newTransformer (s_aDefaultFactory, aResource);
}
/**
* Create a new XSLT transformer for the passed resource.
*
* @param aTransformerFactory
* The transformer factory to be used. May not be null.
* @param aResource
* The resource to be transformed. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer (@Nonnull final TransformerFactory aTransformerFactory,
@Nonnull final IReadableResource aResource)
{
ValueEnforcer.notNull (aResource, "Resource");
return newTransformer (aTransformerFactory, TransformSourceFactory.create (aResource));
}
/**
* Create a new XSLT transformer for the passed resource. This uses the
* central not thread safe transformer factory.
*
* @param aSource
* The resource to be transformed. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer (@Nonnull final Source aSource)
{
return newTransformer (s_aDefaultFactory, aSource);
}
/**
* Create a new XSLT transformer for the passed resource.
*
* @param aTransformerFactory
* The transformer factory to be used. May not be null.
* @param aSource
* The resource to be transformed. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Transformer newTransformer (@Nonnull final TransformerFactory aTransformerFactory,
@Nonnull final Source aSource)
{
ValueEnforcer.notNull (aTransformerFactory, "TransformerFactory");
ValueEnforcer.notNull (aSource, "Source");
try
{
return aTransformerFactory.newTransformer (aSource);
}
catch (final TransformerConfigurationException ex)
{
s_aLogger.error ("Failed to parse " + aSource, ex);
return null;
}
}
/**
* Create a new XSLT Template for the passed resource. This uses the central
* not thread safe transformer factory.
*
* @param aResource
* The resource to be templated. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Templates newTemplates (@Nonnull final IReadableResource aResource)
{
return newTemplates (s_aDefaultFactory, aResource);
}
/**
* Create a new XSLT Template for the passed resource. This uses the central
* not thread safe transformer factory.
*
* @param aSource
* The resource to be templated. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Templates newTemplates (@Nonnull final Source aSource)
{
return newTemplates (s_aDefaultFactory, aSource);
}
/**
* Create a new XSLT Template for the passed resource.
*
* @param aFactory
* The transformer factory to be used. May not be null.
* @param aResource
* The resource to be templated. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Templates newTemplates (@Nonnull final TransformerFactory aFactory,
@Nonnull final IReadableResource aResource)
{
ValueEnforcer.notNull (aResource, "Resource");
return newTemplates (aFactory, TransformSourceFactory.create (aResource));
}
/**
* Create a new XSLT Template for the passed resource.
*
* @param aTransformerFactory
* The transformer factory to be used. May not be null.
* @param aSource
* The resource to be templated. May not be null.
* @return null if something goes wrong
*/
@Nullable
public static Templates newTemplates (@Nonnull final TransformerFactory aTransformerFactory,
@Nonnull final Source aSource)
{
ValueEnforcer.notNull (aTransformerFactory, "TransformerFactory");
ValueEnforcer.notNull (aSource, "Source");
try
{
return aTransformerFactory.newTemplates (aSource);
}
catch (final TransformerConfigurationException ex)
{
s_aLogger.error ("Failed to parse " + aSource, ex);
return null;
}
}
}