com.atlassian.jira.util
Class VelocityParamFactoryImpl

java.lang.Object
  extended by com.atlassian.jira.util.VelocityParamFactoryImpl
All Implemented Interfaces:
VelocityParamFactory

public class VelocityParamFactoryImpl
extends Object
implements VelocityParamFactory

Since:
v5.0

Constructor Summary
VelocityParamFactoryImpl(JiraAuthenticationContext jac)
           
 
Method Summary
 Map<String,Object> getDefaultVelocityParams()
          Method to construct a map with a number of common parameters used by velocity templates.
 Map<String,Object> getDefaultVelocityParams(JiraAuthenticationContext authenticationContext)
          Method to construct a map with a number of common parameters used by velocity templates.
 Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams)
          Method to construct a map with a number of common parameters used by velocity templates.
 Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams, JiraAuthenticationContext authenticationContext)
          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

VelocityParamFactoryImpl

public VelocityParamFactoryImpl(JiraAuthenticationContext jac)
Method Detail

getDefaultVelocityParams

public Map<String,Object> getDefaultVelocityParams()
Description copied from interface: VelocityParamFactory
Method to construct a map with a number of common parameters used by velocity templates. It uses the user from the current request.

Specified by:
getDefaultVelocityParams in interface VelocityParamFactory
Returns:
a Map with common velocity parameters

getDefaultVelocityParams

public Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams)
Description copied from interface: VelocityParamFactory
Method to construct a map with a number of common parameters used by velocity templates. It uses the user from the current request.

Specified by:
getDefaultVelocityParams in interface VelocityParamFactory
Parameters:
startingParams - Map of parameters that may be used to override any of the parameters set here.
Returns:
a Map with common velocity parameters

getDefaultVelocityParams

public Map<String,Object> getDefaultVelocityParams(JiraAuthenticationContext authenticationContext)
Description copied from interface: VelocityParamFactory
Method to construct a map with a number of common parameters used by velocity templates.

Specified by:
getDefaultVelocityParams in interface VelocityParamFactory
Parameters:
authenticationContext - JiraAuthenticationContext
Returns:
a Map with common velocity parameters

getDefaultVelocityParams

public Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams,
                                                   JiraAuthenticationContext authenticationContext)
Description copied from interface: VelocityParamFactory
Method to construct a map with a number of common parameters used by velocity templates.

Specified by:
getDefaultVelocityParams in interface VelocityParamFactory
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


Copyright © 2002-2013 Atlassian. All Rights Reserved.