Module com.serenitybdd.serenityreports
Package 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 Details

  • Constructor Details

    • Formatter

      public Formatter(EnvironmentVariables environmentVariables)

    • Formatter

      public Formatter()

  • Method Details

    • 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)

    • 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)