org.codehaus.mojo.spotbugs

Class SpotBugsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.spotbugs.SpotBugsMojo

All Implemented Interfaces:

groovy.lang.GroovyObject, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport, SpotBugsPluginsTrait

@Mojo(name="spotbugs",
      requiresDependencyResolution=TEST,
      requiresProject=true,
      threadSafe=true)
public class SpotBugsMojo
extends org.apache.maven.reporting.AbstractMavenReport
implements SpotBugsPluginsTrait, groovy.lang.GroovyObject

Field Summary

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

outputDirectory, project, siteRenderer

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
SpotBugsMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
void	executeReport(Locale locale)
org.apache.maven.artifact.resolver.ArtifactResolver	getArtifactResolver()
int	getBugCount()
ResourceBundle	getBundle()
ResourceBundle	getBundle(Object locale)
File	getClassFilesDirectory()
List	getCompileSourceRoots()
Boolean	getDebug()
String	getDescription(Locale locale)
String	getEffort()
String	getEffortParameter()
int	getErrorCount()
String	getExcludeBugsFile()
String	getExcludeFilterFile()
org.apache.maven.repository.RepositorySystem	getFactory()
boolean	getFailOnError()
boolean	getFork()
String	getIncludeFilterFile()
boolean	getIncludeTests()
protected List	getJavaSources(Locale locale)
String	getJvmArgs()
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
int	getMaxHeap()
int	getMaxRank()
groovy.lang.MetaClass	getMetaClass()
String	getName(Locale locale)
Boolean	getNested()
String	getOmitVisitors()
String	getOnlyAnalyze()
protected String	getOutputDirectory()
String	getOutputEncoding()
String	getOutputName()
File	getOutputSpotbugsFile()
List	getPluginArtifacts()
String	getPluginList()
PluginArtifact[]	getPlugins()
protected org.apache.maven.project.MavenProject	getProject()
Object	getProperty(String property)
Boolean	getRelaxed()
List	getRemoteArtifactRepositories()
List	getRemoteRepositories()
org.codehaus.plexus.resource.ResourceManager	getResourceManager()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
org.apache.maven.doxia.tools.SiteTool	getSiteTool()
boolean	getSkip()
boolean	getSkipEmptyReport()
String	getSourceEncoding()
String	getSpotbugsPlugins()
boolean	getSpotbugsXmlOutput()
File	getSpotbugsXmlOutputDirectory()
File	getTestClassFilesDirectory()
List	getTestSourceRoots()
String	getThreshold()
protected String	getThresholdParameter()
int	getTimeout()
Boolean	getTrace()
String	getUserPrefs()
String	getVisitors()
String	getXmlEncoding()
boolean	getXmlOutput()
File	getXmlOutputDirectory()
File	getXrefLocation()
File	getXrefTestLocation()
Object	invokeMethod(String method, Object arguments)
boolean	isFailOnError()
boolean	isFork()
boolean	isIncludeTests()
protected boolean	isJxrPluginEnabled()
boolean	isSkip()
boolean	isSkipEmptyReport()
boolean	isSpotbugsXmlOutput()
boolean	isXmlOutput()
void	setArtifactResolver(org.apache.maven.artifact.resolver.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	setExcludeBugsFile(String value)
void	setExcludeFilterFile(String value)
void	setFactory(org.apache.maven.repository.RepositorySystem value)
void	setFailOnError(boolean value)
void	setFork(boolean value)
void	setIncludeFilterFile(String value)
void	setIncludeTests(boolean value)
void	setJvmArgs(String value)
void	setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository value)
void	setMaxHeap(int value)
void	setMaxRank(int value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setNested(Boolean value)
void	setOmitVisitors(String value)
void	setOnlyAnalyze(String value)
void	setOutputDirectory(File value)
void	setOutputEncoding(String value)
void	setOutputSpotbugsFile(File value)
void	setPluginArtifacts(List value)
void	setPluginList(String value)
void	setPlugins(PluginArtifact... value)
void	setProject(org.apache.maven.project.MavenProject value)
void	setProperty(String property, Object value)
void	setRelaxed(Boolean value)
void	setRemoteArtifactRepositories(List value)
void	setRemoteRepositories(List value)
void	setReportOutputDirectory(File reportOutputDirectory)
void	setResourceManager(org.codehaus.plexus.resource.ResourceManager value)
void	setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer value)
void	setSiteTool(org.apache.maven.doxia.tools.SiteTool value)
void	setSkip(boolean value)
void	setSkipEmptyReport(boolean value)
void	setSourceEncoding(String value)
void	setSpotbugsXmlOutput(boolean value)
void	setSpotbugsXmlOutputDirectory(File value)
void	setTestClassFilesDirectory(File value)
void	setTestSourceRoots(List value)
void	setThreshold(String value)
void	setTimeout(int value)
void	setTrace(Boolean value)
void	setUserPrefs(String 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, generate, generate, generate, getCategoryName, getInputEncoding, getReportOutputDirectory, getSink, getSinkFactory, 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

Methods inherited from interface org.codehaus.mojo.spotbugs.SpotBugsPluginsTrait

getLog

Constructor Detail

SpotBugsMojo

public SpotBugsMojo()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

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)

