org.codehaus.mojo.findbugs

Class AbstractFindbugsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.findbugs.AbstractFindbugsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

public abstract class AbstractFindbugsMojo
extends org.apache.maven.reporting.AbstractMavenReport

Created by garvin on 2/10/15.

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver Artifact resolver, needed to download the coreplugin jar.
File	classFilesDirectory Directory containing the class files for FindBugs to analyze.
List	compileSourceRoots The directories containing the sources to be compiled.
Boolean	debug turn on Findbugs debugging
String	effort Effort of the bug finders.
String	excludeBugsFile File names of the baseline files.
String	excludeFilterFile File name of the exclude filter.
org.apache.maven.artifact.factory.ArtifactFactory	factory Used to look up Artifacts in the remote repository.
boolean	failOnError Fail the build on an error.
boolean	findbugsXmlOutput Deprecated.
File	findbugsXmlOutputDirectory Specifies the directory where the findbugs native xml output will be generated.
boolean	fork Fork a VM for FindBugs analysis.
String	includeFilterFile File name of the include filter.
boolean	includeTests Run Findbugs on the tests.
String	jvmArgs the arguments to pass to the forked VM (ignored if fork is disabled).
org.apache.maven.artifact.repository.ArtifactRepository	localRepository The local repository, needed to download the coreplugin jar.
int	maxHeap Maximum Java heap size in megabytes (default=512).
int	maxRank Maximum bug ranking to record.
Boolean	nested This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.
String	omitVisitors The visitor list to omit.
String	onlyAnalyze Restrict analysis to the given comma-separated list of classes and packages.
File	outputDirectory Location where generated html will be created.
String	outputEncoding The file encoding to use when creating the HTML reports.
ArrayList	pluginArtifacts List of artifacts this plugin depends on.
String	pluginList The plugin list to include in the report.
PluginArtifact[]	plugins Collection of PluginArtifact to work on.
org.apache.maven.project.MavenProject	project Maven Project
Boolean	relaxed Relaxed reporting mode.
List	remoteArtifactRepositories Remote repositories which will be searched for the coreplugin jar.
List	remoteRepositories List of Remote Repositories used by the resolver
org.codehaus.plexus.resource.ResourceManager	resourceManager
org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer.
org.apache.maven.doxia.tools.SiteTool	siteTool SiteTool.
boolean	skip Skip entire check.
String	sourceEncoding The file encoding to use when reading the source files.
File	testClassFilesDirectory Directory containing the test class files for FindBugs to analyze.
List	testSourceRoots The directories containing the test-sources to be compiled.
String	threshold Threshold of minimum bug severity to report.
int	timeout Specifies the amount of time, in milliseconds, that FindBugs may run before it is assumed to be hung and is terminated.
Boolean	trace Prints a trace of detectors run and classes analyzed to standard output.
String	visitors The visitor list to run.
String	xmlEncoding Encoding used for xml files.
boolean	xmlOutput Turn on and off xml output of the Findbugs report.
File	xmlOutputDirectory Specifies the directory where the xml output will be generated.
File	xrefLocation Location of the Xrefs to link to.
File	xrefTestLocation Location of the Test Xrefs to link to.

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFindbugsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getOutputDirectory() Returns the report output directory.
protected org.apache.maven.project.MavenProject	getProject() Return the project.

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport, closeReport, execute, executeReport, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getDescription, getName, getOutputName

Field Detail

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}",
           required=true)
public File outputDirectory

Location where generated html will be created.

xmlOutput

@Parameter(defaultValue="false",
           property="findbugs.xmlOutput",
           required=true)
public boolean xmlOutput

Turn on and off xml output of the Findbugs report.

Since:

1.0.0

xmlOutputDirectory

@Parameter(defaultValue="${project.build.directory}",
           required=true)
public File xmlOutputDirectory

Specifies the directory where the xml output will be generated.

Since:

1.0.0

findbugsXmlOutput

