com.atlassian.jira.help

Interface HelpUrlsLoader

All Superinterfaces:

com.google.common.base.Function<HelpUrlsLoader.HelpUrlsLoaderKey,HelpUrls>

All Known Implementing Classes:

DefaultHelpUrlsLoader, MockHelpUrlsLoader

public interface HelpUrlsLoader
extends com.google.common.base.Function<HelpUrlsLoader.HelpUrlsLoaderKey,HelpUrls>

Searches and loads the HelpUrls using a HelpUrlsLoader.HelpUrlsLoaderKey.

Since:

v6.2.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HelpUrlsLoader.HelpUrlsLoaderKey Marker interface for all the state that is required to get a HelpUrls instance.

Method Summary

Modifier and Type	Method and Description
HelpUrls	apply(HelpUrlsLoader.HelpUrlsLoaderKey input) Return the HelpUrls associated with the passed HelpUrlsLoader.HelpUrlsLoaderKey.
HelpUrlsLoader.HelpUrlsLoaderKey	keyForApplication(com.atlassian.application.api.ApplicationKey applicationKey) Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the application key provided.
HelpUrlsLoader.HelpUrlsLoaderKey	keyForCurrentUser() Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the calling user.

Methods inherited from interface com.google.common.base.Function

equals

Method Detail

keyForCurrentUser

@Nonnull
HelpUrlsLoader.HelpUrlsLoaderKey keyForCurrentUser()

Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the calling user. It can safely be used as a key to cache the result of a HelpUrls lookup.

Returns:

the loader key associated with the calling user.

keyForApplication

@Nonnull
HelpUrlsLoader.HelpUrlsLoaderKey keyForApplication(@Nonnull
                                                            com.atlassian.application.api.ApplicationKey applicationKey)

Return the HelpUrlsLoader.HelpUrlsLoaderKey associated with the application key provided. It can safely be used as a key to cache the result of a HelpUrls lookup.

Returns:

the loader key associated with the passed application.

Since:

7.0

apply

HelpUrls apply(@Nullable
               HelpUrlsLoader.HelpUrlsLoaderKey input)

Return the HelpUrls associated with the passed HelpUrlsLoader.HelpUrlsLoaderKey. The passed HelpUrlsLoaderKey must have been returned from a previous call to keyForCurrentUser() on this instance. It is not safe to use HelpUrlsLoaderKey across instances of HelpUrlsLoader.

Specified by:

apply in interface com.google.common.base.Function<HelpUrlsLoader.HelpUrlsLoaderKey,HelpUrls>

Parameters:

input - the HelpUrlsLoaderKey to query for. It must have been returned from a keyForCurrentUser() on this instance. Using HelpUrlsLoaderKey from other instances may result in runtime exceptions.

Returns:

the HelpUrls associated with the passed key.