Class VelocityEngine

java.lang.Object

services.moleculer.web.template.AbstractTemplateEngine

services.moleculer.web.template.VelocityEngine

public class VelocityEngine
extends AbstractTemplateEngine

Server-side template engine based on Apache Velocity API. Required dependency:

// https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core
compile group: 'org.apache.velocity', name: 'velocity-engine-core', version: '2.1'

See Also:

• DataTreeEngine
• FreeMarkerEngine
• HandlebarsEngine
• MustacheEngine
• PebbleEngine
• ThymeleafEngine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VelocityEngine.VelocityResourceLoader

Field Summary

Fields

Modifier and Type	Field	Description
protected String	charsetName	Charset name.
protected org.apache.velocity.app.VelocityEngine	engine	Internal Velocity instance.
protected AtomicBoolean	inited	Is VelocityEngine inited?
protected VelocityEngine.VelocityResourceLoader	loader	Resource loader.
protected List<String>	macroLibraries	A list of template files containing macros to be used when merging.

Fields inherited from class AbstractTemplateEngine

charset, defaultExtension, executor, messageLoader, reloadable, templatePath, writeBufferSize

Constructor Summary

Constructors

Constructor	Description
VelocityEngine()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.VelocityEngine	getEngine()
List<String>	getMacroLibraries()
void	setApplicationAttribute(String key, Object value)
void	setCharset(Charset charset)
void	setDefaultExtension(String defaultExtension)
void	setEngine(org.apache.velocity.app.VelocityEngine engine)
void	setMacroLibraries(List<String> macroLibraries)
void	setProperties(String propsFilename)
void	setProperties(Properties configuration)
void	setProperty(String key, Object value)
void	setReloadable(boolean reloadable)
void	setTemplatePath(String templatePath)
byte[]	transform(String templatePath, io.datatree.Tree data)

Methods inherited from class AbstractTemplateEngine

getAbsolutePath, getAbsolutePath, getCharset, getDefaultExtension, getExecutor, getLastModifiedMillis, getMessageLoader, getTemplatePath, getWriteBufferSize, isReloadable, loadResource, setExecutor, setMessageLoader, setWriteBufferSize

Methods inherited from class Object

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

Field Details

engine

protected org.apache.velocity.app.VelocityEngine engine

Internal Velocity instance.

macroLibraries

protected List<String> macroLibraries

A list of template files containing macros to be used when merging.

charsetName

protected String charsetName

Charset name.

inited

protected AtomicBoolean inited

Is VelocityEngine inited?

loader

protected VelocityEngine.VelocityResourceLoader loader

Resource loader.

Constructor Details

VelocityEngine

public VelocityEngine()

Method Details

transform

public byte[] transform(String templatePath,
 io.datatree.Tree data)
                 throws Exception

Specified by:

transform in class AbstractTemplateEngine

Throws:

Exception

setCharset

public void setCharset(Charset charset)

Overrides:

setCharset in class AbstractTemplateEngine

setTemplatePath

public void setTemplatePath(String templatePath)

Overrides:

setTemplatePath in class AbstractTemplateEngine

setDefaultExtension

public void setDefaultExtension(String defaultExtension)

Overrides:

setDefaultExtension in class AbstractTemplateEngine

setReloadable

public void setReloadable(boolean reloadable)

Overrides:

setReloadable in class AbstractTemplateEngine

getEngine

public org.apache.velocity.app.VelocityEngine getEngine()

setEngine

public void setEngine(org.apache.velocity.app.VelocityEngine engine)

setProperty

public void setProperty(String key,
 Object value)

setProperties

public void setProperties(Properties configuration)

setProperties

public void setProperties(String propsFilename)

setApplicationAttribute

public void setApplicationAttribute(String key,
 Object value)

getMacroLibraries

public List<String> getMacroLibraries()

setMacroLibraries

public void setMacroLibraries(List<String> macroLibraries)