com.atlassian.jira.health

Class HealthCheckMessageFormatter

java.lang.Object

com.atlassian.jira.health.HealthCheckMessageFormatter

@ParametersAreNonnullByDefault
public class HealthCheckMessageFormatter
extends Object

Create HTML and raw text messages simultaneously. This class was introduced for CPU-59 in an effort to improve the UX for admins experiencing a Johnson Event. It ensures that the messaging on the web is the same as in the logs. The two formats are exposed by the toText() and the toHtml() methods.

Since:

7.4

Constructor Summary

Constructors

Constructor and Description
HealthCheckMessageFormatter()

Method Summary

Modifier and Type	Method and Description
HealthCheckMessageFormatter	addLineBreak() Adds newline to the current message.
HealthCheckMessageFormatter	append(HealthCheckMessageFormatter... formatters) Appends the formatteted content to this instance.
HealthCheckMessageFormatter	appendLink(String url, String linkText, boolean newTab) Creates a hyperlink.
HealthCheckMessageFormatter	appendList(HealthCheckMessageFormatter... items) Formats items as a list.
HealthCheckMessageFormatter	appendList(Iterable<HealthCheckMessageFormatter> items) Formats items as a list.
static HealthCheckMessageFormatter	string(String s) Creates a new formatter of the given text.
static HealthCheckMessageFormatter	tag(String tag, HealthCheckMessageFormatter content) Wraps the given formatted content in the given tag.
String	toHtml() returns the current message state formatted as HTML
String	toText() returns the current message state formatted as text

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckMessageFormatter

public HealthCheckMessageFormatter()

Method Detail

string

@Nonnull
public static HealthCheckMessageFormatter string(String s)

Creates a new formatter of the given text.

Parameters:

s - the string to format

Returns:

HealthCheckMessageFormatter

tag

@Nonnull
public static HealthCheckMessageFormatter tag(String tag,
                                                       HealthCheckMessageFormatter content)

Wraps the given formatted content in the given tag.

Parameters:

tag - the HTML tag to wrap the content in

content - the formatter containing the content to be wrapped

Returns:

a new HealthCheckMessageFormatter

appendList

@Nonnull
public HealthCheckMessageFormatter appendList(HealthCheckMessageFormatter... items)

Formats items as a list.

Parameters:

items - the formatted contents to be rendered as list

Returns:

HealthCheckMessageFormatter

appendList

@Nonnull
public HealthCheckMessageFormatter appendList(Iterable<HealthCheckMessageFormatter> items)

Formats items as a list.

Parameters:

items - the formatted contents to be rendered as list

Returns:

HealthCheckMessageFormatter

appendLink

@Nonnull
public HealthCheckMessageFormatter appendLink(String url,
                                                       String linkText,
                                                       boolean newTab)

Creates a hyperlink.

Parameters:

url - the url the hyperlink points to

linkText - the text shown in the link

newTab - whether the link should open in a new tab (i.e. target="_blank"

Returns:

this formatter

addLineBreak

@Nonnull
public HealthCheckMessageFormatter addLineBreak()

Adds newline to the current message.

Returns:

HealthCheckMessageFormatter

append

@Nonnull
public HealthCheckMessageFormatter append(HealthCheckMessageFormatter... formatters)

Appends the formatteted content to this instance.

Parameters:

formatters - which contents will be added to this instance

Returns:

HealthCheckMessageFormatter

toHtml

@Nonnull
public String toHtml()

returns the current message state formatted as HTML

Returns:

String

toText

@Nonnull
public String toText()

returns the current message state formatted as text

Returns:

String