FindbugsViolationCheckMojo (FindBugs Maven Plugin 2.2 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.codehaus.mojo.findbugs
Class FindbugsViolationCheckMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.groovy.maven.mojo.GroovyMojo
          org.codehaus.mojo.findbugs.FindbugsViolationCheckMojo

All Implemented Interfaces:: groovy.lang.GroovyObject, ContextEnabled, Mojo, FindBugsInfo

public class FindbugsViolationCheckMojo
extends org.codehaus.groovy.maven.mojo.GroovyMojo
implements FindBugsInfo
extends org.codehaus.groovy.maven.mojo.GroovyMojo
implements 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

Is defined to be executed in:

goal:: findbugs

Is defined by the goal name:

check

Is bound to the specified phase of the standard build lifecycle:

verify

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 class org.codehaus.groovy.maven.mojo.GroovyMojo
`__timeStamp, __timeStamp__239_neverHappen1218741132868, sanitizeErrors`

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.plugin.Mojo
`ROLE`

Constructor Summary
`FindbugsViolationCheckMojo()`

Method Summary
`void`	`execute()`
`ArtifactResolver`	`getArtifactResolver()`
`int`	`getBugCount()`
`File`	`getClassFilesDirectory()`
`List`	`getCompileSourceRoots()`
`Boolean`	`getDebug()`
`String`	`getEffort()`
`int`	`getErrorCount()`
`String`	`getExcludeFilterFile()`
`boolean`	`getFailOnError()`
`boolean`	`getFindbugsXmlOutput()`
`File`	`getFindbugsXmlOutputDirectory()`
`String`	`getIncludeFilterFile()`
`boolean`	`getIncludeTests()`
`DefaultArtifactRepository`	`getLocalRepository()`
`int`	`getMaxHeap()`
`groovy.lang.MetaClass`	`getMetaClass()`
`String`	`getOmitVisitors()`
`String`	`getOnlyAnalyze()`
`File`	`getOutputDirectory()`
`String`	`getOutputEncoding()`
`ArrayList`	`getPluginArtifacts()`
`String`	`getPluginList()`
`MavenProject`	`getProject()`
`Object`	`getProperty(String name)`
`Boolean`	`getRelaxed()`
`List`	`getRemoteArtifactRepositories()`
`org.codehaus.plexus.resource.ResourceManager`	`getResourceManager()`
`org.codehaus.doxia.site.renderer.SiteRenderer`	`getSiteRenderer()`
`boolean`	`getSkip()`
`String`	`getSourceEncoding()`
`File`	`getTestClassFilesDirectory()`
`List`	`getTestSourceRoots()`
`String`	`getThreshold()`
`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()`
`boolean`	`isSkip()`
`boolean`	`isXmlOutput()`
`void`	`setArtifactResolver(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`	`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`	`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.codehaus.groovy.maven.mojo.GroovyMojo
`afterExecute, beforeExecute, fail, fail, getAnt`

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