@Deprecated
@Parameter(defaultValue="true")
public boolean findbugsXmlOutput

Deprecated.

This has been deprecated and is on by default.

Since:

1.2.0

findbugsXmlOutputDirectory

@Parameter(defaultValue="${project.build.directory}",
           required=true)
public File findbugsXmlOutputDirectory

Specifies the directory where the findbugs native xml output will be generated.

Since:

1.2.0

siteRenderer

@Component(role=org.apache.maven.doxia.siterenderer.Renderer.class)
public org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer.

classFilesDirectory

@Parameter(defaultValue="${project.build.outputDirectory}",
           required=true)
public File classFilesDirectory

Directory containing the class files for FindBugs to analyze.

testClassFilesDirectory

@Parameter(defaultValue="${project.build.testOutputDirectory}",
           required=true)
public File testClassFilesDirectory

Directory containing the test class files for FindBugs to analyze.

xrefLocation

@Parameter(defaultValue="${project.reporting.outputDirectory}/xref")
public File xrefLocation

Location of the Xrefs to link to.

xrefTestLocation

@Parameter(defaultValue="${project.reporting.outputDirectory}/xref-test")
public File xrefTestLocation

Location of the Test Xrefs to link to.

compileSourceRoots

@Parameter(defaultValue="${project.compileSourceRoots}",
           required=true,
           readonly=true)
public List compileSourceRoots

The directories containing the sources to be compiled.

testSourceRoots

@Parameter(defaultValue="${project.testCompileSourceRoots}",
           required=true,
           readonly=true)
public List testSourceRoots

The directories containing the test-sources to be compiled.

Since:

2.0

includeTests

@Parameter(defaultValue="false",
           property="findbugs.includeTests")
public boolean includeTests

Run Findbugs on the tests.

Since:

2.0

pluginArtifacts

@Parameter(property="plugin.artifacts",
           required=true,
           readonly=true)
public ArrayList pluginArtifacts

List of artifacts this plugin depends on. Used for resolving the Findbugs coreplugin.

remoteRepositories

@Parameter(property="project.remoteArtifactRepositories",
           required=true,
           readonly=true)
public List remoteRepositories

List of Remote Repositories used by the resolver

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
public org.apache.maven.artifact.repository.ArtifactRepository localRepository

The local repository, needed to download the coreplugin jar.

remoteArtifactRepositories

@Parameter(property="project.remoteArtifactRepositories",
           required=true,
           readonly=true)
public List remoteArtifactRepositories

Remote repositories which will be searched for the coreplugin jar.

project

@Parameter(property="project",
           required=true,
           readonly=true)
public org.apache.maven.project.MavenProject project

Maven Project

xmlEncoding

@Parameter(defaultValue="UTF-8",
           readonly=true)
public String xmlEncoding

Encoding used for xml files. Default value is UTF-8.

sourceEncoding

@Parameter(defaultValue="${project.build.sourceEncoding}",
           property="encoding")
public String sourceEncoding

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.

Since:

2.2

outputEncoding

@Parameter(defaultValue="${project.reporting.outputEncoding}",
           property="outputEncoding")
public String outputEncoding

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.

Since:

2.2

threshold

@Parameter(defaultValue="Default",
           property="findbugs.threshold")
public String threshold

Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).

artifactResolver

@Component(role=org.apache.maven.artifact.resolver.ArtifactResolver.class)
public org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

Artifact resolver, needed to download the coreplugin jar.

factory

@Parameter(property="component.org.apache.maven.artifact.factory.ArtifactFactory",
           required=true,
           readonly=true)
public org.apache.maven.artifact.factory.ArtifactFactory factory

Used to look up Artifacts in the remote repository.

includeFilterFile

@Parameter(property="findbugs.includeFilterFile")
public String includeFilterFile

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.

Since:

1.0-beta-1

excludeFilterFile

@Parameter(property="findbugs.excludeFilterFile")
public String excludeFilterFile

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.

