Package net.sourceforge.pmd.cache

Class AnalysisCacheListener

java.lang.Object

net.sourceforge.pmd.cache.AnalysisCacheListener

All Implemented Interfaces:

AutoCloseable, GlobalAnalysisListener

@Deprecated
@InternalApi
public class AnalysisCacheListener
extends Object
implements GlobalAnalysisListener

Deprecated.

Adapter to wrap AnalysisCache behaviour in a GlobalAnalysisListener.

Nested Class Summary

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

GlobalAnalysisListener.ViolationCounterListener

Constructor Summary

Constructors

Constructor	Description
AnalysisCacheListener(AnalysisCache cache, RuleSets ruleSets, ClassLoader classLoader)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated. Notify the implementation that the analysis ended, ie all files have been processed.
FileAnalysisListener	startFileAnalysis(TextFile file)	Deprecated. Returns a file listener that will handle events occurring during the analysis of the given file.

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

initializer, onConfigError

Constructor Detail

AnalysisCacheListener

public AnalysisCacheListener(AnalysisCache cache,
                             RuleSets ruleSets,
                             ClassLoader classLoader)

Deprecated.

Method Detail

startFileAnalysis

public FileAnalysisListener startFileAnalysis(TextFile file)

Deprecated.

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 IOException

Deprecated.

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:

IOException