|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.web.util.HelpUtil
public class HelpUtil
Utility class for building links to JIRA help pages.
Nested Class Summary | |
---|---|
class |
HelpUtil.HelpPath
|
Constructor Summary | |
---|---|
HelpUtil()
Returns a HelpUtil using the default configuration. |
|
HelpUtil(Properties externalProperties)
|
|
HelpUtil(String externalPropertiesFileLocation,
String internalPropertiesFileLocation)
|
Method Summary | |
---|---|
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 |
---|
public HelpUtil()
public HelpUtil(Properties externalProperties)
public HelpUtil(String externalPropertiesFileLocation, String internalPropertiesFileLocation)
Method Detail |
---|
public static HelpUtil getInstance()
and
files in JIRA.
The returned HelpUtil is identical to the singleton one, but we return a copy of
public HelpUtil.HelpPath getHelpPath(String helpPathKey)
HelpUtil.HelpPath
object for a given key, applying
helpPathKey
- the key in play
HelpUtil.HelpPath
for tht key or defaultHelpPath if it cant be
found.public HelpUtil.HelpPath getHelpPath(String helpPathKey, boolean useOnDemandOverrides)
HelpUtil.HelpPath
object for a given key
helpPathKey
- the key in playuseOnDemandOverrides
- whether to use ".ondemand" overrides
HelpUtil.HelpPath
for tht key or defaultHelpPath if it cant be
found.public Set<String> keySet()
HelpUtil.HelpPath
values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |