Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

groovy.text
[Java] Class SimpleTemplateEngine

java.lang.Object
  groovy.text.TemplateEngine
      groovy.text.SimpleTemplateEngine

public class SimpleTemplateEngine
extends TemplateEngine

Processes template source files substituting variables and expressions into placeholders in a template source text to produce the desired output.

The template engine uses JSP style <% %> script and <%= %> expression syntax or GString style expressions. The variable 'out' is bound to the writer that the template is being written to.

Frequently, the template source will be in a file but here is a simple example providing the template as a string: 
 def binding = [
     firstname : "Grace",
     lastname  : "Hopper",
     accepted  : true,
     title     : 'Groovy for COBOL programmers'
 ]
 def engine = new groovy.text.SimpleTemplateEngine()
 def text = '''\
 Dear <%= firstname %> $lastname,

 We <% if (accepted) print 'are pleased' else print 'regret' %> \
 to inform you that your paper entitled
 '$title' was ${ accepted ? 'accepted' : 'rejected' }.

 The conference committee.
 '''
 def template = engine.createTemplate(text).make(binding)
 println template.toString()
This example uses a mix of the JSP style and GString style placeholders but you can typically use just one style if you wish. Running this example will produce this output: 
 Dear Grace Hopper,

 We are pleased to inform you that your paper entitled
 'Groovy for COBOL programmers' was accepted.

 The conference committee.
The template engine can also be used as the engine for TemplateServlet by placing the following in your web.xml file (plus a corresponding servlet-mapping element): 
 <servlet>
   <servlet-name>SimpleTemplate</servlet-name>
   <servlet-class>groovy.servlet.TemplateServlet</servlet-class>
   <init-param>
     <param-name>template.engine</param-name>
     <param-value>groovy.text.SimpleTemplateEngine</param-value>
   </init-param>
 </servlet>
In this case, your template source file should be HTML with the appropriate embedded placeholders.
Authors:
sam
Christian Stein
Paul King
Alex Tkachman

Constructor Summary
SimpleTemplateEngine()

SimpleTemplateEngine(boolean verbose)

SimpleTemplateEngine(java.lang.ClassLoader parentLoader)

SimpleTemplateEngine(GroovyShell groovyShell)

 
Method Summary
Template createTemplate(java.io.Reader reader)

boolean isVerbose()

void setVerbose(boolean verbose)

@param verbose true if you want the engine to display the template source file for debugging purposes
 
Methods inherited from class TemplateEngine
createTemplate, createTemplate, createTemplate, createTemplate
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Constructor Detail

SimpleTemplateEngine

public SimpleTemplateEngine()

SimpleTemplateEngine

public SimpleTemplateEngine(boolean verbose)

SimpleTemplateEngine

public SimpleTemplateEngine(java.lang.ClassLoader parentLoader)

SimpleTemplateEngine

public SimpleTemplateEngine(GroovyShell groovyShell)

 
Method Detail

createTemplate

public Template createTemplate(java.io.Reader reader)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)
Parameters:
verbose - true if you want the engine to display the template source file for debugging purposes

 

Groovy Documentation