Class CounterColumn
java.lang.Object
org.jacoco.report.internal.html.table.CounterColumn
- All Implemented Interfaces:
IColumnRenderer
Column that prints the counter values of entities for each item and a summary
in the footer. If the total number of items is zero, no column is emitted at
all. The implementation is stateful, instances must not be used in parallel.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Comparator<ITableItem>
private final ICoverageNode.CounterEntity
private final NumberFormat
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CounterColumn
(ICoverageNode.CounterEntity entity, Locale locale, Comparator<ICoverageNode> comparator) Creates a new column that is based on theICounter
for the given entity. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
cell
(HTMLElement td, ICoverageNode node) void
footer
(HTMLElement td, ICoverageNode total, Resources resources, ReportOutputFolder base) Renders the footer for this column.Returns the comparator to sort this table column.protected abstract int
Retrieves the respective value from the counter.boolean
init
(List<? extends ITableItem> items, ICoverageNode total) Initializes the column before any output method is called.void
item
(HTMLElement td, ITableItem item, Resources resources, ReportOutputFolder base) Renders a single item in this column.static CounterColumn
newCovered
(ICoverageNode.CounterEntity entity, Locale locale) Creates a new column that shows the covered count for the given entity.static CounterColumn
newMissed
(ICoverageNode.CounterEntity entity, Locale locale) Creates a new column that shows the missed count for the given entity.static CounterColumn
newTotal
(ICoverageNode.CounterEntity entity, Locale locale) Creates a new column that shows the total count for the given entity.
-
Field Details
-
entity
-
integerFormat
-
comparator
-
-
Constructor Details
-
CounterColumn
protected CounterColumn(ICoverageNode.CounterEntity entity, Locale locale, Comparator<ICoverageNode> comparator) Creates a new column that is based on theICounter
for the given entity.- Parameters:
entity
- counter entity for this columnlocale
- locale for rendering numberscomparator
- comparator for the nodes of this column
-
-
Method Details
-
newTotal
Creates a new column that shows the total count for the given entity.- Parameters:
entity
- counter entity for this columnlocale
- locale for rendering numbers- Returns:
- column instance
-
newMissed
Creates a new column that shows the missed count for the given entity.- Parameters:
entity
- counter entity for this columnlocale
- locale for rendering numbers- Returns:
- column instance
-
newCovered
Creates a new column that shows the covered count for the given entity.- Parameters:
entity
- counter entity for this columnlocale
- locale for rendering numbers- Returns:
- column instance
-
init
Description copied from interface:IColumnRenderer
Initializes the column before any output method is called.- Specified by:
init
in interfaceIColumnRenderer
- Parameters:
items
- all items that will be displayed in the tabletotal
- the summary of all coverage data items in the table- Returns:
true
if the column should be visible
-
item
public void item(HTMLElement td, ITableItem item, Resources resources, ReportOutputFolder base) throws IOException Description copied from interface:IColumnRenderer
Renders a single item in this column.- Specified by:
item
in interfaceIColumnRenderer
- Parameters:
td
- the parent table cellitem
- the item to displayresources
- static resources that might be referencedbase
- base folder of the table- Throws:
IOException
- in case of IO problems with the element output
-
cell
- Throws:
IOException
-
getComparator
Description copied from interface:IColumnRenderer
Returns the comparator to sort this table column.- Specified by:
getComparator
in interfaceIColumnRenderer
- Returns:
- comparator for this column
-
getValue
Retrieves the respective value from the counter.- Parameters:
counter
- counter object- Returns:
- value of interest
-