Package org.jacoco.report.internal
Class AbstractGroupVisitor
java.lang.Object
org.jacoco.report.internal.AbstractGroupVisitor
- All Implemented Interfaces:
IReportGroupVisitor
- Direct Known Subclasses:
HTMLGroupVisitor
,XMLGroupVisitor
Internal base visitor to calculate group counter summaries for hierarchical
reports.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate AbstractGroupVisitor
protected final CoverageNodeImpl
coverage node for this group to total counters -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractGroupVisitor
(String name) Creates a new group with the given name. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
protected abstract void
handleBundle
(IBundleCoverage bundle, ISourceFileLocator locator) Called to handle the given bundle in a specific way.protected abstract void
Called to handle the end of this group in a specific way.protected abstract AbstractGroupVisitor
handleGroup
(String name) Called to handle a group with the given name in a specific way.final void
visitBundle
(IBundleCoverage bundle, ISourceFileLocator locator) Called to add a bundle to the the report.final void
visitEnd()
Must be called at the end of every group.final IReportGroupVisitor
visitGroup
(String name) Called to add a new group to the report.
-
Field Details
-
total
coverage node for this group to total counters -
lastChild
-
-
Constructor Details
-
AbstractGroupVisitor
Creates a new group with the given name.- Parameters:
name
- name for the coverage node created internally
-
-
Method Details
-
visitBundle
public final void visitBundle(IBundleCoverage bundle, ISourceFileLocator locator) throws IOException Description copied from interface:IReportGroupVisitor
Called to add a bundle to the the report.- Specified by:
visitBundle
in interfaceIReportGroupVisitor
- Parameters:
bundle
- a bundle to include in the reportlocator
- source locator for this bundle- Throws:
IOException
- in case of IO problems with the report writer
-
handleBundle
protected abstract void handleBundle(IBundleCoverage bundle, ISourceFileLocator locator) throws IOException Called to handle the given bundle in a specific way.- Parameters:
bundle
- analyzed bundlelocator
- source locator- Throws:
IOException
- if the report can't be written
-
visitGroup
Description copied from interface:IReportGroupVisitor
Called to add a new group to the report. The returnedIReportGroupVisitor
instance can be used to add nested bundles or groups. The content of the group has to be completed before this or any parent visitor can be used again ("deep first").- Specified by:
visitGroup
in interfaceIReportGroupVisitor
- Parameters:
name
- name of the group- Returns:
- visitor for the group's content
- Throws:
IOException
- in case of IO problems with the report writer
-
handleGroup
Called to handle a group with the given name in a specific way.- Parameters:
name
- name of the group- Returns:
- created child group
- Throws:
IOException
- if the report can't be written
-
visitEnd
Must be called at the end of every group.- Throws:
IOException
- if the report can't be written
-
handleEnd
Called to handle the end of this group in a specific way.- Throws:
IOException
- if the report can't be written
-
finalizeLastChild
- Throws:
IOException
-