@ExperimentalApi @ThreadSafe public interface

HelpUrls

implements Iterable<T>
com.atlassian.jira.help.HelpUrls
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

A mapping of keys to HelpUrls.

Summary

Public Methods
@Nonnull HelpUrl getDefaultUrl()
Returns a HelpUrl that can be used for generic JIRA help.
@Nonnull HelpUrl getUrl(String key)
Returns a HelpUrl associated with the passed key.
@Nonnull HelpUrl getUrlForApplication(ApplicationKey applicationKey, String key)
Adds the ability to retrieve HelpUrl specific to an application and key passed in.
@Nonnull Set<String> getUrlKeys()
Return all the keys that have an associated HelpUrl.
[Expand]
Inherited Methods
From interface java.lang.Iterable

Public Methods

@Nonnull public 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.

@Nonnull public HelpUrl getUrl (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

@Nonnull public HelpUrl getUrlForApplication (ApplicationKey applicationKey, String key)

Adds the ability to retrieve HelpUrl specific to an application and key passed in. The getDefaultUrl() URL is returned if the key has no associated URL.

Parameters
applicationKey the application to find help urls for
key the key to search for.
Returns
  • the HelpUrl

@Nonnull public Set<String> getUrlKeys ()

Return all the keys that have an associated HelpUrl.

Returns
  • all the keys that have an associated HelpUrl.