Package org.sonar.plugins.python

Class Scanner

java.lang.Object

org.sonar.plugins.python.Scanner

Direct Known Subclasses:

PythonScanner

public abstract class Scanner
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.sonar.api.batch.sensor.SensorContext	context

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Scanner(org.sonar.api.batch.sensor.SensorContext context)

Method Summary

Modifier and Type	Method	Description
boolean	canBeScannedWithoutParsing(PythonInputFile inputFile)
protected void	endOfAnalysis()
void	execute(List<PythonInputFile> files, org.sonar.api.batch.sensor.SensorContext context)
protected Stream<PythonInputFile>	getFilesStream(List<PythonInputFile> files)
protected abstract String	name()
protected abstract void	processException(Exception e, PythonInputFile file)
protected void	processFiles(List<PythonInputFile> files, org.sonar.api.batch.sensor.SensorContext context, MultiFileProgressReport progressReport, AtomicInteger numScannedWithoutParsing)
protected void	reportStatistics(int numSkippedFiles, int numTotalFiles)
protected abstract void	scanFile(PythonInputFile file)
protected boolean	scanFileWithoutParsing(PythonInputFile file)

Methods inherited from class java.lang.Object

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

Field Details

context

protected final org.sonar.api.batch.sensor.SensorContext context

Constructor Details

Scanner

protected Scanner(org.sonar.api.batch.sensor.SensorContext context)

Method Details

execute

public void execute(List<PythonInputFile> files,
 org.sonar.api.batch.sensor.SensorContext context)

processFiles

protected void processFiles(List<PythonInputFile> files,
 org.sonar.api.batch.sensor.SensorContext context,
 MultiFileProgressReport progressReport,
 AtomicInteger numScannedWithoutParsing)

getFilesStream

protected Stream<PythonInputFile> getFilesStream(List<PythonInputFile> files)

name

protected abstract String name()

scanFile

protected abstract void scanFile(PythonInputFile file)
                          throws IOException

Throws:

IOException

scanFileWithoutParsing

protected boolean scanFileWithoutParsing(PythonInputFile file)
                                  throws IOException

Throws:

IOException

endOfAnalysis

protected void endOfAnalysis()

processException

protected abstract void processException(Exception e,
 PythonInputFile file)

reportStatistics

protected void reportStatistics(int numSkippedFiles,
 int numTotalFiles)

canBeScannedWithoutParsing

public boolean canBeScannedWithoutParsing(PythonInputFile inputFile)