SpotbugsViolationCheckMojo (SpotBugs Maven Plugin 3.1.3.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.codehaus.mojo.spotbugs.SpotbugsViolationCheckMojo

All Implemented Interfaces:: groovy.lang.GroovyObject, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="check",
      defaultPhase=VERIFY,
      requiresDependencyResolution=TEST,
      requiresProject=true,
      threadSafe=true)
 @Execute(goal="spotbugs")
public class SpotbugsViolationCheckMojo
extends org.apache.maven.plugin.AbstractMojo
implements groovy.lang.GroovyObject

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor and Description

SpotbugsViolationCheckMojo()

Constructors
Constructor and Description
`SpotbugsViolationCheckMojo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute()`
`org.apache.maven.artifact.resolver.ArtifactResolver`	`getArtifactResolver()`
`int`	`getBugCount()`
`File`	`getClassFilesDirectory()`
`List`	`getCompileSourceRoots()`
`Boolean`	`getDebug()`
`String`	`getEffort()`
`int`	`getErrorCount()`
`String`	`getExcludeBugsFile()`
`String`	`getExcludeFilterFile()`
`boolean`	`getFailOnError()`
`boolean`	`getFork()`
`String`	`getIncludeFilterFile()`
`boolean`	`getIncludeTests()`
`String`	`getJvmArgs()`
`org.apache.maven.artifact.repository.ArtifactRepository`	`getLocalRepository()`
`int`	`getMaxHeap()`
`int`	`getMaxRank()`
`groovy.lang.MetaClass`	`getMetaClass()`
`Boolean`	`getNested()`
`String`	`getOmitVisitors()`
`String`	`getOnlyAnalyze()`
`File`	`getOutputDirectory()`
`String`	`getOutputEncoding()`
`List`	`getPluginArtifacts()`
`String`	`getPluginList()`
`org.apache.maven.project.MavenProject`	`getProject()`
`Object`	`getProperty(String property)`
`Boolean`	`getRelaxed()`
`List`	`getRemoteArtifactRepositories()`
`org.codehaus.plexus.resource.ResourceManager`	`getResourceManager()`
`org.apache.maven.doxia.siterenderer.Renderer`	`getSiteRenderer()`
`org.apache.maven.doxia.tools.SiteTool`	`getSiteTool()`
`boolean`	`getSkip()`
`String`	`getSourceEncoding()`
`boolean`	`getSpotbugsXmlOutput()`
`File`	`getSpotbugsXmlOutputDirectory()`
`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 method, Object arguments)`
`boolean`	`isFailOnError()`
`boolean`	`isFork()`
`boolean`	`isIncludeTests()`
`boolean`	`isSkip()`
`boolean`	`isSpotbugsXmlOutput()`
`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`	`setExcludeBugsFile(String value)`
`void`	`setExcludeFilterFile(String 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`	`setPluginArtifacts(List value)`
`void`	`setPluginList(String value)`
`void`	`setProject(org.apache.maven.project.MavenProject value)`
`void`	`setProperty(String property, 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`	`setSiteTool(org.apache.maven.doxia.tools.SiteTool value)`
`void`	`setSkip(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`	`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.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SpotbugsViolationCheckMojo
```
public SpotbugsViolationCheckMojo()
```

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

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)

getSpotbugsXmlOutput
```
public boolean getSpotbugsXmlOutput()
```

isSpotbugsXmlOutput
```
public boolean isSpotbugsXmlOutput()
```

setSpotbugsXmlOutput

public void setSpotbugsXmlOutput(boolean value)

getSpotbugsXmlOutputDirectory

public File getSpotbugsXmlOutputDirectory()

setSpotbugsXmlOutputDirectory

public void setSpotbugsXmlOutputDirectory(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 List getPluginArtifacts()
```

setPluginArtifacts

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

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

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

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

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

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

Class SpotbugsViolationCheckMojo

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SpotbugsViolationCheckMojo

Method Detail

getMetaClass

setMetaClass

invokeMethod

getProperty

setProperty

getOutputDirectory

setOutputDirectory

getXmlOutput

isXmlOutput

setXmlOutput

getXmlOutputDirectory

setXmlOutputDirectory

getSpotbugsXmlOutput

isSpotbugsXmlOutput

setSpotbugsXmlOutput

getSpotbugsXmlOutputDirectory

setSpotbugsXmlOutputDirectory

getSiteRenderer

setSiteRenderer

getClassFilesDirectory

setClassFilesDirectory

getTestClassFilesDirectory

setTestClassFilesDirectory

getXrefLocation

setXrefLocation

getXrefTestLocation

setXrefTestLocation

getCompileSourceRoots

setCompileSourceRoots

getTestSourceRoots

setTestSourceRoots

getIncludeTests

isIncludeTests

setIncludeTests

getPluginArtifacts

setPluginArtifacts

getLocalRepository

setLocalRepository

getRemoteArtifactRepositories

setRemoteArtifactRepositories

getProject

setProject

getXmlEncoding

setXmlEncoding

getSourceEncoding

setSourceEncoding

getOutputEncoding

setOutputEncoding

getThreshold

setThreshold

getArtifactResolver

setArtifactResolver

getIncludeFilterFile

setIncludeFilterFile

getExcludeFilterFile

setExcludeFilterFile

getExcludeBugsFile

setExcludeBugsFile

getEffort

setEffort

getDebug

setDebug

getRelaxed

setRelaxed

getVisitors

setVisitors

getOmitVisitors

setOmitVisitors

getPluginList

setPluginList