Package com.intellij.codeInspection

Interface InspectionsReportConverter

All Known Implementing Classes:

JsonInspectionsReportConverter, JsonSingleFileInspectionsReportConverter, PlainTextFormatter, XSLTReportConverter

public interface InspectionsReportConverter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InspectionsReportConverter.ConversionException

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<InspectionsReportConverter>	EP_NAME

Method Summary

Modifier and Type	Method and Description
void	convert(java.lang.String rawDataDirectoryPath, java.lang.String outputPath, java.util.Map<java.lang.String,Tools> tools, java.util.List<? extends java.io.File> inspectionsResults)
java.lang.String	getFormatName()
boolean	useTmpDirForRawData()

Field Detail

EP_NAME

static final ExtensionPointName<InspectionsReportConverter> EP_NAME

Method Detail

getFormatName

java.lang.String getFormatName()

Returns:

Format name which will be specified by user using --format option

useTmpDirForRawData

boolean useTmpDirForRawData()

Returns:

Try if original xml base report isn't required to user and should be stored in tmp directory.

convert

void convert(java.lang.String rawDataDirectoryPath,
             java.lang.String outputPath,
             java.util.Map<java.lang.String,Tools> tools,
             java.util.List<? extends java.io.File> inspectionsResults)
      throws InspectionsReportConverter.ConversionException

Parameters:

rawDataDirectoryPath - Original XML report folder

outputPath - New report output path provided by user. If null use STDOUT.

tools - Inspections data

inspectionsResults - Files with inspection results

Throws:

InspectionsReportConverter.ConversionException