com.atlassian.jira.project.type

Class ProjectTypeKeyFormatter

java.lang.Object

com.atlassian.jira.project.type.ProjectTypeKeyFormatter

@PublicApi
public class ProjectTypeKeyFormatter
extends Object

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

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
ProjectTypeKeyFormatter()

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectTypeKeyFormatter

public ProjectTypeKeyFormatter()

Method Detail

format

public static String format(@Nonnull
                            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