FindBugsGui (Groovy Documentation)

org.codehaus.mojo.findbugs.FindBugsGui

All Implemented Interfaces and Traits:

FindBugsPluginsTrait
```
@org.apache.maven.plugins.annotations.Mojo( name = "gui", requiresDependencyResolution = ResolutionScope.TEST, requiresProject = true )
class FindBugsGui
extends org.apache.maven.plugin.AbstractMojo
```
Launch the Findbugs GUI. It will use all the parameters in the POM fle.
description:
Launch the Findbugs GUI using the parameters in the POM fle.

Since:
2.0
Authors:
Garvin LeClaire

Inherited fields
Fields inherited from class	Fields
`class org.apache.maven.plugin.AbstractMojo`	`ROLE`

Properties Summary

Properties
Type	Name and description
`org.apache.maven.artifact.resolver.ArtifactResolver`	`artifactResolver` Artifact resolver, needed to download the coreplugin jar.
`java.util.ResourceBundle`	`bundle` Resource bundle for a specific locale.
`java.io.File`	`classFilesDirectory` Directory containing the class files for FindBugs to analyze.
`java.lang.Boolean`	`debug` turn on Findbugs debugging
`java.lang.String`	`effort` Effort of the bug finders.
`java.lang.String`	`encoding` The file encoding to use when reading the source files.
`org.apache.maven.artifact.factory.ArtifactFactory`	`factory` Used to look up Artifacts in the remote repository.
`java.io.File`	`findbugsXmlOutputDirectory` Specifies the directory where the findbugs native xml output will be generated.
`org.apache.maven.artifact.repository.ArtifactRepository`	`localRepository` The local repository, needed to download the coreplugin jar.
`static java.util.Locale`	`locale` locale to use for Resource bundle.
`int`	`maxHeap` Maximum Java heap size in megabytes (default=512).
`java.util.List`	`pluginArtifacts` List of artifacts this plugin depends on.
`java.lang.String`	`pluginList` The plugin list to include in the report.
`PluginArtifact[]`	`plugins`
`org.apache.maven.project.MavenProject`	`project` Maven Project
`java.util.List`	`remoteRepositories` List of Remote Repositories used by the resolver
`org.codehaus.plexus.resource.ResourceManager`	`resourceManager` @since 2.0

Constructor Summary

