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
,ConfigurableBugReporter
BugReporter to output warnings in xdocs format for Maven.
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.umd.cs.findbugs.AbstractBugReporter
AbstractBugReporter.Error
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private final SortedBugCollection
private final org.dom4j.Document
private static final String
private static final String
private static final String
private static final String
private final Project
private final org.dom4j.Element
private static final String
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
doReportBug
(BugInstance bugInstance) Subclasses must override this.private org.dom4j.Document
endDocument
(Project project) void
finish()
Finish reporting bugs.Get the bug collection (if any) associated with this bug reportervoid
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
(ClassDescriptor classDescriptor) Called to report a class lookup failure.void
Called to report a class lookup failure.void
toElement
(BugInstance bugInstance) private void
private static String
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, getProjectStats, getQueuedErrors, isRelaxed, isValidMissingClassMessage, logError, notifyObservers, reportBug, reportBugsFromXml, reportSkippedAnalysis, setErrorVerbosity, setIsRelaxed, 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, getProjectStats, reportBug, setErrorVerbosity, setPriorityThreshold
Methods inherited from interface edu.umd.cs.findbugs.ConfigurableBugReporter
setRankThreshold
Methods inherited from interface edu.umd.cs.findbugs.classfile.IErrorLogger
logError, reportSkippedAnalysis
-
Field Details
-
bugCollection
-
project
-
document
private final org.dom4j.Document document -
root
private final org.dom4j.Element root -
ROOT_ELEMENT_NAME
- See Also:
-
ERRORS_ELEMENT_NAME
- See Also:
-
ANALYSIS_ERROR_ELEMENT_NAME
- See Also:
-
MISSING_CLASS_ELEMENT_NAME
- See Also:
-
ELEMENT_NAME
- See Also:
-
FILE_ELEMENT_NAME
- See Also:
-
-
Constructor Details
-
XDocsBugReporter
-
-
Method Details
-
observeClass
Description copied from interface:IClassObserver
Observe a class being visited.- Parameters:
classDescriptor
- class being visited
-
logError
Description copied from interface:IErrorLogger
Log an error that occurs while performing analysis.- Specified by:
logError
in interfaceIErrorLogger
- Overrides:
logError
in classAbstractBugReporter
- Parameters:
message
- the error message
-
reportMissingClass
Description copied from interface:IErrorLogger
Called to report a class lookup failure.- Specified by:
reportMissingClass
in interfaceIErrorLogger
- Overrides:
reportMissingClass
in classAbstractBugReporter
- Parameters:
ex
- a ClassNotFoundException resulting from the class lookup failure
-
reportMissingClass
Description copied from interface:IErrorLogger
Called to report a class lookup failure.- Specified by:
reportMissingClass
in interfaceIErrorLogger
- Overrides:
reportMissingClass
in classAbstractBugReporter
- Parameters:
classDescriptor
- ClassDescriptor of a missing class
-
doReportBug
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 classAbstractBugReporter
- Parameters:
bugInstance
- the bug to report
-
printBug
Description copied from class:TextUIBugReporter
Print bug in one-line format.- Overrides:
printBug
in classTextUIBugReporter
- 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. -
writeXML
- Throws:
IOException
-
endDocument
-
xmlEscape
-
toElement
-
getBugCollection
Description copied from interface:BugReporter
Get the bug collection (if any) associated with this bug reporter
-