Package com.intellij.codeInspection.ex

Class PlainTextFormatter

java.lang.Object

com.intellij.codeInspection.ex.PlainTextFormatter

All Implemented Interfaces:

InspectionsReportConverter

public class PlainTextFormatter
extends java.lang.Object
implements InspectionsReportConverter

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.codeInspection.InspectionsReportConverter

InspectionsReportConverter.ConversionException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.intellij.codeInspection.InspectionsReportConverter

EP_NAME

Constructor Summary

Constructors

Constructor and Description
PlainTextFormatter()

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()
protected java.lang.String	getPath(Element fileElement)
protected java.lang.String	getToolPresentableName(InspectionToolWrapper toolWrapper)
boolean	useTmpDirForRawData()
protected void	writeInspectionDescription(java.io.Writer w, InspectionToolWrapper toolWrapper, javax.xml.transform.Transformer transformer)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

PlainTextFormatter

public PlainTextFormatter()

Method Detail

getFormatName

public java.lang.String getFormatName()

Specified by:

getFormatName in interface InspectionsReportConverter

Returns:

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

useTmpDirForRawData

public boolean useTmpDirForRawData()

Specified by:

useTmpDirForRawData in interface InspectionsReportConverter

Returns:

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

convert

public 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

Specified by:

convert in interface InspectionsReportConverter

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

getPath

protected java.lang.String getPath(Element fileElement)

writeInspectionDescription

protected void writeInspectionDescription(java.io.Writer w,
                                          InspectionToolWrapper toolWrapper,
                                          javax.xml.transform.Transformer transformer)
                                   throws java.io.IOException,
                                          InspectionsReportConverter.ConversionException

Throws:

java.io.IOException

InspectionsReportConverter.ConversionException

getToolPresentableName

protected java.lang.String getToolPresentableName(InspectionToolWrapper toolWrapper)
                                           throws java.io.IOException

Throws:

java.io.IOException