fr.sii.ogham.core.template.parser

Interface TemplateParser

All Known Implementing Classes:

AutoDetectTemplateParser, FreeMarkerParser, ThymeleafParser

public interface TemplateParser

Interface that defines the general contract for template parsing. Template parsing consists to load a template from its name (or path) and then replace all variables that are defined in the template by the values provided by the context. The parser may rely on a ResourceResolver for finding and loading template.

Author:

Aurélien Baudet

See Also:

More information about template resolution

Method Summary

Modifier and Type	Method and Description
Content	parse(String templateName, Context ctx) Load the template from its name (or path).

Method Detail

parse

Content parse(String templateName,
              Context ctx)
       throws ParseException

Load the template from its name (or path). Read it and replace variables by the values defined in the context.

Parameters:

templateName - the name of the template to load (or the path)

ctx - the context that contains the variable values

Returns:

the content generated from the template

Throws:

ParseException - when the template couldn't be parsed either if the template couldn't be read or if the template could't be processed