@PublicApi public class

ProjectTypeKeyFormatter

extends Object
java.lang.Object
   ↳ com.atlassian.jira.project.type.ProjectTypeKeyFormatter

@PublicApi

This class 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

Utility class to format a ProjectTypeKey so it can be displayed to users on copies.

Summary

Public Constructors
ProjectTypeKeyFormatter()
Public Methods
static String format(ProjectTypeKey projectTypeKey)
Formats the given project type key and returns a version of it that is suitable to be displayed to users.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ProjectTypeKeyFormatter ()

Public Methods

public static String format (ProjectTypeKey projectTypeKey)

Formats the given project type key and returns a version of it that is suitable to be displayed to users. It substitutes underscores with spaces and capitalises the first letter of every word on the project type key.

Some examples:

- key: "business" -> formatted: "Business" - key: "service_desk" -> formatted: "Service Desk"

Parameters
projectTypeKey The project type key to format
Returns
  • The formatted version of the project type key