net.thucydides.core.reports.html

Class Formatter

java.lang.Object

net.thucydides.core.reports.html.Formatter

public class Formatter
extends java.lang.Object

Format text for HTML reports. In particular, this integrates JIRA links into the generated reports.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FOUR_SPACES
static java.lang.String	NEW_LINE_ON_ANY_OS
static java.lang.String	TAB
static java.lang.String[][]	UNICODE_CHARS_ESCAPE
static java.lang.String	UTF_8_NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Formatter(IssueTracking issueTracking)
Formatter(IssueTracking issueTracking, EnvironmentVariables environmentVariables)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addLineBreaks(java.lang.String text)
java.lang.String	addLinks(java.lang.String value)
java.lang.String	convertAnyTables(java.lang.String text)
java.lang.String	formatWithFields(java.lang.String textToFormat)
static java.util.List<java.lang.String>	fullIssuesIn(java.lang.String value)
java.lang.String	htmlAttributeCompatible(java.lang.Object fieldValue)
java.lang.String	htmlAttributeCompatible(java.lang.Object fieldValue, int maxLength)
java.lang.String	htmlCompatible(java.lang.Object fieldValue)
java.lang.String	htmlCompatibleStepDescription(java.lang.Object fieldValue)
java.lang.String	htmlCompatibleStoryTitle(java.lang.Object fieldValue)
java.lang.String	htmlCompatibleTestTitle(java.lang.Object fieldValue)
static java.util.List<java.lang.String>	issuesIn(java.lang.String value)
java.lang.String	messageBody(java.lang.String message)
java.lang.String	plainHtmlCompatible(java.lang.Object fieldValue)
java.lang.String	renderAsciidoc(java.lang.String text)
java.lang.String	renderDescription(java.lang.String text)
java.lang.String	renderHeaders(java.lang.String text)
java.lang.String	renderMarkdown(java.lang.String text)
java.lang.String	renderText(java.lang.String text)
java.lang.String	restQuery(java.lang.String message)
ResultIconFormatter	resultIcon()
ResultRankingFormatter	resultRank()
static java.util.List<java.lang.String>	shortenedIssuesIn(java.lang.String value)
java.lang.String	stripQualifications(java.lang.String title)
java.lang.String	truncatedHtmlCompatible(java.lang.String text, int length)

Methods inherited from class java.lang.Object

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

Field Detail

FOUR_SPACES

public static final java.lang.String FOUR_SPACES

See Also:

Constant Field Values

TAB

public static final java.lang.String TAB

See Also:

Constant Field Values

NEW_LINE_ON_ANY_OS

public static final java.lang.String NEW_LINE_ON_ANY_OS

See Also:

Constant Field Values

UTF_8_NEW_LINE

public static final java.lang.String UTF_8_NEW_LINE

See Also:

Constant Field Values

UNICODE_CHARS_ESCAPE

public static java.lang.String[][] UNICODE_CHARS_ESCAPE

Constructor Detail

Formatter

@Inject
public Formatter(IssueTracking issueTracking,
                         EnvironmentVariables environmentVariables)

Formatter

public Formatter(IssueTracking issueTracking)

Method Detail

renderAsciidoc

public java.lang.String renderAsciidoc(java.lang.String text)

renderMarkdown

public java.lang.String renderMarkdown(java.lang.String text)

stripQualifications

public java.lang.String stripQualifications(java.lang.String title)

renderText

public java.lang.String renderText(java.lang.String text)

renderHeaders

public java.lang.String renderHeaders(java.lang.String text)

issuesIn

public static java.util.List<java.lang.String> issuesIn(java.lang.String value)

addLinks

public java.lang.String addLinks(java.lang.String value)

renderDescription

public java.lang.String renderDescription(java.lang.String text)

addLineBreaks

public static java.lang.String addLineBreaks(java.lang.String text)

convertAnyTables

public java.lang.String convertAnyTables(java.lang.String text)

htmlCompatible

public java.lang.String htmlCompatible(java.lang.Object fieldValue)

messageBody

public java.lang.String messageBody(java.lang.String message)

restQuery

public java.lang.String restQuery(java.lang.String message)

htmlCompatibleStoryTitle

public java.lang.String htmlCompatibleStoryTitle(java.lang.Object fieldValue)

htmlCompatibleTestTitle

public java.lang.String htmlCompatibleTestTitle(java.lang.Object fieldValue)

htmlCompatibleStepDescription

public java.lang.String htmlCompatibleStepDescription(java.lang.Object fieldValue)

plainHtmlCompatible

public java.lang.String plainHtmlCompatible(java.lang.Object fieldValue)

htmlAttributeCompatible

public java.lang.String htmlAttributeCompatible(java.lang.Object fieldValue)

htmlAttributeCompatible

public java.lang.String htmlAttributeCompatible(java.lang.Object fieldValue,
                                                int maxLength)

resultIcon

public ResultIconFormatter resultIcon()

resultRank

public ResultRankingFormatter resultRank()

truncatedHtmlCompatible

public java.lang.String truncatedHtmlCompatible(java.lang.String text,
                                                int length)

shortenedIssuesIn

public static java.util.List<java.lang.String> shortenedIssuesIn(java.lang.String value)

fullIssuesIn

public static java.util.List<java.lang.String> fullIssuesIn(java.lang.String value)

formatWithFields

public java.lang.String formatWithFields(java.lang.String textToFormat)