de.alpharogroup.velocity

Class VelocityUtils

java.lang.Object

de.alpharogroup.velocity.VelocityUtils

public class VelocityUtils
extends Object

The Class VelocityUtils.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VELOCITY_TEMPLATE_FILE_EXTENSION The Constant VELOCITY_TEMPLATE_FILE_EXTENSION.

Constructor Summary

Constructors

Constructor and Description
VelocityUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.velocity.app.VelocityEngine	getClasspathResourceLoaderVelocityEngine() Gets the velocity engine that load resources from the class path.
static org.apache.velocity.Template	getTemplate(String templateAsString) Gets a velocity template from the given String.
static org.apache.velocity.Template	getTemplate(org.apache.velocity.app.VelocityEngine ve, String path, String templateName) Gets the velocity template with default encoding "UTF-8".
static org.apache.velocity.Template	getTemplate(org.apache.velocity.app.VelocityEngine ve, String path, String templateName, String encoding) Gets the velocity template.
static String	merge(org.apache.velocity.VelocityContext context, String templateAsString) Merges the given context with the given template that is a String object and returns the result.
static String	merge(org.apache.velocity.VelocityContext context, String logTag, String templateAsString) Merges the given context with the given template that is a String object and returns the result.

Methods inherited from class java.lang.Object

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

Field Detail

VELOCITY_TEMPLATE_FILE_EXTENSION

public static final String VELOCITY_TEMPLATE_FILE_EXTENSION

The Constant VELOCITY_TEMPLATE_FILE_EXTENSION.

See Also:

Constant Field Values

Constructor Detail

VelocityUtils

public VelocityUtils()

Method Detail

getClasspathResourceLoaderVelocityEngine

public static org.apache.velocity.app.VelocityEngine getClasspathResourceLoaderVelocityEngine()

Gets the velocity engine that load resources from the class path.

Returns:

the velocity engine

getTemplate

public static org.apache.velocity.Template getTemplate(String templateAsString)
                                                throws org.apache.velocity.runtime.parser.ParseException

Gets a velocity template from the given String.

Parameters:

templateAsString - the template as string

Returns:

the template

Throws:

org.apache.velocity.runtime.parser.ParseException - the parse exception

getTemplate

public static org.apache.velocity.Template getTemplate(org.apache.velocity.app.VelocityEngine ve,
                                                       String path,
                                                       String templateName)

Gets the velocity template with default encoding "UTF-8".

Parameters:

ve - the ve

path - the path

templateName - the template name

Returns:

the template

getTemplate

public static org.apache.velocity.Template getTemplate(org.apache.velocity.app.VelocityEngine ve,
                                                       String path,
                                                       String templateName,
                                                       String encoding)

Gets the velocity template.

Parameters:

ve - the ve

path - the path

templateName - the template name

encoding - the encoding

Returns:

the template

merge

public static String merge(org.apache.velocity.VelocityContext context,
                           String templateAsString)

Merges the given context with the given template that is a String object and returns the result.

Parameters:

context - the context

templateAsString - the template as string

Returns:

the string

merge

public static String merge(org.apache.velocity.VelocityContext context,
                           String logTag,
                           String templateAsString)

Merges the given context with the given template that is a String object and returns the result.

Parameters:

context - the context

logTag - to be used as the template name for log messages

templateAsString - the template as string

Returns:

the string