org.codehaus.mojo.findbugs.Reporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of findbugs-maven-plugin Show documentation
Show all versions of findbugs-maven-plugin Show documentation
This Plug-In generates reports based on the FindBugs Library
//
// Generated stub from file:/C:/svnWork/findbugs-maven-plugin/target/checkout/src/main/groovy/org/codehaus/mojo/findbugs/Reporter.groovy
//
package org.codehaus.mojo.findbugs;
import java.lang.*;
import java.io.*;
import java.net.*;
import java.util.*;
import groovy.lang.*;
import groovy.util.*;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.PathTool;
import edu.umd.cs.findbugs.AnalysisError;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugPattern;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.SortedBugCollection;
import edu.umd.cs.findbugs.SourceLineAnnotation;
import edu.umd.cs.findbugs.TextUIBugReporter;
import edu.umd.cs.findbugs.classfile.ClassDescriptor;
/**
* The reporter controls the generation of the FindBugs report. It contains call back methods which gets called by
* FindBugs if a bug is found.
*
* @author Garvin LeClaire
* @version $Id: Reporter.groovy 8594 2009-01-10 05:26:53Z gleclaire $
*/
public class Reporter
extends TextUIBugReporter
{
/**
* The key to get the value if the line number is not available.
*/
static final private java.lang.String NOLINE_KEY = null;
static final public java.lang.String getNOLINE_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the line.
*/
static final private java.lang.String COLUMN_LINE_KEY = null;
static final public java.lang.String getCOLUMN_LINE_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the bug.
*/
static final private java.lang.String COLUMN_BUG_KEY = null;
static final public java.lang.String getCOLUMN_BUG_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the bugs.
*/
static final private java.lang.String COLUMN_BUGS_KEY = null;
static final public java.lang.String getCOLUMN_BUGS_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the category.
*/
static final private java.lang.String COLUMN_CATEGORY_KEY = null;
static final public java.lang.String getCOLUMN_CATEGORY_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the priority.
*/
static final private java.lang.String COLUMN_PRIORITY_KEY = null;
static final public java.lang.String getCOLUMN_PRIORITY_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the column title for the details.
*/
static final private java.lang.String COLUMN_DETAILS_KEY = null;
static final public java.lang.String getCOLUMN_DETAILS_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the report title of the Plug-In from the bundle.
*/
static final private java.lang.String REPORT_TITLE_KEY = null;
static final public java.lang.String getREPORT_TITLE_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the report link title of the Plug-In from the bundle.
*/
static final private java.lang.String LINKTITLE_KEY = null;
static final public java.lang.String getLINKTITLE_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the report link of the Plug-In from the bundle.
*/
static final private java.lang.String LINK_KEY = null;
static final public java.lang.String getLINK_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the name of the Plug-In from the bundle.
*/
static final private java.lang.String NAME_KEY = null;
static final public java.lang.String getNAME_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the files title of the Plug-In from the bundle.
*/
static final private java.lang.String FILES_KEY = null;
static final public java.lang.String getFILES_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the threshold of the report from the bundle.
*/
static final private java.lang.String THRESHOLD_KEY = null;
static final public java.lang.String getTHRESHOLD_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The character to separate URL tokens.
*/
static final private java.lang.String URL_SEPARATOR = null;
static final public java.lang.String getURL_SEPARATOR() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the effort of the report from the bundle.
*/
static final private java.lang.String EFFORT_KEY = null;
static final public java.lang.String getEFFORT_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the link to FindBugs description page from the bundle.
*/
static final private java.lang.String DETAILSLINK_KEY = null;
static final public java.lang.String getDETAILSLINK_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the version title for FindBugs from the bundle.
*/
static final private java.lang.String VERSIONTITLE_KEY = null;
static final public java.lang.String getVERSIONTITLE_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to get the files title of the Plug-In from the bundle.
*/
static final private java.lang.String SUMMARY_KEY = null;
static final public java.lang.String getSUMMARY_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to column title for the Class.
*/
static final private java.lang.String COLUMN_CLASS_KEY = null;
static final public java.lang.String getCOLUMN_CLASS_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to column title for the Classes.
*/
static final private java.lang.String COLUMN_CLASSES_KEY = null;
static final public java.lang.String getCOLUMN_CLASSES_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to column title for the errors.
*/
static final private java.lang.String COLUMN_ERRORS_KEY = null;
static final public java.lang.String getCOLUMN_ERRORS_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to column title for the files.
*/
static final private java.lang.String COLUMN_FILES_KEY = null;
static final public java.lang.String getCOLUMN_FILES_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The key to column title for the files.
*/
static final private java.lang.String COLUMN_MISSINGCLASSES_KEY = null;
static final public java.lang.String getCOLUMN_MISSINGCLASSES_KEY() {
throw new InternalError("Stubbed method");
}
/**
* The sink to write the report to.
*/
private Sink sink = null;
public Sink getSink() {
throw new InternalError("Stubbed method");
}
public void setSink(Sink value) {
throw new InternalError("Stubbed method");
}
/**
* The bundle to get the messages from.
*/
private ResourceBundle bundle = null;
public ResourceBundle getBundle() {
throw new InternalError("Stubbed method");
}
public void setBundle(ResourceBundle value) {
throw new InternalError("Stubbed method");
}
/**
* The logger to write logs to.
*/
private Log mavenLog = null;
public Log getMavenLog() {
throw new InternalError("Stubbed method");
}
public void setMavenLog(Log value) {
throw new InternalError("Stubbed method");
}
/**
* The threshold of bugs severity.
*/
private ThresholdParameter threshold = null;
public ThresholdParameter getThreshold() {
throw new InternalError("Stubbed method");
}
public void setThreshold(ThresholdParameter value) {
throw new InternalError("Stubbed method");
}
/**
* The used effort for searching bugs.
*/
private EffortParameter effort = null;
public EffortParameter getEffort() {
throw new InternalError("Stubbed method");
}
public void setEffort(EffortParameter value) {
throw new InternalError("Stubbed method");
}
/**
* The name of the current class which is analysed by FindBugs.
*/
private java.lang.String currentClassName = null;
public java.lang.String getCurrentClassName() {
throw new InternalError("Stubbed method");
}
public void setCurrentClassName(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Signals if the report for the current class is opened.
*/
private boolean mIsCurrentClassReportOpened = false;
public boolean getMIsCurrentClassReportOpened() {
throw new InternalError("Stubbed method");
}
public boolean isMIsCurrentClassReportOpened() {
throw new InternalError("Stubbed method");
}
public void setMIsCurrentClassReportOpened(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Signals if the jxr report plugin is enabled.
*/
private boolean isJXRReportEnabled = false;
public boolean getIsJXRReportEnabled() {
throw new InternalError("Stubbed method");
}
public boolean isIsJXRReportEnabled() {
throw new InternalError("Stubbed method");
}
public void setIsJXRReportEnabled(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* The Collection of Bugs and Error collected during analysis.
*/
private SortedBugCollection bugCollection = null;
public SortedBugCollection getBugCollection() {
throw new InternalError("Stubbed method");
}
public void setBugCollection(SortedBugCollection value) {
throw new InternalError("Stubbed method");
}
/**
* The running total of bugs reported.
*/
private int bugCount = 0;
public int getBugCount() {
throw new InternalError("Stubbed method");
}
public void setBugCount(int value) {
throw new InternalError("Stubbed method");
}
/**
* The running total of missing classes reported.
*/
private int missingClassCount = 0;
public int getMissingClassCount() {
throw new InternalError("Stubbed method");
}
public void setMissingClassCount(int value) {
throw new InternalError("Stubbed method");
}
/**
* The running total of files analyzed.
*/
private int fileCount = 0;
public int getFileCount() {
throw new InternalError("Stubbed method");
}
public void setFileCount(int value) {
throw new InternalError("Stubbed method");
}
/**
* The Set of missing classes names reported.
*/
private Set missingClassSet = null;
public Set getMissingClassSet() {
throw new InternalError("Stubbed method");
}
public void setMissingClassSet(Set value) {
throw new InternalError("Stubbed method");
}
/**
* The running total of errors reported.
*/
private int errorCount = 0;
public int getErrorCount() {
throw new InternalError("Stubbed method");
}
public void setErrorCount(int value) {
throw new InternalError("Stubbed method");
}
/**
* Location where generated html will be created.
*/
private File outputDirectory = null;
public File getOutputDirectory() {
throw new InternalError("Stubbed method");
}
public void setOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Location of the Xrefs to link to.
*/
private File xrefLocation = null;
public File getXrefLocation() {
throw new InternalError("Stubbed method");
}
public void setXrefLocation(File value) {
throw new InternalError("Stubbed method");
}
/**
* Location of the Test Xrefs to link to.
*/
private File xrefTestLocation = null;
public File getXrefTestLocation() {
throw new InternalError("Stubbed method");
}
public void setXrefTestLocation(File value) {
throw new InternalError("Stubbed method");
}
/**
* The directories containing the sources to be compiled.
*/
private List compileSourceRoots = null;
public List getCompileSourceRoots() {
throw new InternalError("Stubbed method");
}
public void setCompileSourceRoots(List value) {
throw new InternalError("Stubbed method");
}
/**
* The directories containing the test-sources to be compiled.
*/
private List testSourceRoots = null;
public List getTestSourceRoots() {
throw new InternalError("Stubbed method");
}
public void setTestSourceRoots(List value) {
throw new InternalError("Stubbed method");
}
/**
* Run Findbugs on the tests.
*/
private boolean includeTests = false;
public boolean getIncludeTests() {
throw new InternalError("Stubbed method");
}
public boolean isIncludeTests() {
throw new InternalError("Stubbed method");
}
public void setIncludeTests(boolean value) {
throw new InternalError("Stubbed method");
}
private Reporter(java.lang.Void void1, java.lang.Void void2, java.lang.Void void3) {
throw new InternalError("Stubbed method");
}
/**
* Default constructor.
*
* @param sink
The sink to generate the report.
* @param bundle
The resource bundle to get the messages from.
* @param log
The logger.
* @param threshold
The threshold for the report.
* @param isJXRReportEnabled
Is the jxr report plugin enabled.
* @param effort
The used effort.
*/
public Reporter(Sink sink, ResourceBundle bundle, Log log, ThresholdParameter threshold, boolean isJXRReportEnabled, EffortParameter effort) {
this((java.lang.Void)null, (java.lang.Void)null, (java.lang.Void)null);
throw new InternalError("Stubbed method");
}
/**
* Hide default constructor.
*/
private Reporter() {
this((java.lang.Void)null, (java.lang.Void)null, (java.lang.Void)null);
throw new InternalError("Stubbed method");
}
/**
* @see edu.umd.cs.findbugs.BugReporter#finish()
*/
public void finish() {
throw new InternalError("Stubbed method");
}
/**
* Get the real bug reporter at the end of a chain of delegating bug reporters. All non-delegating bug reporters
* should simply "return this".
*
* @return the real bug reporter at the end of the chain, or this object if there is no delegation
* @see edu.umd.cs.findbugs.BugReporter#getRealBugReporter()
*/
public BugReporter getRealBugReporter() {
throw new InternalError("Stubbed method");
}
/**
* Observe a class.
*
* @param clazz
the class
* @see edu.umd.cs.findbugs.classfile.IClassObserver #observeClass(edu.umd.cs.findbugs.classfile.ClassDescriptor)
*/
public void observeClass(ClassDescriptor clazz) {
throw new InternalError("Stubbed method");
}
/**
* Report a queued error.
*
* @param analysisError
the queued error
* @see edu.umd.cs.findbugs.AbstractBugReporter #reportAnalysisError(edu.umd.cs.findbugs.AnalysisError)
*/
public void reportAnalysisError(AnalysisError analysisError) {
throw new InternalError("Stubbed method");
}
public void logError(java.lang.String message) {
throw new InternalError("Stubbed method");
}
public void logError(java.lang.String message, Throwable e) {
throw new InternalError("Stubbed method");
}
/**
* Report a missing class.
*
* @param missingClass
the name of the class
* @see edu.umd.cs.findbugs.AbstractBugReporter #reportMissingClass(java.lang.String)
*/
public void reportMissingClass(java.lang.String missingClass) {
throw new InternalError("Stubbed method");
}
public void reportMissingClass(ClassNotFoundException ex) {
throw new InternalError("Stubbed method");
}
public void reportMissingClass(ClassDescriptor classDescriptor) {
throw new InternalError("Stubbed method");
}
/**
* Initialises the report.
*/
private void initialiseReport() {
throw new InternalError("Stubbed method");
}
/**
* Print the bug collection to a line in the table
*
* @param bugInstance
the bug to print
*/
protected void printBug(BugInstance bugInstance) {
throw new InternalError("Stubbed method");
}
/**
* Assembles the hyperlink to point to the source code.
*
* @param line
The line number object with the bug.
* @param lineNumber
The line number to show in the hyperlink.
* @return The hyperlink which points to the code.
*/
protected java.lang.String assembleJXRHyperlink(SourceLineAnnotation line, java.lang.String lineNumber) {
throw new InternalError("Stubbed method");
}
/**
* Closes the class report section.
*/
protected void closeClassReportSection() {
throw new InternalError("Stubbed method");
}
/**
* @param bugInstance
The bug to report
* @see edu.umd.cs.findbugs.AbstractBugReporter #doReportBug(edu.umd.cs.findbugs.BugInstance)
*/
protected void doReportBug(BugInstance bugInstance) {
throw new InternalError("Stubbed method");
}
/**
* Gets the report title.
*
* @return The report title.
*/
protected java.lang.String getReportTitle() {
throw new InternalError("Stubbed method");
}
/**
* Initialised a bug report section in the report for a particular class.
*/
protected void openClassReportSection() {
throw new InternalError("Stubbed method");
}
/**
* Return the value to display. If FindBugs does not provide a line number, a default message is returned. The line
* number otherwise.
*
* @param line
The line to get the value from.
* @return The line number the bug appears or a statement that there is no source line available.
*/
protected java.lang.String valueForLine(SourceLineAnnotation line) {
throw new InternalError("Stubbed method");
}
/**
* Print the Summary Section.
*/
protected void printSummary() {
throw new InternalError("Stubbed method");
}
/**
* Print the File Summary Section.
*/
protected void printFilesSummary() {
throw new InternalError("Stubbed method");
}
protected void printFilesSummaryLine(int classBugs) {
throw new InternalError("Stubbed method");
}
public groovy.lang.MetaClass getMetaClass() {
throw new InternalError("Stubbed method");
}
public void setMetaClass(groovy.lang.MetaClass metaClass) {
throw new InternalError("Stubbed method");
}
public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object args) {
throw new InternalError("Stubbed method");
}
public java.lang.Object getProperty(java.lang.String name) {
throw new InternalError("Stubbed method");
}
public void setProperty(java.lang.String name, java.lang.Object value) {
throw new InternalError("Stubbed method");
}
}