Package net.sourceforge.pmd.reporting

Class Report.GlobalReportBuilderListener

java.lang.Object

net.sourceforge.pmd.util.BaseResultProducingCloseable<Report>

net.sourceforge.pmd.reporting.Report.GlobalReportBuilderListener

All Implemented Interfaces:

AutoCloseable, GlobalAnalysisListener

Enclosing class:

Report

public static final class Report.GlobalReportBuilderListener
extends BaseResultProducingCloseable<Report>
implements GlobalAnalysisListener

A GlobalAnalysisListener that accumulates the events of all files into a Report.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.reporting.GlobalAnalysisListener

GlobalAnalysisListener.ViolationCounterListener

Constructor Summary

Constructors

Constructor	Description
GlobalReportBuilderListener()

Method Summary

Modifier and Type	Method	Description
Report	getResultImpl()	Produce the final result.
void	onConfigError(Report.ConfigurationError error)	Record a configuration error.
FileAnalysisListener	startFileAnalysis(TextFile file)	Returns a file listener that will handle events occurring during the analysis of the given file.

Methods inherited from class net.sourceforge.pmd.util.BaseResultProducingCloseable

close, closeImpl, ensureOpen, getResult, using

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.reporting.GlobalAnalysisListener

close, initializer

Constructor Details

GlobalReportBuilderListener

public GlobalReportBuilderListener()

Method Details

startFileAnalysis

public FileAnalysisListener startFileAnalysis(TextFile file)

Description copied from interface: GlobalAnalysisListener

Returns a file listener that will handle events occurring during the analysis of the given file. The new listener may receive events as soon as this method returns. The analysis stops when the FileAnalysisListener.close() method is called.

Specified by:

startFileAnalysis in interface GlobalAnalysisListener

Parameters:

file - File to be processed

Returns:

A new listener

onConfigError

public void onConfigError(Report.ConfigurationError error)

Description copied from interface: GlobalAnalysisListener

Record a configuration error. This happens before the start of file analysis.

Specified by:

onConfigError in interface GlobalAnalysisListener

getResultImpl

public Report getResultImpl()

Description copied from class: BaseResultProducingCloseable

Produce the final result.

Specified by:

getResultImpl in class BaseResultProducingCloseable<Report>