Since:

1.0-beta-1

excludeBugsFile

@Parameter(property="findbugs.excludeBugsFile")
public String excludeBugsFile

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.

Since:

2.4.1

effort

@Parameter(defaultValue="Default",
           property="findbugs.effort")
public String effort

Effort of the bug finders. Valid values are Min, Default and Max.

Since:

1.0-beta-1

debug

@Parameter(defaultValue="false",
           property="findbugs.debug")
public Boolean debug

turn on Findbugs debugging

relaxed

@Parameter(defaultValue="false",
           property="findbugs.relaxed")
public Boolean relaxed

Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false positives.

Since:

1.1

visitors

@Parameter(property="findbugs.visitors")
public String visitors

The visitor list to run. This is a comma-delimited list.

Since:

1.0-beta-1

omitVisitors

@Parameter(property="findbugs.omitVisitors")
public String omitVisitors

The visitor list to omit. This is a comma-delimited list.

Since:

1.0-beta-1

pluginList

@Parameter(property="findbugs.pluginList")
public String pluginList

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.

Since:

1.0-beta-1

plugins

@Parameter
public PluginArtifact[] plugins

Collection of PluginArtifact to work on. (PluginArtifact contains groupId, artifactId, version, type.) See Usage for details.

Since:

2.4.1

onlyAnalyze

@Parameter(property="findbugs.onlyAnalyze")
public String onlyAnalyze

Restrict analysis to the given comma-separated list of classes and packages.

Since:

1.1

nested

@Parameter(property="findbugs.nested",
           defaultValue="false")
public Boolean nested

This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.

Since:

2.3.2

trace

@Parameter(property="findbugs.trace",
           defaultValue="false")
public Boolean trace

Prints a trace of detectors run and classes analyzed to standard output. Useful for troubleshooting unexpected analysis failures.

Since:

2.3.2

maxRank

@Parameter(property="findbugs.maxRank")
public int maxRank

Maximum bug ranking to record.

Since:

2.4.1

skip

@Parameter(property="findbugs.skip",
           defaultValue="false")
public boolean skip

Skip entire check.

Since:

1.1

resourceManager

@Component(role=org.codehaus.plexus.resource.ResourceManager.class)
public org.codehaus.plexus.resource.ResourceManager resourceManager

Since:

2.0

siteTool

@Component(role=org.apache.maven.doxia.tools.SiteTool.class)
public org.apache.maven.doxia.tools.SiteTool siteTool

SiteTool.

Since:

2.1-SNAPSHOT

failOnError

@Parameter(property="findbugs.failOnError",
           defaultValue="true")
public boolean failOnError

Fail the build on an error.

Since:

2.0

fork

@Parameter(property="findbugs.fork",
           defaultValue="true")
public boolean fork

Fork a VM for FindBugs analysis. This will allow you to set timeouts and heap size

Since:

2.3.2

maxHeap

@Parameter(property="findbugs.maxHeap",
           defaultValue="512")
public int maxHeap

Maximum Java heap size in megabytes (default=512). This only works if the fork parameter is set true.

Since:

2.2

timeout

@Parameter(property="findbugs.timeout",
           defaultValue="600000")
public int timeout

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.

Since:

2.2

jvmArgs

@Parameter(property="findbugs.jvmArgs")
public String jvmArgs

the arguments to pass to the forked VM (ignored if fork is disabled).

Since:

2.4.1

Constructor Detail

AbstractFindbugsMojo

public AbstractFindbugsMojo()

Method Detail

getProject

protected org.apache.maven.project.MavenProject getProject()

Return the project.

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

Returns:

the project.

See Also:

AbstractMavenReport.getProject()

getOutputDirectory

protected String getOutputDirectory()

Returns the report output directory. Called by AbstractMavenReport.execute() for creating the sink.

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

Returns:

full path to the directory where the files in the site get copied to

See Also:

AbstractMavenReport.getOutputDirectory()