@PublicApi public interface


Known Indirect Subclasses


This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Class responsible for rendering the icon of a project type, according to its status on the instance (uninstalled, unlicensed, installed, etc...). Use this class whenever you need to render the icon for the project type associated with a project.


Public Methods
Optional<String> getIconToRender(ProjectTypeKey projectTypeKey)
Returns the icon to render for the project type with the given key.

Public Methods

public Optional<String> getIconToRender (ProjectTypeKey projectTypeKey)

Returns the icon to render for the project type with the given key.

The icon to be rendered will be the one defined for the project type with the given key as long as that project type is installed on the JIRA instance.

Otherwise, the icon will be a grayed out one, indicating that the project type is not accessible.

projectTypeKey The project type key.
  • The icon to be rendered. The returned Optional will be empty if project types is disabled.