Package net.sourceforge.pmd.reporting

Class CloseHookFileListener<T extends FileAnalysisListener>

java.lang.Object

net.sourceforge.pmd.reporting.CloseHookFileListener<T>

Type Parameters:

T - Type of the delegate

All Implemented Interfaces:

AutoCloseable, FileAnalysisListener

public abstract class CloseHookFileListener<T extends FileAnalysisListener>
extends Object
implements FileAnalysisListener

A delegating listener wrapper that can override the closing behavior.

Since:

7.12.0

Constructor Summary

Constructors

Constructor	Description
CloseHookFileListener(T delegate)

Method Summary

Modifier and Type	Method	Description
void	close()	Signals the end of the analysis: no further calls will be made to this listener.
protected abstract void	doClose(T delegate, @Nullable Exception e)	Perform a close action.
void	onError(Report.ProcessingError error)	Handle an error that occurred while processing a file.
void	onRuleViolation(RuleViolation violation)	Handle a new violation (not suppressed).
void	onSuppressedRuleViolation(Report.SuppressedViolation violation)	Handle a new suppressed violation.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseHookFileListener

public CloseHookFileListener(T delegate)

Method Detail

onRuleViolation

public void onRuleViolation(RuleViolation violation)

Description copied from interface: FileAnalysisListener

Handle a new violation (not suppressed).

Specified by:

onRuleViolation in interface FileAnalysisListener

onSuppressedRuleViolation

public void onSuppressedRuleViolation(Report.SuppressedViolation violation)

Description copied from interface: FileAnalysisListener

Handle a new suppressed violation.

Specified by:

onSuppressedRuleViolation in interface FileAnalysisListener

onError

public void onError(Report.ProcessingError error)

Description copied from interface: FileAnalysisListener

Handle an error that occurred while processing a file.

Specified by:

onError in interface FileAnalysisListener

close

public final void close()
                 throws Exception

Description copied from interface: FileAnalysisListener

Signals the end of the analysis: no further calls will be made to this listener. This is run in the thread the listener has been used in. This means, if this routine merges some state into some global state of the GlobalAnalysisListener, then that must be synchronized.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FileAnalysisListener

Throws:

Exception - If an exception occurs, e.g. IOException when writing to a renderer

toString

public String toString()

Overrides:

toString in class Object

doClose

protected abstract void doClose(T delegate,
                                @Nullable Exception e)
                         throws Exception

Perform a close action. The delegate is given as a parameter, it has already been closed.

Parameters:

delegate - The delegate

e - Exception thrown by the delegate when it was closed, or null if it did not throw. The implementation can choose to rethrow that exception or suppress it.

Throws:

Exception