org.finra.herd.service.helper

Class VelocityHelper

java.lang.Object

org.finra.herd.service.helper.VelocityHelper

@Component
public class VelocityHelper
extends Object

A helper to abstract operations around Apache Velocity. Note: This is the strict version of the velocity helper.

Constructor Summary

Constructors

Constructor and Description
VelocityHelper() Initializes the Velocity engine.

Method Summary

Modifier and Type	Method and Description
String	evaluate(Reader templateReader, Map<String,Object> variables, String logTag) Wrapper for Velocity.evaluate(org.apache.velocity.context.Context, java.io.Writer, String, java.io.InputStream)
String	evaluate(String template, Map<String,Object> variables, String logTag) Wrapper for Velocity.evaluate(org.apache.velocity.context.Context, java.io.Writer, String, java.io.InputStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityHelper

public VelocityHelper()

Initializes the Velocity engine.

Method Detail

evaluate

public String evaluate(Reader templateReader,
                       Map<String,Object> variables,
                       String logTag)

Wrapper for Velocity.evaluate(org.apache.velocity.context.Context, java.io.Writer, String, java.io.InputStream)

Parameters:

templateReader - A Reader of a Velocity template.

variables - Variables to add to context

logTag - The log tag

Returns:

String result of evaluation

evaluate

public String evaluate(String template,
                       Map<String,Object> variables,
                       String logTag)

Wrapper for Velocity.evaluate(org.apache.velocity.context.Context, java.io.Writer, String, java.io.InputStream)

Parameters:

template - The template String

variables - Variables to add to context

logTag - The log tag

Returns:

String result of evaluation