edu.umd.cs.findbugs
Class XDocsBugReporter

java.lang.Object
  extended by edu.umd.cs.findbugs.AbstractBugReporter
      extended by edu.umd.cs.findbugs.TextUIBugReporter
          extended by edu.umd.cs.findbugs.XDocsBugReporter
All Implemented Interfaces:
ClassObserver, RepositoryLookupFailureCallback, BugReporter

public class XDocsBugReporter
extends TextUIBugReporter

BugReporter to output warnings in xdocs format for Maven.

Author:
Garvin LeClaire

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
XDocsBugReporter(Project project)
           
 
Method Summary
 void doReportBug(BugInstance bugInstance)
          Subclasses must override this.
 void finish()
          Finish reporting bugs.
 void logError(java.lang.String message)
          Log an error that occurs while performing analysis.
 void observeClass(org.apache.bcel.classfile.JavaClass javaClass)
          Observe a class.
protected  void printBug(BugInstance bugInstance)
          Print bug in one-line format.
 void reportMissingClass(java.lang.ClassNotFoundException ex)
          Called to report a lookup failure.
 void toElement(BugInstance bugInstance)
           
 
Methods inherited from class edu.umd.cs.findbugs.TextUIBugReporter
checkBugInstance, emitLine, getRealBugReporter, getUseLongBugCodes, reportAnalysisError, reportMissingClass, reportQueuedErrors, setOutputStream, setReportStackTrace, setUseLongBugCodes
 
Methods inherited from class edu.umd.cs.findbugs.AbstractBugReporter
addObserver, getEngine, getMissingClassName, getProjectStats, logError, notifyObservers, reportBug, reportSkippedAnalysis, setEngine, setErrorVerbosity, setPriorityThreshold
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XDocsBugReporter

public XDocsBugReporter(Project project)
Method Detail

observeClass

public void observeClass(org.apache.bcel.classfile.JavaClass javaClass)
Description copied from interface: ClassObserver
Observe a class.

Parameters:
javaClass - the class

logError

public void logError(java.lang.String message)
Description copied from interface: RepositoryLookupFailureCallback
Log an error that occurs while performing analysis.

Specified by:
logError in interface RepositoryLookupFailureCallback
Overrides:
logError in class AbstractBugReporter
Parameters:
message - the error message

reportMissingClass

public void reportMissingClass(java.lang.ClassNotFoundException ex)
Description copied from interface: RepositoryLookupFailureCallback
Called to report a lookup failure.

Specified by:
reportMissingClass in interface RepositoryLookupFailureCallback
Overrides:
reportMissingClass in class AbstractBugReporter
Parameters:
ex - a ClassNotFoundException resulting from the 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

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)