Package net.sourceforge.pmd.reporting

Class DeterministicOutputListenerWrapper

java.lang.Object

net.sourceforge.pmd.reporting.DeterministicOutputListenerWrapper

All Implemented Interfaces:

AutoCloseable, GlobalAnalysisListener

public class DeterministicOutputListenerWrapper
extends Object
implements GlobalAnalysisListener

A listener that mediates access to another listener to order events in a predetermined, stable way. When running PMD with multiple threads, file listeners may be called in any order. This makes runs non-deterministic, as Renderers can output reports in the particular order files were processed, which varies between runs. This class will reorder the events by buffering them, to call the methods of the underlying GlobalAnalysisListener in a deterministic order.

Any renderer whose output may depend on ordering of files should be shielded by an instance of this wrapper. Note that each wrapper maintains its own buffer so it should be

Since:

7.12.0

Nested Class Summary

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

GlobalAnalysisListener.ViolationCounterListener

Constructor Summary

Constructors

Constructor	Description
DeterministicOutputListenerWrapper(GlobalAnalysisListener listener)

Method Summary

Modifier and Type	Method	Description
void	close()	Notify the implementation that the analysis ended, ie all files have been processed.
ListenerInitializer	initializer()	Provides an initializer to gather analysis context before events start occurring.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeterministicOutputListenerWrapper

public DeterministicOutputListenerWrapper(GlobalAnalysisListener listener)

Method Detail

initializer

public ListenerInitializer initializer()

Description copied from interface: GlobalAnalysisListener

Provides an initializer to gather analysis context before events start occurring.

Specified by:

initializer in interface GlobalAnalysisListener

Returns:

A listener initializer.

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

close

public void close()
           throws Exception

Description copied from interface: GlobalAnalysisListener

Notify the implementation that the analysis ended, ie all files have been processed. This listener won't be used after this is called.

Closing listeners multiple times should have no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface GlobalAnalysisListener

Throws:

Exception - If an error occurs. For example, renderer listeners may throw IOException

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

toString

public String toString()

Overrides:

toString in class Object