com.intellij.rt.coverage.util

Class ReportSection

java.lang.Object

com.intellij.rt.coverage.util.ReportSection

Direct Known Subclasses:

ClassListSection, IncludePatternsSection

public abstract class ReportSection
extends java.lang.Object

A report section is an extra data that is written to the report file after the main part.

Constructor Summary

Constructors

Constructor and Description
ReportSection()

Method Summary

Modifier and Type	Method and Description
abstract int	getId() Unique identifier of the section.
abstract int	getVersion() Sections perform independent versioning to support individual section skipping.
abstract boolean	isEngaged(ProjectData projectData, InstrumentationOptions options) Check if this section should be added to the report.
abstract void	load(ProjectData projectData, java.io.DataInputStream in, org.jetbrains.coverage.gnu.trove.TIntObjectHashMap<ClassData> dict, int version) Load data that was previously saved via saveInternal method.
void	save(ProjectData projectData, java.io.DataOutputStream out, org.jetbrains.coverage.gnu.trove.TObjectIntHashMap<java.lang.String> dict) Save section data.
protected abstract void	saveInternal(ProjectData projectData, java.io.DataOutput out, org.jetbrains.coverage.gnu.trove.TObjectIntHashMap<java.lang.String> dict)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportSection

public ReportSection()

Method Detail

getId

public abstract int getId()

Unique identifier of the section. If the identifier is unknown, the section data is skipped.

getVersion

public abstract int getVersion()

Sections perform independent versioning to support individual section skipping. If the version is newer that current support version, the section data is skipped.

isEngaged

public abstract boolean isEngaged(ProjectData projectData,
                                  InstrumentationOptions options)

Check if this section should be added to the report.

load

public abstract void load(ProjectData projectData,
                          java.io.DataInputStream in,
                          org.jetbrains.coverage.gnu.trove.TIntObjectHashMap<ClassData> dict,
                          int version)
                   throws java.io.IOException

Load data that was previously saved via saveInternal method.

Parameters:

version - version of the section in the agent that generated the report, may be lower than the current version

Throws:

java.io.IOException

saveInternal

protected abstract void saveInternal(ProjectData projectData,
                                     java.io.DataOutput out,
                                     org.jetbrains.coverage.gnu.trove.TObjectIntHashMap<java.lang.String> dict)
                              throws java.io.IOException

Throws:

java.io.IOException

save

public final void save(ProjectData projectData,
                       java.io.DataOutputStream out,
                       org.jetbrains.coverage.gnu.trove.TObjectIntHashMap<java.lang.String> dict)
                throws java.io.IOException

Save section data. Identifier, size and version are saved before the data.

Throws:

java.io.IOException