@ExperimentalApi @ThreadSafe public interface HelpUrls extends Iterable<HelpUrl>
HelpUrl
s.Modifier and Type | Method and Description |
---|---|
HelpUrl |
getDefaultUrl()
Returns a
HelpUrl that can be used for generic JIRA help. |
HelpUrl |
getUrl(String key)
Returns a
HelpUrl associated with the passed key. |
HelpUrl |
getUrlForApplication(com.atlassian.application.api.ApplicationKey applicationKey,
String key)
Adds the ability to retrieve
HelpUrl specific to an application and key passed in. |
Set<String> |
getUrlKeys()
Return all the keys that have an associated
HelpUrl . |
forEach, iterator, spliterator
@Nonnull HelpUrl getUrl(@Nonnull String key)
HelpUrl
associated with the passed key. The getDefaultUrl()
URL is returned if the key
has no associated URL.key
- the key to search for.HelpUrl
@Nonnull HelpUrl getDefaultUrl()
HelpUrl
that can be used for generic JIRA help. It commonly points
at the JIRA help index/landing page.HelpUrl
for this instance.@Nonnull Set<String> getUrlKeys()
HelpUrl
.HelpUrl
.@Nonnull HelpUrl getUrlForApplication(@Nonnull com.atlassian.application.api.ApplicationKey applicationKey, @Nonnull String key)
HelpUrl
specific to an application and key passed in. The getDefaultUrl()
URL is returned if the key
has no associated URL.applicationKey
- the application to find help urls forkey
- the key to search for.HelpUrl
Copyright © 2002-2015 Atlassian. All Rights Reserved.