Package com.atlassian.jira.web.util

Class HelpUtil

java.lang.Object

com.atlassian.jira.web.util.HelpUtil

@Deprecated
public class HelpUtil
extends Object

Deprecated.

since v6.2.4: The use of this class is discouraged. It now suggested to:

• Use an injected HelpUrls when you would have called getInstance() or HelpUtil(). It contains all of JIRA's help URLs and will adapt itself internally for the current user.
• Use an injected HelpUrlsParser when you would have called HelpUtil(java.util.Properties). HelpUrlsParser.parse(java.util.Properties) can be used to generate to generate a HelpUrls from a plugin provided Properties instance.

Utility bean class for building links to JIRA help pages. This bean is now a fly-weight that delegates most of its functionality off to HelpUrls.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	HelpUtil.HelpPath	Deprecated.

Constructor Summary

Constructors

Constructor	Description
HelpUtil()	Deprecated. since v6.2.4: Inject an instance of HelpUrls to access JIRA's help.
HelpUtil(String external, String internal)	Deprecated. since v6.2.4: Inject a HelpUrlsParser and use its HelpUrlsParser.parse(java.util.Properties, java.util.Properties) method.
HelpUtil(Properties properties)	Deprecated. since v6.2.4: Inject a HelpUrlsParser and use its HelpUrlsParser.parse(java.util.Properties) method.

Method Summary

Modifier and Type	Method	Description
HelpUtil.HelpPath	getHelpPath(String helpPathKey)	Deprecated. Returns the HelpUtil.HelpPath object for a given key.
static HelpUtil	getInstance()	Deprecated. since v6.2.4: Inject an instance of HelpUrls to access JIRA's help.
Set<String>	keySet()	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

HelpUtil

@Deprecated
public HelpUtil()

Deprecated.

since v6.2.4: Inject an instance of HelpUrls to access JIRA's help.

Returns a HelpUtil for JIRA's help URLs.

HelpUtil

@Deprecated
public HelpUtil(Properties properties)

Deprecated.

since v6.2.4: Inject a HelpUrlsParser and use its HelpUrlsParser.parse(java.util.Properties) method.

Return a HelpUtil representation of the passed properties. See HelpUrlsParser for information of the format of the passed properties.

Parameters:

properties - properties.

HelpUtil

@Deprecated
public HelpUtil(String external,
 String internal)

Deprecated.

since v6.2.4: Inject a HelpUrlsParser and use its HelpUrlsParser.parse(java.util.Properties, java.util.Properties) method.

This method is really only useful internally to JIRA.

Method Details

getInstance

@Deprecated
public static HelpUtil getInstance()

Deprecated.

since v6.2.4: Inject an instance of HelpUrls to access JIRA's help.

Returns a HelpUtil for the current user.

Returns:

a HelpUtil instance for the current user.

getHelpPath

public HelpUtil.HelpPath getHelpPath(String helpPathKey)

Deprecated.

Returns the HelpUtil.HelpPath object for a given key.

Parameters:

helpPathKey - the key in play

Returns:

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

keySet

public Set<String> keySet()

Deprecated.

Returns:

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