de.alpharogroup.velocity

Class VelocityExtensions

java.lang.Object

de.alpharogroup.velocity.VelocityExtensions

public final class VelocityExtensions
extends Object

The class VelocityExtensions provides methods for create velocity template engines and templates.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_VALUE The Constant for the value of property 'resource.loader'.
static String	KEY_CLASSPATH_RESOURCE_LOADER_CLASS The Constant for the key of property 'classpath.resource.loader.class'.
static String	VELOCITY_TEMPLATE_FILE_EXTENSION The Constant VELOCITY_TEMPLATE_FILE_EXTENSION.

Constructor Summary

Constructors

Constructor and Description
VelocityExtensions()

Method Summary

Modifier and Type	Method and Description
static org.apache.velocity.app.VelocityEngine	getClasspathResourceLoaderVelocityEngine() Gets the velocity template 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(String templateAsString, String templateName) Gets a velocity template from the given String.
static org.apache.velocity.Template	getTemplate(String templateAsString, String templateName, String encoding) 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, Properties velocityProperties, String logTag, 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 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.
static void	mergeToContext(org.apache.velocity.app.VelocityEngine ve, org.apache.velocity.VelocityContext context, String templateFileName, String fileName) Merges the given template file to the given file in the given velocity context.
static void	mergeToContext(org.apache.velocity.app.VelocityEngine ve, org.apache.velocity.VelocityContext context, String path, String templateName, String fileName, String encoding) Merges the given template file to the given file in the given velocity context.
static org.apache.velocity.VelocityContext	newVelocityContext() Factory method for create a new VelocityContext.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSPATH_VALUE

public static final String CLASSPATH_VALUE

The Constant for the value of property 'resource.loader'.

See Also:

Constant Field Values

KEY_CLASSPATH_RESOURCE_LOADER_CLASS

public static final String KEY_CLASSPATH_RESOURCE_LOADER_CLASS

The Constant for the key of property 'classpath.resource.loader.class'.

See Also:

Constant Field Values

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

VelocityExtensions

public VelocityExtensions()

Method Detail

getClasspathResourceLoaderVelocityEngine

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

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

Returns:

the velocity template 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(String templateAsString,
                                                       String templateName)
                                                throws org.apache.velocity.runtime.parser.ParseException

Gets a velocity template from the given String.

Parameters:

templateAsString - the template as string

templateName - the template name

Returns:

the template

Throws:

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

getTemplate

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

Gets a velocity template from the given String.

Parameters:

templateAsString - the template as string

templateName - the template name

encoding - the encoding

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 velocity template engine

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 velocity template engine

path - the path

templateName - the template name

encoding - the encoding

Returns:

the template

merge

public static String merge(org.apache.velocity.VelocityContext context,
                           Properties velocityProperties,
                           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

velocityProperties - the velocity properties

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

templateAsString - the template as string

Returns:

the string

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

mergeToContext

public static void mergeToContext(org.apache.velocity.app.VelocityEngine ve,
                                  org.apache.velocity.VelocityContext context,
                                  String templateFileName,
                                  String fileName)
                           throws IOException

Merges the given template file to the given file in the given velocity context.

Parameters:

ve - the velocity template engine

context - the velocity context

templateFileName - the file name of the template file

fileName - the file name that will be created

Throws:

IOException - Signals that an I/O exception has occurred.

mergeToContext

public static void mergeToContext(org.apache.velocity.app.VelocityEngine ve,
                                  org.apache.velocity.VelocityContext context,
                                  String path,
                                  String templateName,
                                  String fileName,
                                  String encoding)
                           throws IOException

Merges the given template file to the given file in the given velocity context.

Parameters:

ve - the velocity template engine

context - the velocity context

path - the path

templateName - the template name

fileName - the file name that will be created

encoding - the encoding

Throws:

IOException - Signals that an I/O exception has occurred.

newVelocityContext

public static org.apache.velocity.VelocityContext newVelocityContext()

Factory method for create a new VelocityContext.

Returns:

the new VelocityContext