com.atlassian.jira.web.util
Class HelpUtil

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

public class HelpUtil
extends Object

Helps look up titles and URLs of help links.

Nested Class Summary

class

HelpUtil.HelpPath

Constructor Summary

HelpUtil()

HelpUtil(Properties externalProperties)

HelpUtil(String externalPropertiesFileLocation, String internalPropertiesFileLocation)

Method Summary

HelpUtil.HelpPath	getHelpPath(String helpPathKey) Returns the HelpUtil.HelpPath object for a given key
static HelpUtil	getInstance()
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()

HelpUtil

public HelpUtil(String externalPropertiesFileLocation,
                String internalPropertiesFileLocation)

HelpUtil

public HelpUtil(Properties externalProperties)

Method Detail

getHelpPath

public HelpUtil.HelpPath getHelpPath(String helpPathKey)

Returns the HelpUtil.HelpPath object for a given key

Parameters:

helpPathKey - the key in play

Returns:

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

keySet

public Set<String> keySet()

Returns:

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

getInstance

public static HelpUtil getInstance()