org.codehaus.mojo.findbugs.FindbugsViolationCheckMojo 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:/Users/garvin/NetBeansProjects/findbugs-maven-plugin/target/checkout/src/main/groovy/org/codehaus/mojo/findbugs/FindbugsViolationCheckMojo.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 java.math.BigDecimal;
import java.math.BigInteger;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.project.MavenProject;
import org.codehaus.gmaven.mojo.GroovyMojo;
import org.codehaus.plexus.resource.ResourceManager;
import org.codehaus.plexus.util.FileUtils;
/**
* Fail the build if there were any FindBugs violations in the source code.
* An XML report is put out by default in the target directory with the errors.
* To see more documentation about FindBugs' options, please see the FindBugs
* Manual..
*
* @since 2.0
* @goal check
* @phase verify
* @execute goal="findbugs"
* @requiresDependencyResolution compile
* @requiresProject
* @threadSafe
* @author Garvin LeClaire
* @version $Id: FindbugsViolationCheckMojo.groovy gleclaire $
*/
public class FindbugsViolationCheckMojo
extends GroovyMojo
implements groovy.lang.GroovyObject
{
/**
* Location where generated html will be created.
*
* @parameter default-value="${project.reporting.outputDirectory}"
* @required
*/
private File outputDirectory = null;
public File getOutputDirectory() {
throw new InternalError("Stubbed method");
}
public void setOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Turn on and off xml output of the Findbugs report.
*
* @parameter expression="${findbugs.xmlOutput}" default-value="false"
* @since 1.0.0
*/
private boolean xmlOutput = false;
public boolean getXmlOutput() {
throw new InternalError("Stubbed method");
}
public boolean isXmlOutput() {
throw new InternalError("Stubbed method");
}
public void setXmlOutput(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Specifies the directory where the xml output will be generated.
*
* @parameter default-value="${project.build.directory}"
* @required
* @since 1.0.0
*/
private File xmlOutputDirectory = null;
public File getXmlOutputDirectory() {
throw new InternalError("Stubbed method");
}
public void setXmlOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* This has been deprecated and is on by default.
*
* @parameter default-value="true"
* @since 1.2.0
* @deprecated
*/
private boolean findbugsXmlOutput = false;
public boolean getFindbugsXmlOutput() {
throw new InternalError("Stubbed method");
}
public boolean isFindbugsXmlOutput() {
throw new InternalError("Stubbed method");
}
public void setFindbugsXmlOutput(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Specifies the directory where the findbugs native xml output will be generated.
*
* @parameter default-value="${project.build.directory}"
* @required
* @since 1.2.0
*/
private File findbugsXmlOutputDirectory = null;
public File getFindbugsXmlOutputDirectory() {
throw new InternalError("Stubbed method");
}
public void setFindbugsXmlOutputDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Doxia Site Renderer.
*
* @component
*/
private Renderer siteRenderer = null;
public Renderer getSiteRenderer() {
throw new InternalError("Stubbed method");
}
public void setSiteRenderer(Renderer value) {
throw new InternalError("Stubbed method");
}
/**
* Directory containing the class files for FindBugs to analyze.
*
* @parameter default-value="${project.build.outputDirectory}"
* @required
*/
private File classFilesDirectory = null;
public File getClassFilesDirectory() {
throw new InternalError("Stubbed method");
}
public void setClassFilesDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Directory containing the test class files for FindBugs to analyze.
*
* @parameter default-value="${project.build.testOutputDirectory}"
* @required
*/
private File testClassFilesDirectory = null;
public File getTestClassFilesDirectory() {
throw new InternalError("Stubbed method");
}
public void setTestClassFilesDirectory(File value) {
throw new InternalError("Stubbed method");
}
/**
* Location of the Xrefs to link to.
*
* @parameter default-value="${project.reporting.outputDirectory}/xref"
*/
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.
*
* @parameter default-value="${project.reporting.outputDirectory}/xref-test"
*/
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.
*
* @parameter expression="${project.compileSourceRoots}"
* @required
* @readonly
*/
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.
*
* @parameter expression="${project.testCompileSourceRoots}"
* @required
* @readonly
* @since 2.0
*/
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.
*
* @parameter expression="${findbugs.includeTests}" default-value="false"
* @since 2.0
*/
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");
}
/**
* List of artifacts this plugin depends on. Used for resolving the Findbugs coreplugin.
*
* @parameter expression="${plugin.artifacts}"
* @required
* @readonly
*/
private ArrayList pluginArtifacts = null;
public ArrayList getPluginArtifacts() {
throw new InternalError("Stubbed method");
}
public void setPluginArtifacts(ArrayList value) {
throw new InternalError("Stubbed method");
}
/**
* The local repository, needed to download the coreplugin jar.
*
* @parameter expression="${localRepository}"
* @required
* @readonly
*/
private ArtifactRepository localRepository = null;
public ArtifactRepository getLocalRepository() {
throw new InternalError("Stubbed method");
}
public void setLocalRepository(ArtifactRepository value) {
throw new InternalError("Stubbed method");
}
/**
* Remote repositories which will be searched for the coreplugin jar.
*
* @parameter expression="${project.remoteArtifactRepositories}"
* @required
* @readonly
*/
private List remoteArtifactRepositories = null;
public List getRemoteArtifactRepositories() {
throw new InternalError("Stubbed method");
}
public void setRemoteArtifactRepositories(List value) {
throw new InternalError("Stubbed method");
}
/**
* Maven Project
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project = null;
public MavenProject getProject() {
throw new InternalError("Stubbed method");
}
public void setProject(MavenProject value) {
throw new InternalError("Stubbed method");
}
/**
* Encoding used for xml files. Default value is UTF-8.
*
* @parameter default-value="UTF-8"
* @readonly
*/
private java.lang.String xmlEncoding = null;
public java.lang.String getXmlEncoding() {
throw new InternalError("Stubbed method");
}
public void setXmlEncoding(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The file encoding to use when reading the source files. If the property project.build.sourceEncoding
* is not set, the platform default encoding is used.
*
* @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
* @since 2.2
*/
private java.lang.String sourceEncoding = null;
public java.lang.String getSourceEncoding() {
throw new InternalError("Stubbed method");
}
public void setSourceEncoding(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The file encoding to use when creating the HTML reports. If the property project.reporting.outputEncoding
* is not set, the platform default encoding is used.
*
* @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
* @since 2.2
*/
private java.lang.String outputEncoding = null;
public java.lang.String getOutputEncoding() {
throw new InternalError("Stubbed method");
}
public void setOutputEncoding(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).
*
* @parameter default-value="Default"
*/
private java.lang.String threshold = null;
public java.lang.String getThreshold() {
throw new InternalError("Stubbed method");
}
public void setThreshold(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Artifact resolver, needed to download the coreplugin jar.
*
* @component role="org.apache.maven.artifact.resolver.ArtifactResolver"
* @required
* @readonly
*/
private ArtifactResolver artifactResolver = null;
public ArtifactResolver getArtifactResolver() {
throw new InternalError("Stubbed method");
}
public void setArtifactResolver(ArtifactResolver value) {
throw new InternalError("Stubbed method");
}
/**
*
* File name of the include filter. Only bugs in matching the filters are reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* @parameter
* @since 1.0-beta-1
*/
private java.lang.String includeFilterFile = null;
public java.lang.String getIncludeFilterFile() {
throw new InternalError("Stubbed method");
}
public void setIncludeFilterFile(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
*
* File name of the exclude filter. Bugs matching the filters are not reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* @parameter
* @since 1.0-beta-1
*/
private java.lang.String excludeFilterFile = null;
public java.lang.String getExcludeFilterFile() {
throw new InternalError("Stubbed method");
}
public void setExcludeFilterFile(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
*
* File names of the baseline files. Bugs found in the baseline files won't be reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* This is a comma-delimited list.
*
* @parameter
* @since 2.4.1
*/
private java.lang.String excludeBugsFile = null;
public java.lang.String getExcludeBugsFile() {
throw new InternalError("Stubbed method");
}
public void setExcludeBugsFile(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Effort of the bug finders. Valid values are Min, Default and Max.
*
* @parameter default-value="Default"
* @since 1.0-beta-1
*/
private java.lang.String effort = null;
public java.lang.String getEffort() {
throw new InternalError("Stubbed method");
}
public void setEffort(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* turn on Findbugs debugging
*
* @parameter expression="${findbugs.debug}" default-value="false"
*/
private Boolean debug = null;
public Boolean getDebug() {
throw new InternalError("Stubbed method");
}
public void setDebug(Boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false
* positives.
*
* @parameter expression="${findbugs.relaxed}" default-value="false"
* @since 1.1
*/
private Boolean relaxed = null;
public Boolean getRelaxed() {
throw new InternalError("Stubbed method");
}
public void setRelaxed(Boolean value) {
throw new InternalError("Stubbed method");
}
/**
* The visitor list to run. This is a comma-delimited list.
*
* @parameter
* @since 1.0-beta-1
*/
private java.lang.String visitors = null;
public java.lang.String getVisitors() {
throw new InternalError("Stubbed method");
}
public void setVisitors(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* The visitor list to omit. This is a comma-delimited list.
*
* @parameter
* @since 1.0-beta-1
*/
private java.lang.String omitVisitors = null;
public java.lang.String getOmitVisitors() {
throw new InternalError("Stubbed method");
}
public void setOmitVisitors(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
*
* The plugin list to include in the report. This is a comma-delimited list.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a plugin file.
*
*
* @parameter
* @since 1.0-beta-1
*/
private java.lang.String pluginList = null;
public java.lang.String getPluginList() {
throw new InternalError("Stubbed method");
}
public void setPluginList(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* Restrict analysis to the given comma-separated list of classes and packages.
*
* @parameter
* @since 1.1
*/
private java.lang.String onlyAnalyze = null;
public java.lang.String getOnlyAnalyze() {
throw new InternalError("Stubbed method");
}
public void setOnlyAnalyze(java.lang.String value) {
throw new InternalError("Stubbed method");
}
/**
* This option enables or disables scanning of nested jar and zip files found
* in the list of files and directories to be analyzed.
*
* @parameter expression="${findbugs.nested}" default-value="false"
* @since 2.3.2
*/
private Boolean nested = null;
public Boolean getNested() {
throw new InternalError("Stubbed method");
}
public void setNested(Boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Prints a trace of detectors run and classes analyzed to standard output.
* Useful for troubleshooting unexpected analysis failures.
*
* @parameter expression="${findbugs.trace}" default-value="false"
* @since 2.3.2
*/
private Boolean trace = null;
public Boolean getTrace() {
throw new InternalError("Stubbed method");
}
public void setTrace(Boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Skip entire check.
*
* @parameter expression="${findbugs.skip}" default-value="false"
* @since 1.1
*/
private boolean skip = false;
public boolean getSkip() {
throw new InternalError("Stubbed method");
}
public boolean isSkip() {
throw new InternalError("Stubbed method");
}
public void setSkip(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* @component
* @required
* @readonly
* @since 2.0
*/
private ResourceManager resourceManager = null;
public ResourceManager getResourceManager() {
throw new InternalError("Stubbed method");
}
public void setResourceManager(ResourceManager value) {
throw new InternalError("Stubbed method");
}
/**
* SiteTool.
*
* @since 2.1-SNAPSHOT
* @component role="org.apache.maven.doxia.tools.SiteTool"
* @required
* @readonly
*/
protected SiteTool siteTool = null;
/**
* Fail the build on an error.
*
* @parameter expression="${findbugs.failOnError}" default-value="true"
* @since 2.0
*/
private boolean failOnError = false;
public boolean getFailOnError() {
throw new InternalError("Stubbed method");
}
public boolean isFailOnError() {
throw new InternalError("Stubbed method");
}
public void setFailOnError(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Fork a VM for FindBugs analysis. This will allow you to set timeouts and heap size
*
* @parameter expression="${findbugs.fork}" default-value="true"
* @since 2.3.2
*/
private boolean fork = false;
public boolean getFork() {
throw new InternalError("Stubbed method");
}
public boolean isFork() {
throw new InternalError("Stubbed method");
}
public void setFork(boolean value) {
throw new InternalError("Stubbed method");
}
/**
* Maximum Java heap size in megabytes (default=512).
* This only works if the fork parameter is set true.
*
* @parameter default-value="512"
* @since 2.2
*/
private int maxHeap = 0;
public int getMaxHeap() {
throw new InternalError("Stubbed method");
}
public void setMaxHeap(int value) {
throw new InternalError("Stubbed method");
}
/**
* Specifies the amount of time, in milliseconds, that FindBugs may run before
* it is assumed to be hung and is terminated.
* The default is 600,000 milliseconds, which is ten minutes.
* This only works if the fork parameter is set true.
*
* @parameter default-value="600000"
* @since 2.2
*/
private int timeout = 0;
public int getTimeout() {
throw new InternalError("Stubbed method");
}
public void setTimeout(int value) {
throw new InternalError("Stubbed method");
}
/**
*
* the arguments to pass to the forked VM (ignored if fork is disabled).
*
*
* @parameter
* @since 2.4.1
*/
private java.lang.String jvmArgs = null;
public java.lang.String getJvmArgs() {
throw new InternalError("Stubbed method");
}
public void setJvmArgs(java.lang.String value) {
throw new InternalError("Stubbed method");
}
private int bugCount = 0;
public int getBugCount() {
throw new InternalError("Stubbed method");
}
public void setBugCount(int value) {
throw new InternalError("Stubbed method");
}
private int errorCount = 0;
public int getErrorCount() {
throw new InternalError("Stubbed method");
}
public void setErrorCount(int value) {
throw new InternalError("Stubbed method");
}
public void execute() {
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");
}
}