org.myire.munge.transform

Interface Transformer

All Known Implementing Classes:

FreeMarkerTransformer, SaxonTransformer

public interface Transformer

A Transformer executes transformations by applying templates to source files and writing the result to output files.

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 executeTransformations(BiFunction).
int	loadTemplates(org.gradle.api.file.FileCollection pTemplateFiles) Load the template files to transform source files with in the next call to executeTransformations(BiFunction).
default void	logTransformation(java.io.File pSourceFile, java.io.File pTemplateFile, OutputFileSpec pOutputFile) Log that a template file is applied to a source file to produce an output file.
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.

Method Detail

configure

boolean configure(java.io.File pConfigurationFile)

Configure this transformer with the values in a configuration file.

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

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

Set the parameters to be used in all transformations.

Parameters:

pParameters - The transformation parameters.

Throws:

java.lang.NullPointerException - if pParameters is null.

setOutputFileCharset

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

Set the character set to encode the output files with.

Note that all implementations may not honor this setting.

Parameters:

pCharset - The output file character set.

loadSources

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

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

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

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

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

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

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.

Parameters:

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

Returns:

The number of errors encountered during the transformations.

Throws:

java.lang.NullPointerException - if pOutputFileMapping is null.

logTransformation

default void logTransformation(java.io.File pSourceFile,
                               java.io.File pTemplateFile,
                               OutputFileSpec pOutputFile)

Log that a template file is applied to a source file to produce an output file.

Parameters:

pSourceFile - The source file.

pTemplateFile - The template file.

pOutputFile - The output file, or null if no explicit output file is used in the transformation.

Throws:

java.lang.NullPointerException - if pSourceFile or pTemplateFile is null.