Java Doc for RenderTool.java in  » Template-Engine » Velocity » org » apache » velocity » tools » generic » Java Source Code / Java DocumentationJava Source Code and Java Documentation

NOTE: These examples assume you have placed an instance of the current context within itself as 'ctx'. And, of course, the RenderTool is assumed to be available as 'render'.

 Example of eval():
 Input
 -----
 #set( $list = [1,2,3] )
 #set( $object = '$list' )
 #set( $method = 'size()' )
 $render.eval($ctx, "${object}.$method")
 Output
 ------
 3
 Example of recurse():
 Input
 -----
 #macro( say_hi )hello world!#end
 #set( $foo = '#say_hi()' )
 #set( $bar = '$foo' )
 $render.recurse($ctx, $bar)
 Output
 ------
 hello world!
 Toolbox configuration:
 <tool>
 <key>render</key>
 <class>org.apache.velocity.tools.generic.RenderTool</class>
 </tool>
 

Ok, so these examples are really lame. But, it seems like someone out there is always asking how to do stuff like this and we always tell them to write a tool. Now we can just tell them to use this tool.

This tool is safe (and optimized) for use in the application scope of a servlet environment.

Evaluates a String containing VTL using the current context, and returns the result as a String.

Recursively evaluates a String containing VTL using the current context, and returns the result as a String.

Evaluates a String containing VTL using the current context, and returns the result as a String. By default if this fails, then null will be returned, though this tool can be configured to let Exceptions pass through. This evaluation is not recursive.

Recursively evaluates a String containing VTL using the current context, and returns the result as a String. It will continue to re-evaluate the output of the last evaluation until an evaluation returns the same code that was fed into it or the number of recursive loops exceeds the set parse depth.