Class HTMLFormatter

java.lang.Object

org.jacoco.report.html.HTMLFormatter

All Implemented Interfaces:

IHTMLReportContext

public class HTMLFormatter
extends Object
implements IHTMLReportContext

Formatter for coverage reports in multiple HTML pages.

Field Summary

Fields

Modifier and Type	Field	Description
private String	footerText
private ElementIndex	index
private ILanguageNames	languageNames
private Locale	locale
private String	outputEncoding
private Resources	resources
private SessionsPage	sessionsPage
private Table	table

Constructor Summary

Constructors

Constructor	Description
HTMLFormatter()	New instance with default settings.

Method Summary

Modifier and Type	Method	Description
private void	addMissedTotalColumns(Table table, String label, ICoverageNode.CounterEntity entity)
private Table	createTable()
IReportVisitor	createVisitor(IMultiReportOutput output)	Creates a new visitor to write a report to the given output.
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.

Methods inherited from class Object

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

Field Details

languageNames

private ILanguageNames languageNames

locale

private Locale locale

footerText

private String footerText

outputEncoding

private String outputEncoding

resources

private Resources resources

index

private ElementIndex index

sessionsPage

private SessionsPage sessionsPage

table

private Table table

Constructor Details

HTMLFormatter

public HTMLFormatter()

New instance with default settings.

Method Details

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

createTable

private Table createTable()

addMissedTotalColumns

private void addMissedTotalColumns(Table table,
 String label,
 ICoverageNode.CounterEntity entity)

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

createVisitor

public IReportVisitor createVisitor(IMultiReportOutput output)
                             throws IOException

Creates a new visitor to write a report to the given output.

Parameters:

output - output to write the report to

Returns:

visitor to emit the report data to

Throws:

IOException - in case of problems with the output stream