Package com.atlassian.jira.project.type

Interface ProjectTypeIconRenderer

All Known Implementing Classes:
ProjectTypeIconRendererImpl
@PublicApi public interface ProjectTypeIconRenderer
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.
Since:
7.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    getIconToRender(ProjectTypeKey projectTypeKey)
    Returns the icon to render for the project type with the given key.

  • Method Details

    • getIconToRender

      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.

      Parameters:
      projectTypeKey - The project type key.
      Returns:
      The icon to be rendered. The returned Optional will be empty if project types is disabled.