com.atlassian.jira.help

Class MockHelpUrls

java.lang.Object

com.atlassian.jira.help.MockHelpUrls

All Implemented Interfaces:

HelpUrls, Iterable<HelpUrl>

public class MockHelpUrls
extends Object
implements HelpUrls

Since:

v6.2.4

Constructor Summary

Constructors

Constructor and Description
MockHelpUrls()
MockHelpUrls(HelpUrl defaultUrl, HelpUrl... urls)
MockHelpUrls(HelpUrl defaultUrl, Iterable<? extends HelpUrl> urls)

Method Summary

Modifier and Type	Method and Description
MockHelpUrls	addUrl(HelpUrl url)
MockHelpUrl	createDefault()
MockHelpUrl	createDefault(String key)
MockHelpUrl	createSimpleUrl(String key)
MockHelpUrl	createUrl(String key)
MockHelpUrls	defaultUrl(HelpUrl url)
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.
Iterator<HelpUrl>	iterator()
MockHelpUrls	merge(MockHelpUrls m)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MockHelpUrls

public MockHelpUrls(HelpUrl defaultUrl,
                    Iterable<? extends HelpUrl> urls)

MockHelpUrls

public MockHelpUrls(HelpUrl defaultUrl,
                    HelpUrl... urls)

MockHelpUrls

public MockHelpUrls()

Method Detail

merge

public MockHelpUrls merge(MockHelpUrls m)

getUrl

@Nonnull
public HelpUrl getUrl(@Nonnull
                               String key)

Description copied from interface: HelpUrls

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

Specified by:

getUrl in interface HelpUrls

Parameters:

key - the key to search for.

Returns:

the HelpUrl

getDefaultUrl

@Nonnull
public HelpUrl getDefaultUrl()

Description copied from interface: HelpUrls

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

Specified by:

getDefaultUrl in interface HelpUrls

Returns:

the default HelpUrl for this instance.

getUrlKeys

@Nonnull
public Set<String> getUrlKeys()

Description copied from interface: HelpUrls

Return all the keys that have an associated HelpUrl.

Specified by:

getUrlKeys in interface HelpUrls

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: HelpUrls

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

Specified by:

getUrlForApplication in interface HelpUrls

Parameters:

applicationKey - the application to find help urls for

key - the key to search for.

Returns:

the HelpUrl

iterator

public Iterator<HelpUrl> iterator()

Specified by:

iterator in interface Iterable<HelpUrl>

defaultUrl

public MockHelpUrls defaultUrl(HelpUrl url)

createDefault

public MockHelpUrl createDefault()

createDefault

public MockHelpUrl createDefault(String key)

addUrl

public MockHelpUrls addUrl(HelpUrl url)

createSimpleUrl

public MockHelpUrl createSimpleUrl(String key)

createUrl

public MockHelpUrl createUrl(String key)