Package edu.umd.cs.findbugs

Class EmacsBugReporter

java.lang.Object

edu.umd.cs.findbugs.AbstractBugReporter

edu.umd.cs.findbugs.TextUIBugReporter

edu.umd.cs.findbugs.EmacsBugReporter

All Implemented Interfaces:

RepositoryLookupFailureCallback, BugReporter, IClassObserver, IErrorLogger

public class EmacsBugReporter
extends TextUIBugReporter

BugReporter to output warnings in Emacs format.

Author:

David Li

Nested Class Summary

Nested classes/interfaces inherited from class edu.umd.cs.findbugs.AbstractBugReporter

AbstractBugReporter.Error

Field Summary

Fields inherited from class edu.umd.cs.findbugs.TextUIBugReporter

outputStream

Fields inherited from interface edu.umd.cs.findbugs.BugReporter

NORMAL, SILENT

Constructor Summary

Constructors

Constructor	Description
EmacsBugReporter()

Method Summary

Modifier and Type	Method	Description
protected void	doReportBug(BugInstance bugInstance)	Subclasses must override this.
void	finish()	Finish reporting bugs.
BugReporter	getRealBugReporter()	Get the real bug reporter at the end of a chain of delegating bug reporters.
void	observeClass(ClassDescriptor classDescriptor)	Observe a class being visited.
protected void	printBug(BugInstance bugInstance)	Print bug in one-line format.

Methods inherited from class edu.umd.cs.findbugs.TextUIBugReporter

checkBugInstance, emitLine, getUseLongBugCodes, isApplySuppressions, reportAnalysisError, reportMissingClass, reportQueuedErrors, setApplySuppressions, setOutputStream, setReportHistory, setReportStackTrace, setReportUserDesignations, setShowRank, setUseLongBugCodes

Methods inherited from class edu.umd.cs.findbugs.AbstractBugReporter

addObserver, getMissingClasses, getMissingClassName, getProjectStats, getQueuedErrors, isValidMissingClassMessage, logError, logError, notifyObservers, reportBug, reportBugsFromXml, reportMissingClass, reportMissingClass, reportSkippedAnalysis, setErrorVerbosity, setPriorityThreshold, setRankThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

EmacsBugReporter

public EmacsBugReporter()

Method Detail

observeClass

public void observeClass(ClassDescriptor classDescriptor)

Description copied from interface: IClassObserver

Observe a class being visited.

Parameters:

classDescriptor - class being visited

printBug

protected void printBug(BugInstance bugInstance)

Description copied from class: TextUIBugReporter

Print bug in one-line format.

Overrides:

printBug in class TextUIBugReporter

Parameters:

bugInstance - the bug to print

doReportBug

protected void doReportBug(BugInstance bugInstance)

Description copied from class: AbstractBugReporter

Subclasses must override this. It will be called only for bugs which meet the priority threshold.

Specified by:

doReportBug in class AbstractBugReporter

Parameters:

bugInstance - the bug to report

finish

public void finish()

Description copied from interface: BugReporter

Finish reporting bugs. If any bug reports have been queued, calling this method will flush them.

getRealBugReporter

public BugReporter getRealBugReporter()

Description copied from interface: BugReporter

Get the real bug reporter at the end of a chain of delegating bug reporters. All non-delegating bug reporters should simply "return this".

Specified by:

getRealBugReporter in interface BugReporter

Overrides:

getRealBugReporter in class TextUIBugReporter

Returns:

the real bug reporter at the end of the chain, or this object if there is no delegation