com.atlassian.jira.util

Class JiraVelocityUtils

java.lang.Object

com.atlassian.jira.util.JiraVelocityUtils

public class JiraVelocityUtils
extends Object

Helper class that contains a number of utility methods for velocity templates.

This class is not in the JIRA API, so Plugin developers are recommended to use VelocityParamFactory instead, which can be dependency injected, else use ComponentAccessor.getVelocityParamFactory().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JiraVelocityUtils.LazyCalendar

Constructor Summary

Constructors

Constructor and Description
JiraVelocityUtils()

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	createVelocityParams(JiraAuthenticationContext authenticationContext)
static Map<String,Object>	getDefaultVelocityParams(JiraAuthenticationContext authenticationContext) Static method to construct a map with a number of common parameters used by velocity templates.
static Map<String,Object>	getDefaultVelocityParams(Map<String,Object> startingParams, JiraAuthenticationContext authenticationContext) Static method to construct a map with a number of common parameters used by velocity templates.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraVelocityUtils

public JiraVelocityUtils()

Method Detail

getDefaultVelocityParams

public static Map<String,Object> getDefaultVelocityParams(JiraAuthenticationContext authenticationContext)

Static method to construct a map with a number of common parameters used by velocity templates.

For API compliance, use VelocityParamFactory.getDefaultVelocityParams(JiraAuthenticationContext) instead.

Parameters:

authenticationContext - JiraAuthenticationContext

Returns:

a Map with common velocity parameters

getDefaultVelocityParams

public static Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams,
                                                          JiraAuthenticationContext authenticationContext)

Static method to construct a map with a number of common parameters used by velocity templates.

For API compliance, use VelocityParamFactory.getDefaultVelocityParams(java.util.Map, com.atlassian.jira.security.JiraAuthenticationContext) instead.

Parameters:

startingParams - Map of parameters that may be used to override any of the parameters set here.

authenticationContext - JiraAuthenticationContext

Returns:

a Map with common velocity parameters

createVelocityParams

public static Map<String,Object> createVelocityParams(JiraAuthenticationContext authenticationContext)