Package com.atlassian.jira.help
Class MockHelpUrls
java.lang.Object
com.atlassian.jira.help.MockHelpUrls
- Since:
- v6.2.4
-
Constructor Summary
ConstructorsConstructorDescriptionMockHelpUrls(HelpUrl defaultUrl, HelpUrl... urls) MockHelpUrls(HelpUrl defaultUrl, Iterable<? extends HelpUrl> urls) -
Method Summary
Modifier and TypeMethodDescriptioncreateDefault(String key) createSimpleUrl(String key) defaultUrl(HelpUrl url) Returns aHelpUrlthat can be used for generic Jira help.Returns aHelpUrlassociated with the passed key.getUrlForApplication(com.atlassian.application.api.ApplicationKey applicationKey, String key) Adds the ability to retrieveHelpUrlspecific to an application and key passed in.Return all the keys that have an associatedHelpUrl.iterator()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
MockHelpUrls
-
MockHelpUrls
-
MockHelpUrls
public MockHelpUrls()
-
-
Method Details
-
merge
-
getUrl
Description copied from interface:HelpUrlsReturns aHelpUrlassociated with the passed key. TheHelpUrls.getDefaultUrl()URL is returned if thekeyhas no associated URL. -
getDefaultUrl
Description copied from interface:HelpUrlsReturns aHelpUrlthat can be used for generic Jira help. It commonly points at the Jira help index/landing page.- Specified by:
getDefaultUrlin interfaceHelpUrls- Returns:
- the default
HelpUrlfor this instance.
-
getUrlKeys
Description copied from interface:HelpUrlsReturn all the keys that have an associatedHelpUrl.- Specified by:
getUrlKeysin interfaceHelpUrls- Returns:
- all the keys that have an associated
HelpUrl.
-
getUrlForApplication
@Nonnull public HelpUrl getUrlForApplication(@Nonnull com.atlassian.application.api.ApplicationKey applicationKey, @Nonnull String key) Description copied from interface:HelpUrlsAdds the ability to retrieveHelpUrlspecific to an application and key passed in. TheHelpUrls.getDefaultUrl()URL is returned if thekeyhas no associated URL.- Specified by:
getUrlForApplicationin interfaceHelpUrls- Parameters:
applicationKey- the application to find help urls forkey- the key to search for.- Returns:
- the
HelpUrl
-
iterator
-
defaultUrl
-
createDefault
-
createDefault
-
addUrl
-
createSimpleUrl
-
createUrl
-