public class

JiraVelocityUtils

extends Object
java.lang.Object
   ↳ com.atlassian.jira.util.JiraVelocityUtils

Class Overview

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 getVelocityParamFactory().

Summary

Nested Classes
class JiraVelocityUtils.LazyCalendar  
Public Constructors
JiraVelocityUtils()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public JiraVelocityUtils ()

Public Methods

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

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 getDefaultVelocityParams(JiraAuthenticationContext) instead.

Parameters
authenticationContext JiraAuthenticationContext
Returns
  • a Map with common velocity parameters

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 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