ru.dlabs71.library.email.util

Class TemplateUtils

java.lang.Object

ru.dlabs71.library.email.util.TemplateUtils

public class TemplateUtils
extends Object

It's the helper for creating formatted strings using the Velocity engine.

For more information about the velocity template engine, use the link: Apache Velocity Project

Project name: d-email

Creation date: 2023-08-27

Since:

1.0.0

Author:

Ivanov Danila

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateUtils.TemplatePath The class describes a path to template.

Constructor Summary

Constructors

Constructor and Description
TemplateUtils()

Method Summary

Modifier and Type	Method and Description
String	construct(String pathToTemplate, Map<String,Object> params) It returns the string constructed from the template and its parameters.
String	construct(org.apache.velocity.Template template, Map<String,Object> params) It returns the string constructed from the template and its parameters.
org.apache.velocity.Template	createClasspathTemplate(String pathTemplate) This method creates a template object from classpath resource.
org.apache.velocity.Template	createFileTemplate(String pathTemplate) This method creates a template object from the file system resource.
org.apache.velocity.Template	createJarFileTemplate(String pathTemplate) This method creates a template object from the file system resource.
org.apache.velocity.Template	createTemplate(String pathToTemplate) This method creates a template object by using a path to the template.
TemplateUtils.TemplatePath	normalizeTemplatePath(String source) This method normalizes a template path.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateUtils

public TemplateUtils()

Method Detail

construct

public String construct(String pathToTemplate,
                        Map<String,Object> params)
                 throws TemplateCreationException

It returns the string constructed from the template and its parameters.

Parameters:

pathToTemplate - the path to a template

params - parameters of a template

Returns:

the converted string

Throws:

TemplateCreationException - this exception will occur if the path to the template isn't valid

construct

public String construct(org.apache.velocity.Template template,
                        Map<String,Object> params)

It returns the string constructed from the template and its parameters.

Parameters:

template - the object template (see also Template)

params - parameters of a template

Returns:

the converted string

createTemplate

public org.apache.velocity.Template createTemplate(String pathToTemplate)
                                            throws TemplateCreationException

This method creates a template object by using a path to the template.

Parameters:

pathToTemplate - a path to the template. This parameter must start with one of these substrings: 'file://', 'classpath:', 'jar:file:'.

Returns:

template object (see also Template)

Throws:

TemplateCreationException - this exception will occur if the path to the template isn't valid

createClasspathTemplate

public org.apache.velocity.Template createClasspathTemplate(String pathTemplate)

This method creates a template object from classpath resource.

Parameters:

pathTemplate - a path to the classpath resource

Returns:

template object (see also Template)

createFileTemplate

public org.apache.velocity.Template createFileTemplate(String pathTemplate)

This method creates a template object from the file system resource.

Parameters:

pathTemplate - a path to the file system resource

Returns:

template object (see also Template)

createJarFileTemplate

public org.apache.velocity.Template createJarFileTemplate(String pathTemplate)

This method creates a template object from the file system resource.

Parameters:

pathTemplate - a path to the file system resource

Returns:

template object (see also Template)

normalizeTemplatePath

public TemplateUtils.TemplatePath normalizeTemplatePath(String source)

This method normalizes a template path. It'll remove different prefixes and split the incoming string into a path to a directory and the name of a file in this directory.

Prefixes are supported: 'file:///', 'classpath:', 'jar:file:'

Parameters:

source - a path to the resource

Returns:

the normalized path as object TemplateUtils.TemplatePath

Throws:

InvalidPathException - if the parameter 'source' has incorrect value