org.codehaus.mojo.findbugs
Class FindBugsMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.codehaus.mojo.findbugs.FindBugsMojo

All Implemented Interfaces:

ContextEnabled, Mojo, MavenReport, FindBugsInfo

public class FindBugsMojo
extends AbstractMavenReport
implements FindBugsInfo

Generates a FindBugs Report when the site plugin is run. The HTML report is generated for site commands only. To see more documentation about FindBugs' options, please see the FindBugs Manual.

Version:

$Id: FindBugsMojo.groovy 11125 2009-11-09 00:07:43Z gleclaire $

Author:

Garvin LeClaire

Is defined to be executed in:

phase:

compile

Is defined by the goal name:

findbugs

Requires the dependencies in this specified scope:

compile

Requires a Maven project to run:

true

Field Summary

protected org.apache.maven.doxia.tools.SiteTool

siteTool SiteTool.

Fields inherited from interface org.codehaus.mojo.findbugs.FindBugsInfo

BUNDLE_NAME, DESCRIPTION_KEY, findbugsEfforts, findbugsThresholds, JAVA_REGEX_PATTERN, JAVA_SOURCES_KEY, NAME_KEY, PLUGIN_NAME, SOURCE_ROOT_KEY, TEST_SOURCE_ROOT_KEY

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

FindBugsMojo()

Method Summary

boolean	canGenerateReport() Checks whether prerequisites for generating this report are given.
void	executeFindbugs(Locale locale, File outputFile) Set up and run the Findbugs engine.
void	executeReport(Locale locale) Executes the generation of the report.
ArtifactResolver	getArtifactResolver()
int	getBugCount()
ResourceBundle	getBundle()
ResourceBundle	getBundle(Object locale)
File	getClassFilesDirectory()
List	getCompileSourceRoots()
Boolean	getDebug()
String	getDescription(Locale locale) Returns the plugins description for the "generated reports" overview page.
String	getEffort()
protected String	getEffortParameter() Returns the effort parameter to use.
int	getErrorCount()
String	getExcludeFilterFile()
boolean	getFailOnError()
boolean	getFindbugsXmlOutput()
File	getFindbugsXmlOutputDirectory()
String	getIncludeFilterFile()
boolean	getIncludeTests()
DefaultArtifactRepository	getLocalRepository()
int	getMaxHeap()
groovy.lang.MetaClass	getMetaClass()
String	getName(Locale locale) Returns the plugins name for the "generated reports" overview page and the menu.
String	getOmitVisitors()
String	getOnlyAnalyze()
protected String	getOutputDirectory() Returns the report output directory.
String	getOutputEncoding()
String	getOutputName() Returns report output file name, without the extension.
ArrayList	getPluginArtifacts()
String	getPluginList()
protected String	getPlugins() Adds the specified plugins to findbugs.
protected MavenProject	getProject() Return the project.
Object	getProperty(String name)
Boolean	getRelaxed()
List	getRemoteArtifactRepositories()
protected File	getResourceFile(String resource) Get the File reference for a File passed in as a string reference.
org.codehaus.plexus.resource.ResourceManager	getResourceManager()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer() Return the Sire Renderer.
boolean	getSkip()
String	getSourceEncoding()
File	getTestClassFilesDirectory()
List	getTestSourceRoots()
String	getThreshold()
protected String	getThresholdParameter() Returns the threshold parameter to use.
int	getTimeout()
String	getVisitors()
String	getXmlEncoding()
boolean	getXmlOutput()
File	getXmlOutputDirectory()
File	getXrefLocation()
File	getXrefTestLocation()
Object	invokeMethod(String name, Object args)
boolean	isFailOnError()
boolean	isFindbugsXmlOutput()
boolean	isIncludeTests()
protected boolean	isJxrPluginEnabled() Determines if the JXR-Plugin is included in the report section of the POM.
boolean	isSkip()
boolean	isXmlOutput()
void	setArtifactResolver(ArtifactResolver value)
void	setBugCount(int value)
void	setBundle(ResourceBundle value)
void	setClassFilesDirectory(File value)
void	setCompileSourceRoots(List value)
void	setDebug(Boolean value)
void	setEffort(String value)
void	setErrorCount(int value)
void	setExcludeFilterFile(String value)
void	setFailOnError(boolean value)
void	setFindbugsXmlOutput(boolean value)
void	setFindbugsXmlOutputDirectory(File value)
void	setIncludeFilterFile(String value)
void	setIncludeTests(boolean value)
void	setLocalRepository(DefaultArtifactRepository value)
void	setMaxHeap(int value)
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setOmitVisitors(String value)
void	setOnlyAnalyze(String value)
void	setOutputDirectory(File value)
void	setOutputEncoding(String value)
void	setPluginArtifacts(ArrayList value)
void	setPluginList(String value)
void	setProject(MavenProject value)
void	setProperty(String name, Object value)
void	setRelaxed(Boolean value)
void	setRemoteArtifactRepositories(List value)
void	setReportOutputDirectory(File reportOutputDirectory)
void	setResourceManager(org.codehaus.plexus.resource.ResourceManager value)
void	setSiteRenderer(org.codehaus.doxia.site.renderer.SiteRenderer value)
void	setSkip(boolean value)
void	setSourceEncoding(String value)
void	setTestClassFilesDirectory(File value)
void	setTestSourceRoots(List value)
void	setThreshold(String value)
void	setTimeout(int value)
void	setVisitors(String value)
void	setXmlEncoding(String value)
void	setXmlOutput(boolean value)
void	setXmlOutputDirectory(File value)
void	setXrefLocation(File value)
void	setXrefTestLocation(File value)

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

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport

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

