Package edu.umd.cs.findbugs

Class XDocsBugReporter

java.lang.Object

edu.umd.cs.findbugs.AbstractBugReporter

edu.umd.cs.findbugs.TextUIBugReporter

edu.umd.cs.findbugs.XDocsBugReporter

All Implemented Interfaces:

RepositoryLookupFailureCallback, BugReporter, IClassObserver, IErrorLogger

public class XDocsBugReporter
extends TextUIBugReporter

BugReporter to output warnings in xdocs format for Maven.

Author:

Garvin LeClaire

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
XDocsBugReporter(Project project)

Method Summary

Modifier and Type	Method	Description
void	doReportBug(BugInstance bugInstance)	Subclasses must override this.
void	finish()	Finish reporting bugs.
BugCollection	getBugCollection()	Get the bug collection (if any) associated with this bug reporter
void	logError(String message)	Log an error that occurs while performing analysis.
void	observeClass(ClassDescriptor classDescriptor)	Observe a class being visited.
protected void	printBug(BugInstance bugInstance)	Print bug in one-line format.
void	reportMissingClass(ClassNotFoundException ex)	Called to report a class lookup failure.
void	toElement(BugInstance bugInstance)

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

XDocsBugReporter

public XDocsBugReporter(Project project)

Method Details

observeClass

public void observeClass(ClassDescriptor classDescriptor)

Description copied from interface: IClassObserver

Observe a class being visited.

Parameters:

classDescriptor - class being visited

logError

public void logError(String message)

Description copied from interface: IErrorLogger

Log an error that occurs while performing analysis.

Specified by:

logError in interface IErrorLogger

Overrides:

logError in class AbstractBugReporter

Parameters:

message - the error message

reportMissingClass

public void reportMissingClass(ClassNotFoundException ex)

Description copied from interface: IErrorLogger

Called to report a class lookup failure.

Specified by:

reportMissingClass in interface IErrorLogger

Overrides:

reportMissingClass in class AbstractBugReporter

Parameters:

ex - a ClassNotFoundException resulting from the class lookup failure

doReportBug

public 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

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

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.

toElement

public void toElement(BugInstance bugInstance)

getBugCollection

@Nonnull
public BugCollection getBugCollection()

Description copied from interface: BugReporter

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