net.thucydides.core.reports.html

Class Formatter

java.lang.Object

net.thucydides.core.reports.html.Formatter

public class Formatter
extends 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 String	FOUR_SPACES
static String	NEW_LINE_ON_ANY_OS
static String	TAB
static String[][]	UNICODE_CHARS_ESCAPE
static String	UTF_8_NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Formatter()
Formatter(EnvironmentVariables environmentVariables)

Method Summary

Modifier and Type	Method and Description
static String	addLineBreaks(String text)
static String	addMarkdownLineBreaks(String text)
String	breadcrumbFormat(String parent, String child)
ContextIconFormatter	contextIcon()
String	convertAnyTables(String text)
String	escapedXML(String text)
String	formatWithFields(String textToFormat)
String	htmlAttributeCompatible(Object fieldValue)
String	htmlAttributeCompatible(Object fieldValue, boolean renderNewLines)
String	htmlAttributeCompatible(Object fieldValue, int maxLength)
String	htmlCompatible(Object fieldValue)
String	htmlCompatibleStepDescription(Object fieldValue)
String	htmlCompatibleStoryTitle(Object fieldValue)
String	htmlCompatibleTestTitle(Object fieldValue)
String	humanReadableFormOf(String text)
String	humanReadableTitle(String text)
String	javascriptCompatible(Object value)
String	messageBody(String message)
String	plainHtmlCompatible(Object fieldValue)
String	renderDescription(String text)
String	renderDescriptionWithEmbeddedResults(String text, RequirementsOutcomes requirementsOutcomes)
String	renderDescriptionWithFormattedTables(String text)
String	renderDescriptionWithFormattedTables(String text, RequirementsOutcomes requirementsOutcomes)
String	renderHeaders(String text)
String	renderHtmlEscapedDescription(String text)
String	renderMarkdown(String text)
String	renderMarkdownWithoutTags(String text)
String	renderTableDescription(String text, RequirementsOutcomes requirementsOutcomes)
String	renderText(String text)
String	renderTitle(String text)
String	restQuery(String message)
ResultIconFormatter	resultIcon()
ResultRankingFormatter	resultRank()
String	tagLabel(TestTag tag)
String	truncatedHtmlCompatible(String text, int length)

Methods inherited from class java.lang.Object

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

Field Detail

FOUR_SPACES

public static final String FOUR_SPACES

See Also:

Constant Field Values

TAB

public static final String TAB

See Also:

Constant Field Values

NEW_LINE_ON_ANY_OS

public static final String NEW_LINE_ON_ANY_OS

See Also:

Constant Field Values

UTF_8_NEW_LINE

public static final String UTF_8_NEW_LINE

See Also:

Constant Field Values

UNICODE_CHARS_ESCAPE

public static String[][] UNICODE_CHARS_ESCAPE

Constructor Detail

Formatter

public Formatter(EnvironmentVariables environmentVariables)

Formatter

public Formatter()

Method Detail

renderMarkdown

public String renderMarkdown(String text)

renderMarkdownWithoutTags

public String renderMarkdownWithoutTags(String text)

escapedXML

public String escapedXML(String text)

renderText

public String renderText(String text)

renderHeaders

public String renderHeaders(String text)

renderTitle

public String renderTitle(String text)

breadcrumbFormat

public String breadcrumbFormat(String parent,
                               String child)

renderHtmlEscapedDescription

public String renderHtmlEscapedDescription(String text)

renderDescription

public String renderDescription(String text)

renderDescriptionWithEmbeddedResults

public String renderDescriptionWithEmbeddedResults(String text,
                                                   RequirementsOutcomes requirementsOutcomes)

renderDescriptionWithFormattedTables

public String renderDescriptionWithFormattedTables(String text)

renderDescriptionWithFormattedTables

public String renderDescriptionWithFormattedTables(String text,
                                                   RequirementsOutcomes requirementsOutcomes)

renderTableDescription

public String renderTableDescription(String text,
                                     RequirementsOutcomes requirementsOutcomes)

addLineBreaks

public static String addLineBreaks(String text)

addMarkdownLineBreaks

public static String addMarkdownLineBreaks(String text)

convertAnyTables

public String convertAnyTables(String text)

htmlCompatible

public String htmlCompatible(Object fieldValue)

tagLabel

public String tagLabel(TestTag tag)

javascriptCompatible

public String javascriptCompatible(Object value)

messageBody

public String messageBody(String message)

restQuery

public String restQuery(String message)

htmlCompatibleStoryTitle

public String htmlCompatibleStoryTitle(Object fieldValue)

htmlCompatibleTestTitle

public String htmlCompatibleTestTitle(Object fieldValue)

htmlCompatibleStepDescription

public String htmlCompatibleStepDescription(Object fieldValue)

plainHtmlCompatible

public String plainHtmlCompatible(Object fieldValue)

htmlAttributeCompatible

public String htmlAttributeCompatible(Object fieldValue)

htmlAttributeCompatible

public String htmlAttributeCompatible(Object fieldValue,
                                      boolean renderNewLines)

htmlAttributeCompatible

public String htmlAttributeCompatible(Object fieldValue,
                                      int maxLength)

resultIcon

public ResultIconFormatter resultIcon()

contextIcon

public ContextIconFormatter contextIcon()

resultRank

public ResultRankingFormatter resultRank()

truncatedHtmlCompatible

public String truncatedHtmlCompatible(String text,
                                      int length)

humanReadableFormOf

public String humanReadableFormOf(String text)

humanReadableTitle

public String humanReadableTitle(String text)

formatWithFields

public String formatWithFields(String textToFormat)