com.atlassian.jira.help
Interface HelpUrls

All Superinterfaces:

Iterable<HelpUrl>

All Known Implementing Classes:

CachingHelpUrls, MockHelpUrls

@ExperimentalApi
@ThreadSafe
public interface HelpUrls
extends Iterable<HelpUrl>

A mapping of keys to HelpUrls.

Since:

v6.2.4

Method Summary

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.
Set<String>	getUrlKeys() Return all the keys that have associated an associated HelpUrl.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getUrl

@Nonnull
HelpUrl getUrl(@Nonnull
                       String key)

Returns a HelpUrl associated with the passed key. The getDefaultUrl() URL is returned if the key has no associated URL.

Parameters:

key - the key to search for.

Returns:

the HelpUrl

getDefaultUrl

@Nonnull
HelpUrl getDefaultUrl()

Returns a HelpUrl that can be used for generic JIRA help. It commonly points at the JIRA help index/landing page.

Returns:

the default HelpUrl for this instance.

getUrlKeys

@Nonnull
Set<String> getUrlKeys()

Return all the keys that have associated an associated HelpUrl.

Returns:

all the keys that have associated an associated HelpUrl.