public class

HelpUtil

extends Object
java.lang.Object
   ↳ com.atlassian.jira.web.util.HelpUtil

Class Overview

Utility class for building links to JIRA help pages.

Summary

Nested Classes
class HelpUtil.HelpPath  
Public Constructors
HelpUtil()
Returns a HelpUtil using the default configuration.
HelpUtil(Properties externalProperties)
HelpUtil(String externalPropertiesFileLocation, String internalPropertiesFileLocation)
Public Methods
HelpUtil.HelpPath getHelpPath(String helpPathKey)
Returns the HelpUtil.HelpPath object for a given key, applying
HelpUtil.HelpPath getHelpPath(String helpPathKey, boolean useOnDemandOverrides)
Returns the HelpUtil.HelpPath object for a given key
static HelpUtil getInstance()
Returns a HelpUtil that uses the default configuration.
Set<String> keySet()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public HelpUtil ()

Returns a HelpUtil using the default configuration.

public HelpUtil (Properties externalProperties)

public HelpUtil (String externalPropertiesFileLocation, String internalPropertiesFileLocation)

Public Methods

public HelpUtil.HelpPath getHelpPath (String helpPathKey)

Returns the HelpUtil.HelpPath object for a given key, applying

Parameters
helpPathKey the key in play
Returns

public HelpUtil.HelpPath getHelpPath (String helpPathKey, boolean useOnDemandOverrides)

Returns the HelpUtil.HelpPath object for a given key

Parameters
helpPathKey the key in play
useOnDemandOverrides whether to use ".ondemand" overrides
Returns

public static HelpUtil getInstance ()

Returns a HelpUtil that uses the default configuration. The default configuration is contained in the {@value #HELP_PATH_CONFIG_LOCATION} and {@value #INTERNAL_HELP_PATH_CONFIG_LOCATION} files in JIRA.

The returned HelpUtil is identical to the singleton one, but we return a copy of

Returns
  • the singleton HelpUtil instance that is used to hbuild links to JIRA help pages.

public Set<String> keySet ()

Returns