zserio.extension.common

Class FreeMarkerUtil

java.lang.Object

zserio.extension.common.FreeMarkerUtil

public final class FreeMarkerUtil
extends java.lang.Object

The functions which handles FreeMarker Java Template Engine.

Constructor Summary

Constructors

Constructor and Description
FreeMarkerUtil()

Method Summary

Modifier and Type	Method and Description
static void	processTemplate(java.lang.String templateName, java.lang.Object templateDataModel, java.io.File outputFile) Processes FreeMarker template with the provided data model and generates output.
static void	processTemplate(java.lang.String templateName, java.lang.Object templateDataModel, java.io.File outputFile, boolean amalgamate) Processes FreeMarker template with the provided data model and generates output.
static void	processTemplate(java.lang.String templateName, java.lang.Object templateDataModel, java.io.Writer outputWriter) Processes FreeMarker template with the provided data model and generates output.
static java.util.List<java.lang.String>	readFreemarkerTemplate(java.lang.String templateName) Gets all lines of the requested FreeMarker template.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeMarkerUtil

public FreeMarkerUtil()

Method Detail

processTemplate

public static void processTemplate(java.lang.String templateName,
                                   java.lang.Object templateDataModel,
                                   java.io.Writer outputWriter)
                            throws ZserioExtensionException

Processes FreeMarker template with the provided data model and generates output.

Parameters:

templateName - The template name with the path relatively to "/FREEMARKER_LOCATION" directory.

templateDataModel - The template data model to apply.

outputWriter - The writer to use for generated output.

Throws:

ZserioExtensionException - In case of any template error.

processTemplate

public static void processTemplate(java.lang.String templateName,
                                   java.lang.Object templateDataModel,
                                   java.io.File outputFile)
                            throws ZserioExtensionException

Processes FreeMarker template with the provided data model and generates output.

Parameters:

templateName - The template name with the path relatively to "/FREEMARKER_LOCATION" directory.

templateDataModel - The template data model to apply.

outputFile - The output to be generated.

Throws:

ZserioExtensionException - In case of any template error.

processTemplate

public static void processTemplate(java.lang.String templateName,
                                   java.lang.Object templateDataModel,
                                   java.io.File outputFile,
                                   boolean amalgamate)
                            throws ZserioExtensionException

Processes FreeMarker template with the provided data model and generates output.

Parameters:

templateName - The template name with the path relatively to "/FREEMARKER_LOCATION" directory.

templateDataModel - The template data model to apply.

outputFile - The output to be generated.

amalgamate - True if the generated output will be amalgamated to the output file.

Throws:

ZserioExtensionException - In case of any template error.

readFreemarkerTemplate

public static java.util.List<java.lang.String> readFreemarkerTemplate(java.lang.String templateName)
                                                               throws ZserioExtensionException

Gets all lines of the requested FreeMarker template.

Parameters:

templateName - Name of the FreeMarker template to read.

Returns:

List of lines read from FreeMarker template.

Throws:

ZserioExtensionException - When the template is not available.