getSpotbugsXmlOutput

public boolean getSpotbugsXmlOutput()

isSpotbugsXmlOutput

public boolean isSpotbugsXmlOutput()

setSpotbugsXmlOutput

public void setSpotbugsXmlOutput(boolean value)

getSpotbugsXmlOutputDirectory

public File getSpotbugsXmlOutputDirectory()

Specified by:

getSpotbugsXmlOutputDirectory in interface SpotBugsPluginsTrait

setSpotbugsXmlOutputDirectory

public void setSpotbugsXmlOutputDirectory(File value)

setSiteRenderer

public void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer 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 List getPluginArtifacts()

setPluginArtifacts

public void setPluginArtifacts(List value)

getRemoteRepositories

public List getRemoteRepositories()

Specified by:

getRemoteRepositories in interface SpotBugsPluginsTrait

setRemoteRepositories

public void setRemoteRepositories(List value)

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

Specified by:

getLocalRepository in interface SpotBugsPluginsTrait

setLocalRepository

public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository value)

getRemoteArtifactRepositories

public List getRemoteArtifactRepositories()

setRemoteArtifactRepositories

public void setRemoteArtifactRepositories(List value)

setProject

public void setProject(org.apache.maven.project.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()

Overrides:

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

setOutputEncoding

public void setOutputEncoding(String value)

getThreshold

public String getThreshold()

setThreshold

public void setThreshold(String value)

getArtifactResolver

public org.apache.maven.artifact.resolver.ArtifactResolver getArtifactResolver()

Specified by:

getArtifactResolver in interface SpotBugsPluginsTrait

setArtifactResolver

public void setArtifactResolver(org.apache.maven.artifact.resolver.ArtifactResolver value)

getFactory

public org.apache.maven.repository.RepositorySystem getFactory()

Specified by:

getFactory in interface SpotBugsPluginsTrait

setFactory

public void setFactory(org.apache.maven.repository.RepositorySystem value)

getIncludeFilterFile

public String getIncludeFilterFile()

setIncludeFilterFile

public void setIncludeFilterFile(String value)

getExcludeFilterFile

public String getExcludeFilterFile()

setExcludeFilterFile

public void setExcludeFilterFile(String value)

getExcludeBugsFile

public String getExcludeBugsFile()

setExcludeBugsFile

public void setExcludeBugsFile(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()

Specified by:

getPluginList in interface SpotBugsPluginsTrait

setPluginList

public void setPluginList(String value)

getPlugins

public PluginArtifact[] getPlugins()

Specified by:

getPlugins in interface SpotBugsPluginsTrait

setPlugins

public void setPlugins(PluginArtifact... value)

getOnlyAnalyze

public String getOnlyAnalyze()

setOnlyAnalyze

public void setOnlyAnalyze(String value)

getNested

public Boolean getNested()

setNested

public void setNested(Boolean value)

getTrace

public Boolean getTrace()

setTrace

public void setTrace(Boolean value)

getMaxRank

public int getMaxRank()

setMaxRank

public void setMaxRank(int value)

getSkip

public boolean getSkip()

isSkip

public boolean isSkip()

setSkip

public void setSkip(boolean value)

getResourceManager

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

Specified by:

getResourceManager in interface SpotBugsPluginsTrait

setResourceManager

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

getSiteTool

public org.apache.maven.doxia.tools.SiteTool getSiteTool()

setSiteTool

public void setSiteTool(org.apache.maven.doxia.tools.SiteTool value)

getFailOnError

public boolean getFailOnError()

isFailOnError

public boolean isFailOnError()

setFailOnError

public void setFailOnError(boolean value)

getFork

public boolean getFork()

isFork

public boolean isFork()

setFork

public void setFork(boolean value)

getMaxHeap

public int getMaxHeap()

setMaxHeap

public void setMaxHeap(int value)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int value)

getJvmArgs

public String getJvmArgs()

setJvmArgs

public void setJvmArgs(String value)

getSkipEmptyReport

public boolean getSkipEmptyReport()

isSkipEmptyReport

public boolean isSkipEmptyReport()

setSkipEmptyReport

public void setSkipEmptyReport(boolean value)

getUserPrefs

public String getUserPrefs()

setUserPrefs

public void setUserPrefs(String 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)

getOutputSpotbugsFile

public File getOutputSpotbugsFile()

setOutputSpotbugsFile

public void setOutputSpotbugsFile(File value)

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

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

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

executeReport

public void executeReport(Locale locale)

Specified by:

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

execute

public void execute()

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getProject

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

Overrides:

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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Overrides:

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

isJxrPluginEnabled

protected boolean isJxrPluginEnabled()

getBundle

public ResourceBundle getBundle(Object locale)

getThresholdParameter

protected String getThresholdParameter()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

Overrides:

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

getJavaSources

protected List getJavaSources(Locale locale)

getSpotbugsPlugins

public String getSpotbugsPlugins()

Specified by:

getSpotbugsPlugins in interface SpotBugsPluginsTrait

getEffortParameter

public String getEffortParameter()

Specified by:

getEffortParameter in interface SpotBugsPluginsTrait