Field Detail

siteTool

protected org.apache.maven.doxia.tools.SiteTool siteTool

SiteTool.

Since:

2.1-SNAPSHOT

Is a Plexus component defined by:

role:

org.apache.maven.doxia.tools.SiteTool

Is readonly.

Is required.

Constructor Detail

FindBugsMojo

public FindBugsMojo()

Method Detail

setOutputDirectory

public void setOutputDirectory(File value)

getXmlOutput

public boolean getXmlOutput()

isXmlOutput

public boolean isXmlOutput()

setXmlOutput

public void setXmlOutput(boolean value)

getXmlOutputDirectory

public File getXmlOutputDirectory()

setXmlOutputDirectory

public void setXmlOutputDirectory(File value)

getFindbugsXmlOutput

public boolean getFindbugsXmlOutput()

isFindbugsXmlOutput

public boolean isFindbugsXmlOutput()

setFindbugsXmlOutput

public void setFindbugsXmlOutput(boolean value)

getFindbugsXmlOutputDirectory

public File getFindbugsXmlOutputDirectory()

setFindbugsXmlOutputDirectory

public void setFindbugsXmlOutputDirectory(File value)

setSiteRenderer

public void setSiteRenderer(org.codehaus.doxia.site.renderer.SiteRenderer value)

getClassFilesDirectory

public File getClassFilesDirectory()

setClassFilesDirectory

public void setClassFilesDirectory(File value)

getTestClassFilesDirectory

public File getTestClassFilesDirectory()

setTestClassFilesDirectory

public void setTestClassFilesDirectory(File value)

getXrefLocation

public File getXrefLocation()

setXrefLocation

public void setXrefLocation(File value)

getXrefTestLocation

public File getXrefTestLocation()

setXrefTestLocation

public void setXrefTestLocation(File value)

getCompileSourceRoots

public List getCompileSourceRoots()

setCompileSourceRoots

public void setCompileSourceRoots(List value)

getTestSourceRoots

public List getTestSourceRoots()

setTestSourceRoots

public void setTestSourceRoots(List value)

getIncludeTests

public boolean getIncludeTests()

isIncludeTests

public boolean isIncludeTests()

setIncludeTests

public void setIncludeTests(boolean value)

getPluginArtifacts

public ArrayList getPluginArtifacts()

setPluginArtifacts

public void setPluginArtifacts(ArrayList value)

getLocalRepository

public DefaultArtifactRepository getLocalRepository()

setLocalRepository

public void setLocalRepository(DefaultArtifactRepository value)

getRemoteArtifactRepositories

public List getRemoteArtifactRepositories()

setRemoteArtifactRepositories

public void setRemoteArtifactRepositories(List value)

setProject

public void setProject(MavenProject value)

getXmlEncoding

public String getXmlEncoding()

setXmlEncoding

public void setXmlEncoding(String value)

getSourceEncoding

public String getSourceEncoding()

setSourceEncoding

public void setSourceEncoding(String value)

getOutputEncoding

public String getOutputEncoding()

setOutputEncoding

public void setOutputEncoding(String value)

getThreshold

public String getThreshold()

setThreshold

public void setThreshold(String value)

getArtifactResolver

public ArtifactResolver getArtifactResolver()

setArtifactResolver

public void setArtifactResolver(ArtifactResolver value)

getIncludeFilterFile

public String getIncludeFilterFile()

setIncludeFilterFile

public void setIncludeFilterFile(String value)

getExcludeFilterFile

public String getExcludeFilterFile()

setExcludeFilterFile

public void setExcludeFilterFile(String value)

getEffort

public String getEffort()

setEffort

public void setEffort(String value)

