@PublicSpi public interface

SimpleLinkFactory

com.atlassian.jira.plugin.webfragment.SimpleLinkFactory
Known Indirect Subclasses

This interface is deprecated.
since v6.3 - use com.atlassian.plugin.web.api.provider.WebItemProvider

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

A factory that produces a list of SimpleLink objects.

Summary

Public Methods
@Nonnull List<SimpleLink> getLinks(ApplicationUser user, Map<StringObject> params)
Generates a list of SimpleLink objects.
void init(SimpleLinkFactoryModuleDescriptor descriptor)
Initialization method for the factory.

Public Methods

@Nonnull public List<SimpleLink> getLinks (ApplicationUser user, Map<StringObject> params)

Generates a list of SimpleLink objects.

Parameters
user The user this list is being generated for.
Returns
  • a list of SimpleLink objects tailored for the user.

public void init (SimpleLinkFactoryModuleDescriptor descriptor)

Initialization method for the factory. Used to retrieve information off the module descriptor

Parameters
descriptor The descriptor responsible for defining this factory.