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, ConfigurableBugReporter

public class EmacsBugReporter
extends TextUIBugReporter

BugReporter to output warnings in Emacs format.

Nested Class Summary

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

AbstractBugReporter.Error

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.HashSet<BugInstance>	seenAlready
private java.util.HashMap<java.lang.String,java.lang.String>	sourceFileNameCache

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

OTHER_CATEGORY_ABBREV, 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.
private java.lang.String	fileNameFor(java.lang.String packageName, java.lang.String sourceName)
void	finish()	Finish reporting bugs.
@Nullable BugCollection	getBugCollection()	Get the bug collection (if any) associated with this bug reporter
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, getOutputTarget, getRealBugReporter, getUseLongBugCodes, isApplySuppressions, isDuplicateOf, reportAnalysisError, reportMissingClass, reportQueuedErrors, setApplySuppressions, setOutputStream, setOutputTarget, setReportHistory, setReportStackTrace, setShowRank, setUseLongBugCodes, setWriter

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

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

Methods inherited from class java.lang.Object

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

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

addObserver, getPriorityAdjuster, getProjectStats, reportBug, setErrorVerbosity, setPriorityAdjuster, setPriorityThreshold

Methods inherited from interface edu.umd.cs.findbugs.ConfigurableBugReporter

setRankThreshold

Methods inherited from interface edu.umd.cs.findbugs.classfile.IErrorLogger

logError, logError, reportMissingClass, reportMissingClass, reportMissingClass, reportSkippedAnalysis

Field Detail

seenAlready

private final java.util.HashSet<BugInstance> seenAlready

sourceFileNameCache

private final java.util.HashMap<java.lang.String,java.lang.String> sourceFileNameCache

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

fileNameFor

private java.lang.String fileNameFor(java.lang.String packageName,
                                     java.lang.String sourceName)

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.

getBugCollection

public @Nullable BugCollection getBugCollection()

Description copied from interface: BugReporter

Get the bug collection (if any) associated with this bug reporter