getDebug

public Boolean getDebug()

setDebug

public void setDebug(Boolean value)

getRelaxed

public Boolean getRelaxed()

setRelaxed

public void setRelaxed(Boolean value)

getVisitors

public String getVisitors()

setVisitors

public void setVisitors(String value)

getOmitVisitors

public String getOmitVisitors()

setOmitVisitors

public void setOmitVisitors(String value)

getPluginList

public String getPluginList()

setPluginList

public void setPluginList(String value)

getOnlyAnalyze

public String getOnlyAnalyze()

setOnlyAnalyze

public void setOnlyAnalyze(String value)

getSkip

public boolean getSkip()

isSkip

public boolean isSkip()

setSkip

public void setSkip(boolean value)

getResourceManager

public org.codehaus.plexus.resource.ResourceManager getResourceManager()

setResourceManager

public void setResourceManager(org.codehaus.plexus.resource.ResourceManager value)

getFailOnError

public boolean getFailOnError()

isFailOnError

public boolean isFailOnError()

setFailOnError

public void setFailOnError(boolean value)

getMaxHeap

public int getMaxHeap()

setMaxHeap

public void setMaxHeap(int value)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int value)

getBugCount

public int getBugCount()

setBugCount

public void setBugCount(int value)

getErrorCount

public int getErrorCount()

setErrorCount

public void setErrorCount(int value)

getBundle

public ResourceBundle getBundle()

setBundle

public void setBundle(ResourceBundle value)

canGenerateReport

public boolean canGenerateReport()

Checks whether prerequisites for generating this report are given.

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

Returns:

true if report can be generated, otherwise false

See Also:

MavenReport.canGenerateReport()

getDescription

public String getDescription(Locale locale)

Returns the plugins description for the "generated reports" overview page.

Specified by:

getDescription in interface MavenReport

Parameters:

locale - the locale the report should be generated for

Returns:

description of the report

See Also:

MavenReport.getDescription(java.util.Locale)

getName

public String getName(Locale locale)

Returns the plugins name for the "generated reports" overview page and the menu.

Specified by:

getName in interface MavenReport

Parameters:

locale - the locale the report should be generated for

Returns:

name of the report

See Also:

MavenReport.getName(java.util.Locale)

getOutputName

public String getOutputName()

Returns report output file name, without the extension. Called by AbstractMavenReport.execute() for creating the sink.

Specified by:

getOutputName in interface MavenReport

Returns:

name of the generated page

See Also:

MavenReport.getOutputName()

executeReport

public void executeReport(Locale locale)

Executes the generation of the report. Callback from Maven Site Plugin.

Specified by:

executeReport in class AbstractMavenReport

Parameters:

locale - he wanted locale to generate the report, could be null.

See Also:

#executeReport(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()

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

Specified by:

getOutputDirectory in class AbstractMavenReport

Returns:

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

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

protected MavenProject getProject()

Return the project.

Specified by:

getProject in class AbstractMavenReport

Returns:

the project.

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

Return the Sire Renderer.

Specified by:

getSiteRenderer in class AbstractMavenReport

Returns:

the Render used for generating the site.

See Also:

AbstractMavenReport.getSiteRenderer()

isJxrPluginEnabled

protected boolean isJxrPluginEnabled()

Determines if the JXR-Plugin is included in the report section of the POM.

Parameters:

bundle - The bundle to load the artifactIf of the jxr plugin.

Returns:

True if the JXR-Plugin is included in the POM, false otherwise.

getBundle

public ResourceBundle getBundle(Object locale)

executeFindbugs

public void executeFindbugs(Locale locale,
                            File outputFile)

Set up and run the Findbugs engine.

Parameters:

locale - the locale the report should be generated for

getThresholdParameter

protected String getThresholdParameter()

Returns the threshold parameter to use.

Returns:

A valid threshold parameter.

getEffortParameter

protected String getEffortParameter()

Returns the effort parameter to use.

Returns:

A valid effort parameter.

getResourceFile

protected File getResourceFile(String resource)

Get the File reference for a File passed in as a string reference.

Parameters:

resource - The file for the resource manager to locate

Returns:

The File of the resource

getPlugins

protected String getPlugins()

Adds the specified plugins to findbugs. The coreplugin is always added first.

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface MavenReport

Overrides:

setReportOutputDirectory in class AbstractMavenReport

See Also:

AbstractMavenReport.setReportOutputDirectory(java.io.File)

getMetaClass

public groovy.lang.MetaClass getMetaClass()

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

invokeMethod

public Object invokeMethod(String name,
                           Object args)

getProperty

public Object getProperty(String name)

setProperty

public void setProperty(String name,
                        Object value)