org.myire.munge.transform.freemarker

Class FreeMarkerTransformer

java.lang.Object

org.myire.munge.transform.freemarker.FreeMarkerTransformer

All Implemented Interfaces:

Transformer

public class FreeMarkerTransformer
extends java.lang.Object
implements Transformer

A Transformer that transforms XML files by applying FreeMarker templates.

Constructor Summary

Constructors

Constructor and Description
FreeMarkerTransformer()

Method Summary

Modifier and Type	Method and Description
boolean	configure(java.io.File pConfigurationFile) Configure this transformer with the values in a configuration file.
int	executeTransformations(java.util.function.BiFunction<java.io.File,java.io.File,OutputFileSpec> pOutputFileMapping) Apply all successfully loaded template files to all successfully loaded source files.
int	loadSources(org.gradle.api.file.FileCollection pSourceFiles) Load the source files to transform in the next call to Transformer.executeTransformations(BiFunction).
int	loadTemplates(org.gradle.api.file.FileCollection pTemplateFiles) Load the template files to transform source files with in the next call to Transformer.executeTransformations(BiFunction).
void	setOutputFileCharset(java.nio.charset.Charset pCharset) Set the character set to encode the output files with.
void	setTransformationParameters(java.util.Map<java.lang.String,java.lang.Object> pParameters) Set the parameters to be used in all transformations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.myire.munge.transform.Transformer

logTransformation

Constructor Detail

FreeMarkerTransformer

public FreeMarkerTransformer()

Method Detail

configure

public boolean configure(java.io.File pConfigurationFile)

Description copied from interface: Transformer

Configure this transformer with the values in a configuration file.

Specified by:

configure in interface Transformer

Parameters:

pConfigurationFile - The configuration file. If this parameter is null, a default configuration will be used.

Returns:

True if the transformer was successfully configured, false if a failure occurred. In the latter case an error has been logged.

setTransformationParameters

public void setTransformationParameters(java.util.Map<java.lang.String,java.lang.Object> pParameters)

Description copied from interface: Transformer

Set the parameters to be used in all transformations.

Specified by:

setTransformationParameters in interface Transformer

Parameters:

pParameters - The transformation parameters.

setOutputFileCharset

public void setOutputFileCharset(java.nio.charset.Charset pCharset)

Description copied from interface: Transformer

Set the character set to encode the output files with.

Note that all implementations may not honor this setting.

Specified by:

setOutputFileCharset in interface Transformer

Parameters:

pCharset - The output file character set.

loadSources

public int loadSources(org.gradle.api.file.FileCollection pSourceFiles)

Description copied from interface: Transformer

Load the source files to transform in the next call to Transformer.executeTransformations(BiFunction).

Specified by:

loadSources in interface Transformer

Parameters:

pSourceFiles - The source files to load.

Returns:

The number of source files that couldn't be loaded and for which an error was logged.

loadTemplates

public int loadTemplates(org.gradle.api.file.FileCollection pTemplateFiles)

Description copied from interface: Transformer

Load the template files to transform source files with in the next call to Transformer.executeTransformations(BiFunction).

Specified by:

loadTemplates in interface Transformer

Parameters:

pTemplateFiles - The template files to load.

Returns:

The number of template files that couldn't be loaded and for which an error was logged.

executeTransformations

public int executeTransformations(java.util.function.BiFunction<java.io.File,java.io.File,OutputFileSpec> pOutputFileMapping)

Description copied from interface: Transformer

Apply all successfully loaded template files to all successfully loaded source files.

Specified by:

executeTransformations in interface Transformer

Parameters:

pOutputFileMapping - A function that returns the output file for a source/template file combination.

Returns:

The number of errors encountered during the transformations.