SpotBugsGui (spotbugs-maven-plugin Groovy Documentation)

org.codehaus.mojo.spotbugs.SpotBugsGui

All Implemented Interfaces and Traits:

SpotBugsPluginsTrait
```
@org.apache.maven.plugins.annotations.Mojo(name: gui, requiresDependencyResolution: ResolutionScope.TEST, requiresProject: true)
class SpotBugsGui
extends AbstractMojo
implements SpotBugsPluginsTrait
```
Launch the Spotbugs GUI. It will use all the parameters in the POM fle.
description:
Launch the Spotbugs GUI using the parameters in the POM fle.

Since:
2.0

Properties Summary

Properties
Type	Name and description
`java.io.File`	`classFilesDirectory` Directory containing the class files for Spotbugs to analyze.
`boolean`	`debug` Turn on Spotbugs debugging.
`java.lang.String`	`effort` Effort of the bug finders.
`java.lang.String`	`encoding` The file encoding to use when reading the source files.
`RepositorySystem`	`factory` Used to look up Artifacts in the remote repository.
`static java.util.Locale`	`locale` Locale to use for Resource bundle.
`int`	`maxHeap` Maximum Java heap size in megabytes (default=512).
`java.util.List<Artifact>`	`pluginArtifacts` List of artifacts this plugin depends on.
`java.lang.String`	`pluginList` The plugin list to include in the report.
`java.util.List<PluginArtifact>`	`plugins` Collection of PluginArtifact to work on.
`RepositorySystem`	`repositorySystem` Artifact resolver, needed to download the plugin jars.
`org.codehaus.plexus.resource.ResourceManager`	`resourceManager` Resource Manager.
`MavenSession`	`session` Maven Session.
`java.io.File`	`spotbugsXmlOutputDirectory` Specifies the directory where the Spotbugs native xml output will be generated.
`java.lang.String`	`spotbugsXmlOutputFilename` Set the name of the output XML file produced

Constructor Summary

Constructors
Constructor and description
`SpotBugsGui()`

Methods Summary

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

- Property Detail
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.outputDirectory}, required: true)
    java.io.File classFilesDirectory
    
    Directory containing the class files for Spotbugs to analyze.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: false, property: spotbugs.debug)
    boolean debug
    
    Turn on Spotbugs debugging.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
    java.lang.String effort
    
    Effort of the bug finders. Valid values are Min, Default and Max.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.sourceEncoding}, property: encoding)
    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
  - @javax.inject.Inject
    RepositorySystem factory
    
    Used to look up Artifacts in the remote repository.
  - static java.util.Locale locale
    
    Locale to use for Resource bundle.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)
    int maxHeap
    
    Maximum Java heap size in megabytes (default=512).
    Since:
    2.2
  - @org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)
    java.util.List<Artifact> pluginArtifacts
    
    List of artifacts this plugin depends on. Used for resolving the Spotbugs core plugin.
  - @org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)
    java.lang.String pluginList
    
    The plugin list to include in the report. This is a SpotbugsInfo.COMMA-delimited list.
  - @org.apache.maven.plugins.annotations.Parameter
    java.util.List<PluginArtifact> plugins
    
    Collection of PluginArtifact to work on. (PluginArtifact contains groupId, artifactId, version, type, classifier.) See Usage for details.
    Since:
    2.4.1
    4.8.3.0 includes classifier
  - @javax.inject.Inject
    RepositorySystem repositorySystem
    
    Artifact resolver, needed to download the plugin jars.
  - @javax.inject.Inject
    org.codehaus.plexus.resource.ResourceManager resourceManager
    
    Resource Manager.
    Since:
    2.0
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)
    MavenSession session
    
    Maven Session.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: ${project.build.directory}, required: true)
    java.io.File spotbugsXmlOutputDirectory
    
    Specifies the directory where the Spotbugs native xml output will be generated.
  - @org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
    java.lang.String spotbugsXmlOutputFilename
    
    Set the name of the output XML file produced
    Since:
    3.1.12.2
- Constructor Detail
  - SpotBugsGui()
- Method Detail
  - @java.lang.Override
    void execute()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

spotbugs-maven-plugin Groovy Documentation

[Groovy] Class SpotBugsGui

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@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: spotbugs.debug)
boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
java.lang.String effort

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

@javax.inject.Inject
RepositorySystem factory

static java.util.Locale locale

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)
int maxHeap

@org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)
java.util.List<Artifact> pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)
java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameter
java.util.List<PluginArtifact> plugins

@javax.inject.Inject
RepositorySystem repositorySystem

@javax.inject.Inject
org.codehaus.plexus.resource.ResourceManager resourceManager

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)
MavenSession session

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
java.lang.String spotbugsXmlOutputFilename

Constructor Detail

SpotBugsGui()

Method Detail

@java.lang.Override
void execute()

[Groovy] Class SpotBugsGui

Properties Summary

Constructor Summary

Methods Summary

Property Detail

@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: spotbugs.debug)boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)java.lang.String effort

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

@javax.inject.InjectRepositorySystem factory

static java.util.Locale locale

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)int maxHeap

@org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)java.util.List<Artifact> pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameterjava.util.List<PluginArtifact> plugins

@javax.inject.InjectRepositorySystem repositorySystem

@javax.inject.Injectorg.codehaus.plexus.resource.ResourceManager resourceManager

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)MavenSession session

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)java.lang.String spotbugsXmlOutputFilename

Constructor Detail

SpotBugsGui()

Method Detail

@java.lang.Overridevoid execute()

@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: spotbugs.debug)
boolean debug

@org.apache.maven.plugins.annotations.Parameter(defaultValue: Default, property: spotbugs.effort)
java.lang.String effort

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

@javax.inject.Inject
RepositorySystem factory

@org.apache.maven.plugins.annotations.Parameter(defaultValue: 512, property: spotbugs.maxHeap)
int maxHeap

@org.apache.maven.plugins.annotations.Parameter(property: plugin.artifacts, readonly: true, required: true)
java.util.List<Artifact> pluginArtifacts

@org.apache.maven.plugins.annotations.Parameter(property: spotbugs.pluginList)
java.lang.String pluginList

@org.apache.maven.plugins.annotations.Parameter
java.util.List<PluginArtifact> plugins

@javax.inject.Inject
RepositorySystem repositorySystem

@javax.inject.Inject
org.codehaus.plexus.resource.ResourceManager resourceManager

@org.apache.maven.plugins.annotations.Parameter(defaultValue: ${session}, readonly: true, required: true)
MavenSession session

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

@org.apache.maven.plugins.annotations.Parameter(defaultValue: spotbugsXml.xml, property: spotbugs.outputXmlFilename)
java.lang.String spotbugsXmlOutputFilename

@java.lang.Override
void execute()