org.codehaus.mojo.findbugs
Class FindbugsViolationCheckMojo

java.lang.Object
  extended by groovy.lang.GroovyObjectSupport
      extended by org.codehaus.gmaven.mojo.GroovyMojo
          extended by org.codehaus.mojo.findbugs.FindbugsViolationCheckMojo
All Implemented Interfaces:
groovy.lang.GroovyObject, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, FindBugsInfo

public class FindbugsViolationCheckMojo
extends org.codehaus.gmaven.mojo.GroovyMojo
implements groovy.lang.GroovyObject, FindBugsInfo

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
Version:
$Id: FindbugsViolationCheckMojo.groovy gleclaire $
Author:
Garvin LeClaire

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_REGEX_PATTERN, JAVA_SOURCES_KEY, NAME_KEY, PLUGIN_NAME, SOURCE_ROOT_KEY, TEST_SOURCE_ROOT_KEY
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
FindbugsViolationCheckMojo()
           
 
Method Summary
 void execute()
           
 org.apache.maven.artifact.resolver.ArtifactResolver getArtifactResolver()
           
 int getBugCount()
           
 File getClassFilesDirectory()
           
 List getCompileSourceRoots()
           
 Boolean getDebug()
           
 String getEffort()
           
 int getErrorCount()
           
 String getExcludeFilterFile()
           
 boolean getFailOnError()
           
 boolean getFindbugsXmlOutput()
           
 File getFindbugsXmlOutputDirectory()
           
 boolean getFork()
           
 String getIncludeFilterFile()
           
 boolean getIncludeTests()
           
 org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
           
 int getMaxHeap()
           
 groovy.lang.MetaClass getMetaClass()
           
 Boolean getNested()
           
 String getOmitVisitors()
           
 String getOnlyAnalyze()
           
 File getOutputDirectory()
           
 String getOutputEncoding()
           
 ArrayList getPluginArtifacts()
           
 String getPluginList()
           
 org.apache.maven.project.MavenProject getProject()
           
 Object getProperty(String name)
           
 Boolean getRelaxed()
           
 List getRemoteArtifactRepositories()
           
 org.codehaus.plexus.resource.ResourceManager getResourceManager()
           
 org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 boolean getSkip()
           
 String getSourceEncoding()
           
 File getTestClassFilesDirectory()
           
 List getTestSourceRoots()
           
 String getThreshold()
           
 int getTimeout()
           
 Boolean getTrace()
           
 String getVisitors()
           
 String getXmlEncoding()
           
 boolean getXmlOutput()
           
 File getXmlOutputDirectory()
           
 File getXrefLocation()
           
 File getXrefTestLocation()
           
 Object invokeMethod(String name, Object args)
           
 boolean isFailOnError()
           
 boolean isFindbugsXmlOutput()
           
 boolean isFork()
           
 boolean isIncludeTests()
           
 boolean isSkip()
           
 boolean isXmlOutput()
           
 void setArtifactResolver(org.apache.maven.artifact.resolver.ArtifactResolver value)
           
 void setBugCount(int 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 setFork(boolean value)
           
 void setIncludeFilterFile(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 setNested(Boolean value)
           
 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(org.apache.maven.project.MavenProject value)
           
 void setProperty(String name, Object value)
           
 void setRelaxed(Boolean value)
           
 void setRemoteArtifactRepositories(List value)
           
 void setResourceManager(org.codehaus.plexus.resource.ResourceManager value)
           
 void setSiteRenderer(org.apache.maven.doxia.siterenderer.Renderer 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 setTrace(Boolean 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.codehaus.gmaven.mojo.GroovyMojo
fail, fail, 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
Constructor Detail

FindbugsViolationCheckMojo

public FindbugsViolationCheckMojo()
Method Detail

getOutputDirectory

public File getOutputDirectory()

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)

getSiteRenderer

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

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 ArrayList getPluginArtifacts()

setPluginArtifacts

public void setPluginArtifacts(ArrayList value)

getLocalRepository

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

setLocalRepository

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

getRemoteArtifactRepositories

public List getRemoteArtifactRepositories()

setRemoteArtifactRepositories

public void setRemoteArtifactRepositories(List value)

getProject

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

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

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

setArtifactResolver

public void setArtifactResolver(org.apache.maven.artifact.resolver.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)

getNested

public Boolean getNested()

setNested

public void setNested(Boolean value)

getTrace

public Boolean getTrace()

setTrace

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

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)

getBugCount

public int getBugCount()

setBugCount

public void setBugCount(int value)

getErrorCount

public int getErrorCount()

setErrorCount

public void setErrorCount(int value)

execute

public void execute()
Specified by:
execute in interface org.apache.maven.plugin.Mojo

getMetaClass

public groovy.lang.MetaClass getMetaClass()
Specified by:
getMetaClass in interface groovy.lang.GroovyObject
Overrides:
getMetaClass in class groovy.lang.GroovyObjectSupport

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)
Specified by:
setMetaClass in interface groovy.lang.GroovyObject
Overrides:
setMetaClass in class groovy.lang.GroovyObjectSupport

invokeMethod

public Object invokeMethod(String name,
                           Object args)
Specified by:
invokeMethod in interface groovy.lang.GroovyObject
Overrides:
invokeMethod in class groovy.lang.GroovyObjectSupport

getProperty

public Object getProperty(String name)
Specified by:
getProperty in interface groovy.lang.GroovyObject
Overrides:
getProperty in class org.codehaus.gmaven.mojo.GroovyMojo

setProperty

public void setProperty(String name,
                        Object value)
Specified by:
setProperty in interface groovy.lang.GroovyObject
Overrides:
setProperty in class groovy.lang.GroovyObjectSupport


Copyright © 2005-2011 Codehaus. All Rights Reserved.