org.jacoco.report.html
Class HTMLFormatter

java.lang.Object
  extended by org.jacoco.report.html.HTMLFormatter
All Implemented Interfaces:
IHTMLReportContext, IReportFormatter

public class HTMLFormatter
extends Object
implements IReportFormatter, IHTMLReportContext

Formatter for coverage reports in multiple HTML pages.

Version:
0.4.1.20101007204400
Author:
Marc R. Hoffmann

Constructor Summary
HTMLFormatter()
          New instance with default settings.
 
Method Summary
 IReportVisitor createReportVisitor(ICoverageNode rootNode, List<SessionInfo> sessionInfos, Collection<ExecutionData> executionData)
          Creates a visitor for root of a coverage data tree.
 String getFooterText()
          Returns a string of textual information to include in every page footer.
 IIndexUpdate getIndexUpdate()
          Returns the service for index updates.
 ILanguageNames getLanguageNames()
          Returns the language names call-back used in this report.
 Locale getLocale()
          Returns the locale used to format numbers and dates.
 String getOutputEncoding()
          Returns the encoding of the generated HTML documents.
 Resources getResources()
          Returns the static resources used in this report.
 ILinkable getSessionsPage()
          Returns the link to the sessions page.
 Table getTable()
          Returns a table for rendering coverage nodes.
 void setFooterText(String footerText)
          Sets the optional text that should be included in every footer page.
 void setLanguageNames(ILanguageNames languageNames)
          Sets the implementation for language name display.
 void setLocale(Locale locale)
          Sets the locale used for report rendering.
 void setOutputEncoding(String outputEncoding)
          Sets the encoding used for generated HTML pages.
 void setReportOutput(IMultiReportOutput output)
          Defines the output for files created by the formatter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLFormatter

public HTMLFormatter()
New instance with default settings.

Method Detail

setReportOutput

public void setReportOutput(IMultiReportOutput output)
Defines the output for files created by the formatter. This is a mandatory property.

Parameters:
output - file output

setLanguageNames

public void setLanguageNames(ILanguageNames languageNames)
Sets the implementation for language name display. Java language names are defined by default.

Parameters:
languageNames - converter for language specific names

setLocale

public void setLocale(Locale locale)
Sets the locale used for report rendering. The current default locale is used by default.

Parameters:
locale - locale used for report rendering

setFooterText

public void setFooterText(String footerText)
Sets the optional text that should be included in every footer page.

Parameters:
footerText - footer text

setOutputEncoding

public void setOutputEncoding(String outputEncoding)
Sets the encoding used for generated HTML pages. Default is UTF-8.

Parameters:
outputEncoding - HTML output encoding

getLanguageNames

public ILanguageNames getLanguageNames()
Description copied from interface: IHTMLReportContext
Returns the language names call-back used in this report.

Specified by:
getLanguageNames in interface IHTMLReportContext
Returns:
language names

getResources

public Resources getResources()
Description copied from interface: IHTMLReportContext
Returns the static resources used in this report.

Specified by:
getResources in interface IHTMLReportContext
Returns:
static resources

getTable

public Table getTable()
Description copied from interface: IHTMLReportContext
Returns a table for rendering coverage nodes.

Specified by:
getTable in interface IHTMLReportContext
Returns:
table for rendering

getFooterText

public String getFooterText()
Description copied from interface: IHTMLReportContext
Returns a string of textual information to include in every page footer.

Specified by:
getFooterText in interface IHTMLReportContext
Returns:
footer text or empty string

getSessionsPage

public ILinkable getSessionsPage()
Description copied from interface: IHTMLReportContext
Returns the link to the sessions page.

Specified by:
getSessionsPage in interface IHTMLReportContext
Returns:
sessions page link

getOutputEncoding

public String getOutputEncoding()
Description copied from interface: IHTMLReportContext
Returns the encoding of the generated HTML documents.

Specified by:
getOutputEncoding in interface IHTMLReportContext
Returns:
encoding for generated HTML documents

getIndexUpdate

public IIndexUpdate getIndexUpdate()
Description copied from interface: IHTMLReportContext
Returns the service for index updates.

Specified by:
getIndexUpdate in interface IHTMLReportContext
Returns:
sevice for indes updates

getLocale

public Locale getLocale()
Description copied from interface: IHTMLReportContext
Returns the locale used to format numbers and dates.

Specified by:
getLocale in interface IHTMLReportContext
Returns:
locale for numbers and dates

createReportVisitor

public IReportVisitor createReportVisitor(ICoverageNode rootNode,
                                          List<SessionInfo> sessionInfos,
                                          Collection<ExecutionData> executionData)
                                   throws IOException
Description copied from interface: IReportFormatter
Creates a visitor for root of a coverage data tree.

Specified by:
createReportVisitor in interface IReportFormatter
Parameters:
rootNode - report root node
sessionInfos - list of chronological ordered SessionInfo objects where execution data has been collected for this report.
executionData - collection of all ExecutionData objects that are considered for this report
Returns:
visitor for the root node
Throws:
IOException