|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.findbugs.FindBugsMojo
public class FindBugsMojo
Generates a FindBugs Report when the site plugin is run. The HTML report is generated for site commands only.
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, findbugsPriority, findbugsThresholds, 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 |
execute()
|
void |
executeFindbugs(java.util.Locale locale,
java.io.File outputFile)
Set up and run the Findbugs engine. |
void |
executeReport(java.util.Locale locale)
Executes the generation of the report. |
org.apache.maven.artifact.resolver.ArtifactResolver |
getArtifactResolver()
|
int |
getBugCount()
|
java.util.ResourceBundle |
getBundle()
|
java.util.ResourceBundle |
getBundle(java.lang.Object locale)
|
java.io.File |
getClassFilesDirectory()
|
java.util.List |
getCompileSourceRoots()
|
java.lang.Boolean |
getDebug()
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the plugins description for the "generated reports" overview page. |
java.lang.String |
getEffort()
|
protected java.lang.String |
getEffortParameter()
Returns the effort parameter to use. |
int |
getErrorCount()
|
java.lang.String |
getExcludeFilterFile()
|
boolean |
getFailOnError()
|
boolean |
getFindbugsXmlOutput()
|
java.io.File |
getFindbugsXmlOutputDirectory()
|
boolean |
getFork()
|
java.lang.String |
getIncludeFilterFile()
|
boolean |
getIncludeTests()
|
protected java.util.List |
getJavaSources(java.util.Locale locale)
Collects the java sources from the source roots. |
org.apache.maven.artifact.repository.ArtifactRepository |
getLocalRepository()
|
int |
getMaxHeap()
|
groovy.lang.MetaClass |
getMetaClass()
|
java.lang.String |
getName(java.util.Locale locale)
Returns the plugins name for the "generated reports" overview page and the menu. |
java.lang.String |
getOmitVisitors()
|
java.lang.String |
getOnlyAnalyze()
|
protected java.lang.String |
getOutputDirectory()
Returns the report output directory. |
java.lang.String |
getOutputEncoding()
|
java.lang.String |
getOutputName()
Returns report output file name, without the extension. |
java.util.ArrayList |
getPluginArtifacts()
|
java.lang.String |
getPluginList()
|
protected java.lang.String |
getPlugins()
Adds the specified plugins to findbugs. |
protected org.apache.maven.project.MavenProject |
getProject()
Return the project. |
java.lang.Object |
getProperty(java.lang.String name)
|
java.lang.Boolean |
getRelaxed()
|
java.util.List |
getRemoteArtifactRepositories()
|
protected java.io.File |
getResourceFile(java.lang.String resource)
Get the File reference for a File passed in as a string reference. |
org.codehaus.plexus.resource.ResourceManager |
getResourceManager()
|
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
Return the Sire Renderer. |
boolean |
getSkip()
|
java.lang.String |
getSourceEncoding()
|
java.io.File |
getTestClassFilesDirectory()
|
java.util.List |
getTestSourceRoots()
|
java.lang.String |
getThreshold()
|
protected java.lang.String |
getThresholdParameter()
Returns the threshold parameter to use. |
int |
getTimeout()
|
java.lang.String |
getVisitors()
|
java.lang.String |
getXmlEncoding()
|
boolean |
getXmlOutput()
|
java.io.File |
getXmlOutputDirectory()
|
java.io.File |
getXrefLocation()
|
java.io.File |
getXrefTestLocation()
|
java.lang.Object |
invokeMethod(java.lang.String name,
java.lang.Object args)
|
boolean |
isFailOnError()
|
boolean |
isFindbugsXmlOutput()
|
boolean |
isFork()
|
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(org.apache.maven.artifact.resolver.ArtifactResolver value)
|
void |
setBugCount(int value)
|
void |
setBundle(java.util.ResourceBundle value)
|
void |
setClassFilesDirectory(java.io.File value)
|
void |
setCompileSourceRoots(java.util.List value)
|
void |
setDebug(java.lang.Boolean value)
|
void |
setEffort(java.lang.String value)
|
void |
setErrorCount(int value)
|
void |
setExcludeFilterFile(java.lang.String value)
|
void |
setFailOnError(boolean value)
|
void |
setFindbugsXmlOutput(boolean value)
|
void |
setFindbugsXmlOutputDirectory(java.io.File value)
|
void |
setFork(boolean value)
|
void |
setIncludeFilterFile(java.lang.String value)
|
void |
setIncludeTests(boolean value)
|
void |
setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository value)
|
void |
setMaxHeap(int value)
|
void |
setMetaClass(groovy.lang.MetaClass metaClass)
|
void |
setOmitVisitors(java.lang.String value)
|
void |
setOnlyAnalyze(java.lang.String value)
|
void |
setOutputDirectory(java.io.File value)
|
void |
setOutputEncoding(java.lang.String value)
|
void |
setPluginArtifacts(java.util.ArrayList value)
|
void |
setPluginList(java.lang.String value)
|
void |
setProject(org.apache.maven.project.MavenProject value)
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
|
void |
setRelaxed(java.lang.Boolean value)
|
void |
setRemoteArtifactRepositories(java.util.List value)
|
void |
setReportOutputDirectory(java.io.File reportOutputDirectory)
|
void |
setResourceManager(org.codehaus.plexus.resource.ResourceManager value)
|
void |
setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer value)
|
void |
setSkip(boolean value)
|
void |
setSourceEncoding(java.lang.String value)
|
void |
setTestClassFilesDirectory(java.io.File value)
|
void |
setTestSourceRoots(java.util.List value)
|
void |
setThreshold(java.lang.String value)
|
void |
setTimeout(int value)
|
void |
setVisitors(java.lang.String value)
|
void |
setXmlEncoding(java.lang.String value)
|
void |
setXmlOutput(boolean value)
|
void |
setXmlOutputDirectory(java.io.File value)
|
void |
setXrefLocation(java.io.File value)
|
void |
setXrefTestLocation(java.io.File value)
|
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, generate, generate, generate, getCategoryName, 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 |
Field Detail |
---|
protected org.apache.maven.doxia.tools.SiteTool siteTool
Constructor Detail |
---|
public FindBugsMojo()
Method Detail |
---|
public void setOutputDirectory(java.io.File value)
public boolean getXmlOutput()
public boolean isXmlOutput()
public void setXmlOutput(boolean value)
public java.io.File getXmlOutputDirectory()
public void setXmlOutputDirectory(java.io.File value)
public boolean getFindbugsXmlOutput()
public boolean isFindbugsXmlOutput()
public void setFindbugsXmlOutput(boolean value)
public java.io.File getFindbugsXmlOutputDirectory()
public void setFindbugsXmlOutputDirectory(java.io.File value)
public void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer value)
public java.io.File getClassFilesDirectory()
public void setClassFilesDirectory(java.io.File value)
public java.io.File getTestClassFilesDirectory()
public void setTestClassFilesDirectory(java.io.File value)
public java.io.File getXrefLocation()
public void setXrefLocation(java.io.File value)
public java.io.File getXrefTestLocation()
public void setXrefTestLocation(java.io.File value)
public java.util.List getCompileSourceRoots()
public void setCompileSourceRoots(java.util.List value)
public java.util.List getTestSourceRoots()
public void setTestSourceRoots(java.util.List value)
public boolean getIncludeTests()
public boolean isIncludeTests()
public void setIncludeTests(boolean value)
public java.util.ArrayList getPluginArtifacts()
public void setPluginArtifacts(java.util.ArrayList value)
public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository value)
public java.util.List getRemoteArtifactRepositories()
public void setRemoteArtifactRepositories(java.util.List value)
public void setProject(org.apache.maven.project.MavenProject value)
public java.lang.String getXmlEncoding()
public void setXmlEncoding(java.lang.String value)
public java.lang.String getSourceEncoding()
public void setSourceEncoding(java.lang.String value)
public java.lang.String getOutputEncoding()
public void setOutputEncoding(java.lang.String value)
public java.lang.String getThreshold()
public void setThreshold(java.lang.String value)
public org.apache.maven.artifact.resolver.ArtifactResolver getArtifactResolver()
public void setArtifactResolver(org.apache.maven.artifact.resolver.ArtifactResolver value)
public java.lang.String getIncludeFilterFile()
public void setIncludeFilterFile(java.lang.String value)
public java.lang.String getExcludeFilterFile()
public void setExcludeFilterFile(java.lang.String value)
public java.lang.String getEffort()
public void setEffort(java.lang.String value)
public java.lang.Boolean getDebug()
public void setDebug(java.lang.Boolean value)
public java.lang.Boolean getRelaxed()
public void setRelaxed(java.lang.Boolean value)
public java.lang.String getVisitors()
public void setVisitors(java.lang.String value)
public java.lang.String getOmitVisitors()
public void setOmitVisitors(java.lang.String value)
public java.lang.String getPluginList()
public void setPluginList(java.lang.String value)
public java.lang.String getOnlyAnalyze()
public void setOnlyAnalyze(java.lang.String value)
public boolean getSkip()
public boolean isSkip()
public void setSkip(boolean value)
public org.codehaus.plexus.resource.ResourceManager getResourceManager()
public void setResourceManager(org.codehaus.plexus.resource.ResourceManager value)
public boolean getFailOnError()
public boolean isFailOnError()
public void setFailOnError(boolean value)
public boolean getFork()
public boolean isFork()
public void setFork(boolean value)
public int getMaxHeap()
public void setMaxHeap(int value)
public int getTimeout()
public void setTimeout(int value)
public int getBugCount()
public void setBugCount(int value)
public int getErrorCount()
public void setErrorCount(int value)
public java.util.ResourceBundle getBundle()
public void setBundle(java.util.ResourceBundle value)
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
MavenReport.canGenerateReport()
public java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
locale
- the locale the report should be generated for
MavenReport.getDescription(java.util.Locale)
public java.lang.String getName(java.util.Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
locale
- the locale the report should be generated for
MavenReport.getName(java.util.Locale)
public java.lang.String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
MavenReport.getOutputName()
public void executeReport(java.util.Locale locale)
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
locale
- he wanted locale to generate the report, could be null.#executeReport(java.util.Locale)
protected java.lang.String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getOutputDirectory()
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getProject()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
protected boolean isJxrPluginEnabled()
bundle
- The bundle to load the artifactIf of the jxr plugin.
public java.util.ResourceBundle getBundle(java.lang.Object locale)
public void execute()
execute
in interface org.apache.maven.plugin.Mojo
execute
in class org.apache.maven.reporting.AbstractMavenReport
public void executeFindbugs(java.util.Locale locale, java.io.File outputFile)
locale
- the locale the report should be generated forprotected java.lang.String getThresholdParameter()
protected java.lang.String getEffortParameter()
protected java.io.File getResourceFile(java.lang.String resource)
resource
- The file for the resource manager to locate
protected java.lang.String getPlugins()
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
setReportOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.setReportOutputDirectory(java.io.File)
protected java.util.List getJavaSources(java.util.Locale locale)
public groovy.lang.MetaClass getMetaClass()
getMetaClass
in interface groovy.lang.GroovyObject
public void setMetaClass(groovy.lang.MetaClass metaClass)
setMetaClass
in interface groovy.lang.GroovyObject
public java.lang.Object invokeMethod(java.lang.String name, java.lang.Object args)
invokeMethod
in interface groovy.lang.GroovyObject
public java.lang.Object getProperty(java.lang.String name)
getProperty
in interface groovy.lang.GroovyObject
public void setProperty(java.lang.String name, java.lang.Object value)
setProperty
in interface groovy.lang.GroovyObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |