com.atlassian.jira.web.util

Class HelpUtil

java.lang.Object

com.atlassian.jira.web.util.HelpUtil

public class HelpUtil
extends Object

Utility class for building links to JIRA help pages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HelpUtil.HelpPath

Constructor Summary

Constructors

Constructor and Description
HelpUtil() Returns a HelpUtil using the default configuration.
HelpUtil(Properties externalProperties)
HelpUtil(String externalPropertiesFileLocation, String internalPropertiesFileLocation)

Method Summary

Methods

Modifier and Type	Method and Description
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpUtil

public HelpUtil()

Returns a HelpUtil using the default configuration.

HelpUtil

public HelpUtil(Properties externalProperties)

HelpUtil

public HelpUtil(String externalPropertiesFileLocation,
        String internalPropertiesFileLocation)

Method Detail

getInstance

public static HelpUtil getInstance()

Returns a HelpUtil that uses the default configuration. The default configuration is contained in the and 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.

getHelpPath

public HelpUtil.HelpPath getHelpPath(String helpPathKey)

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

Parameters:

helpPathKey - the key in play

Returns:

the HelpUtil.HelpPath for tht key or defaultHelpPath if it cant be found.

getHelpPath

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:

the HelpUtil.HelpPath for tht key or defaultHelpPath if it cant be found.

Since:

5.2

keySet

public Set<String> keySet()

Returns:

a set of all the keys that have HelpUtil.HelpPath values