gololang

Class TemplateEngine

java.lang.Object

gololang.TemplateEngine

public class TemplateEngine
extends java.lang.Object

A simple template engine that turns text templates into Golo functions.

The template engine is similar to Ruby ERB or Java Server Pages. Golo code and directives can be embedded as follows:

• <% code %> blocks contain any Golo code, and
• <%= expression %> outputs the evaluation of expression, and
• <%@params foo, bar, baz %> makes the template function take these parameter names, and
• <%@import foo.bar.Baz %> is equivalent to a import in a Golo module.

Here is a template example:

 <%@params persons %>
 <% foreach (person in persons) { %>
 Name: <%= person: name() %>
 Email: <%= person: email() orIfNull "n/a" %>
 <% } %>
 

The resulting function would take a single parameter persons. When no @params clause is being specified, template functions are assumed to take a single params parameter.

It is important to note that this template engine performs no validation, either on the template itself or the generated function code. One may however catch the GoloCompilationException that compile(String) may throw, and inspect the faulty code using GoloCompilationException.getSourceCode() and GoloCompilationException.getProblems().

Constructor Summary

Constructors

Constructor and Description
TemplateEngine()

Method Summary

Modifier and Type	Method and Description
FunctionReference	compile(java.lang.String template) Compile a template into a function.
java.lang.String	templateToGolo(java.lang.String template) Generates the Golo code for a given template, but does not compile it.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateEngine

public TemplateEngine()

Method Detail

compile

public FunctionReference compile(java.lang.String template)

Compile a template into a function. The function takes parameters as specified using a @params clause, or a single params argument if none exists.

Parameters:

template - the template code.

Returns:

a compiled function that evaluates the template given parameters, and returns a String.

Throws:

GoloCompilationException - if a compilation error occurs in the generated Golo code.

templateToGolo

public java.lang.String templateToGolo(java.lang.String template)

Generates the Golo code for a given template, but does not compile it.

Parameters:

template - the template code.

Returns:

the corresponding Golo source code which may or may not be valid.