Constructors
Constructor and description
`FindBugsGui ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`execute()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.apache.maven.plugin.AbstractMojo`	org.apache.maven.plugin.AbstractMojo#getPluginContext(), org.apache.maven.plugin.AbstractMojo#setPluginContext(java.util.Map), org.apache.maven.plugin.AbstractMojo#setLog(org.apache.maven.plugin.logging.Log), org.apache.maven.plugin.AbstractMojo#getLog(), org.apache.maven.plugin.AbstractMojo#wait(long, int), org.apache.maven.plugin.AbstractMojo#wait(long), org.apache.maven.plugin.AbstractMojo#wait(), org.apache.maven.plugin.AbstractMojo#equals(java.lang.Object), org.apache.maven.plugin.AbstractMojo#toString(), org.apache.maven.plugin.AbstractMojo#hashCode(), org.apache.maven.plugin.AbstractMojo#getClass(), org.apache.maven.plugin.AbstractMojo#notify(), org.apache.maven.plugin.AbstractMojo#notifyAll(), org.apache.maven.plugin.AbstractMojo#execute()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - @org.apache.maven.plugins.annotations.Component(role = org.apache.maven.artifact.resolver.ArtifactResolver.class) org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver
    
    Artifact resolver, needed to download the coreplugin jar.
    required:
    @readonly
  - @org.apache.maven.plugins.annotations.Parameter( readonly = true ) java.util.ResourceBundle bundle
    
    Resource bundle for a specific locale.
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.outputDirectory}', required = true ) java.io.File classFilesDirectory
    
    Directory containing the class files for FindBugs to analyze.
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.debug" ) java.lang.Boolean debug
    
    turn on Findbugs debugging
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = "Default", property="findbugs.effort" ) java.lang.String effort
    
    Effort of the bug finders. Valid values are Min, Default and Max.
  - @org.apache.maven.plugins.annotations.Parameter( property="encoding", defaultValue = '${project.build.sourceEncoding}' ) java.lang.String encoding
    
    The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. Note: This parameter always overrides the property charset from Checkstyle's TreeWalker module.
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter(property = "component.org.apache.maven.artifact.factory.ArtifactFactory", required = true, readonly = true) org.apache.maven.artifact.factory.ArtifactFactory factory
    
    Used to look up Artifacts in the remote repository.
  - @org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.directory}', required = true ) java.io.File findbugsXmlOutputDirectory
    
    Specifies the directory where the findbugs native xml output will be generated.
  - @org.apache.maven.plugins.annotations.Parameter(property = "localRepository", required = true, readonly = true) org.apache.maven.artifact.repository.ArtifactRepository localRepository
    
    The local repository, needed to download the coreplugin jar.
  - static java.util.Locale locale
    
    locale to use for Resource bundle.
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.maxHeap", defaultValue = "512" ) int maxHeap
    
    Maximum Java heap size in megabytes (default=512).
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter( property="plugin.artifacts", required = true, readonly = true ) java.util.List pluginArtifacts
    
    List of artifacts this plugin depends on. Used for resolving the Findbugs coreplugin.
  - @org.apache.maven.plugins.annotations.Parameter( property="findbugs.pluginList" ) java.lang.String pluginList
    
    The plugin list to include in the report. This is a FindBugsInfo.COMMA-delimited list.
  - @org.apache.maven.plugins.annotations.Parameter PluginArtifact[] plugins
    
    Collection of PluginArtifact to work on. (PluginArtifact contains groupId, artifactId, version, type.) See Usage for details.
  - @org.apache.maven.plugins.annotations.Parameter( property="project", required = true, readonly = true ) org.apache.maven.project.MavenProject project
    
    Maven Project
  - @org.apache.maven.plugins.annotations.Parameter(property = "project.remoteArtifactRepositories", required = true, readonly = true) java.util.List remoteRepositories
    
    List of Remote Repositories used by the resolver
  - @org.apache.maven.plugins.annotations.Component(role = ResourceManager.class) org.codehaus.plexus.resource.ResourceManager resourceManager
    
    Since:
    2.0
- Constructor Detail
  - FindBugsGui()
- Method Detail
  - void execute()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class FindBugsGui

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@org.apache.maven.plugins.annotations.Component(role = org.apache.maven.artifact.resolver.ArtifactResolver.class) org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

@org.apache.maven.plugins.annotations.Parameter( readonly = true ) java.util.ResourceBundle bundle

@org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.outputDirectory}', required = true ) java.io.File classFilesDirectory

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "false", property="findbugs.debug" ) java.lang.Boolean debug

@org.apache.maven.plugins.annotations.Parameter( defaultValue = "Default", property="findbugs.effort" ) java.lang.String effort

@org.apache.maven.plugins.annotations.Parameter( property="encoding", defaultValue = '${project.build.sourceEncoding}' ) java.lang.String encoding

@org.apache.maven.plugins.annotations.Parameter(property = "component.org.apache.maven.artifact.factory.ArtifactFactory", required = true, readonly = true) org.apache.maven.artifact.factory.ArtifactFactory factory

@org.apache.maven.plugins.annotations.Parameter( defaultValue = '${project.build.directory}', required = true ) java.io.File findbugsXmlOutputDirectory

@org.apache.maven.plugins.annotations.Parameter(property = "localRepository", required = true, readonly = true) org.apache.maven.artifact.repository.ArtifactRepository localRepository

static java.util.Locale locale

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.maxHeap", defaultValue = "512" ) int maxHeap

@org.apache.maven.plugins.annotations.Parameter( property="plugin.artifacts", required = true, readonly = true ) java.util.List pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter( property="findbugs.pluginList" ) java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameter PluginArtifact[] plugins

@org.apache.maven.plugins.annotations.Parameter( property="project", required = true, readonly = true ) org.apache.maven.project.MavenProject project

@org.apache.maven.plugins.annotations.Parameter(property = "project.remoteArtifactRepositories", required = true, readonly = true) java.util.List remoteRepositories

@org.apache.maven.plugins.annotations.Component(role = ResourceManager.class) org.codehaus.plexus.resource.ResourceManager resourceManager

Constructor Detail

FindBugsGui()

Method Detail

void execute()