com.atlassian.velocity

Class JiraVelocityManager

java.lang.Object

com.atlassian.velocity.DefaultVelocityManager

com.atlassian.velocity.JiraVelocityManager

All Implemented Interfaces:

com.atlassian.velocity.VelocityManager

public class JiraVelocityManager
extends com.atlassian.velocity.DefaultVelocityManager

Constructor Summary

Constructors

Constructor and Description
JiraVelocityManager(DateTimeFormatter dateTimeFormatter) Deprecated. in 9.9: use the other, complete constructor
JiraVelocityManager(DateTimeFormatter dateTimeFormatter, VelocityEngineFactory velocityEngineFactory)

Method Summary

Modifier and Type	Method and Description
protected Map<String,?>	createContextParams(String baseurl, Map contextParameters)
protected org.apache.velocity.VelocityContext	createVelocityContext(Map params)
DateFormat	getDateFormat() Returns a new DateFormat.
protected org.apache.velocity.app.VelocityEngine	getVe()
boolean	isTemplateAvailable(String templateDirectory, String templateName, String encoding) Checks if the template is available and can be loaded.

Methods inherited from class com.atlassian.velocity.DefaultVelocityManager

getBody, getBody, getEncodedBody, getEncodedBody, getEncodedBody, getEncodedBodyForContent, getErrorMessageForException, initVe, writeEncodedBody, writeEncodedBodyForContent

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraVelocityManager

@Deprecated
public JiraVelocityManager(@Nonnull
                                       DateTimeFormatter dateTimeFormatter)

Deprecated. in 9.9: use the other, complete constructor

Constructor that looks up the VelocityEngineFactory using ComponentAccessor.

Parameters:

dateTimeFormatter - the date-time formatter

JiraVelocityManager

public JiraVelocityManager(@Nonnull
                           DateTimeFormatter dateTimeFormatter,
                           @Nonnull
                           VelocityEngineFactory velocityEngineFactory)

Method Detail

getDateFormat

public DateFormat getDateFormat()

Returns a new DateFormat.

Specified by:

getDateFormat in interface com.atlassian.velocity.VelocityManager

Overrides:

getDateFormat in class com.atlassian.velocity.DefaultVelocityManager

Returns:

a new DateFormat

isTemplateAvailable

public boolean isTemplateAvailable(String templateDirectory,
                                   String templateName,
                                   String encoding)

Checks if the template is available and can be loaded.

Parameters:

templateDirectory - relative directory path to the template

templateName - name of the template

encoding - encoding

Returns:

true if a template is available. Otherwise false

Since:

9.0.0

createVelocityContext

protected org.apache.velocity.VelocityContext createVelocityContext(Map params)

Overrides:

createVelocityContext in class com.atlassian.velocity.DefaultVelocityManager

createContextParams

protected Map<String,?> createContextParams(String baseurl,
                                            Map contextParameters)

Overrides:

createContextParams in class com.atlassian.velocity.DefaultVelocityManager

getVe

protected org.apache.velocity.app.VelocityEngine getVe()

Overrides:

getVe in class com.atlassian.velocity.DefaultVelocityManager