XDocsReporter (spotbugs-maven-plugin Groovy Documentation)

org.codehaus.mojo.spotbugs.XDocsReporter

```
class XDocsReporter
extends java.lang.Object
```
The reporter controls the generation of the Spotbugs report.

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`NOLINE_KEY` The key to get the value if the line number is not available.
`java.util.List<java.lang.String>`	`bugClasses` Bug Classes.
`java.util.ResourceBundle`	`bundle` The bundle to get the messages from.
`java.util.List<java.lang.String>`	`compileSourceRoots` The directories containing the sources to be compiled.
`java.lang.String`	`effort` The used effort for searching bugs.
`Log`	`log` The logger to write logs to.
`java.nio.charset.Charset`	`outputEncoding` The output encoding.
`groovy.xml.slurpersupport.GPathResult`	`spotbugsResults` Spotbugs Results.
`java.util.List<java.lang.String>`	`testSourceRoots` The directories containing the test sources to be compiled.
`java.lang.String`	`threshold` The threshold of bugs severity.

Constructor Summary

Constructors
Constructor and description
`XDocsReporter(java.util.ResourceBundle bundle, Log log, java.lang.String threshold, java.lang.String effort, java.nio.charset.Charset outputEncoding)` Default constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected static java.lang.String`	`evaluateThresholdParameter(java.lang.String thresholdValue)` Returns the threshold string value for the integer input.
	`void`	`generateReport(java.io.Writer outputWriter)` Generate report.
	`protected static java.lang.String`	`getSpotBugsVersion()` Gets the Spotbugs Version of the report.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - static final java.lang.String NOLINE_KEY
    
    The key to get the value if the line number is not available.
  - java.util.List<java.lang.String> bugClasses
    
    Bug Classes.
  - java.util.ResourceBundle bundle
    
    The bundle to get the messages from.
  - java.util.List<java.lang.String> compileSourceRoots
    
    The directories containing the sources to be compiled.
  - java.lang.String effort
    
    The used effort for searching bugs.
  - Log log
    
    The logger to write logs to.
  - java.nio.charset.Charset outputEncoding
    
    The output encoding.
  - groovy.xml.slurpersupport.GPathResult spotbugsResults
    
    Spotbugs Results.
  - java.util.List<java.lang.String> testSourceRoots
    
    The directories containing the test sources to be compiled.
  - java.lang.String threshold
    
    The threshold of bugs severity.
- Constructor Detail
  - XDocsReporter(java.util.ResourceBundle bundle, Log log, java.lang.String threshold, java.lang.String effort, java.nio.charset.Charset outputEncoding)
    
    Default constructor.
    Parameters:
    bundle - The Resource Bundle to use
    log - the log
    threshold - the threshold
    effort - the effort
    outputEncoding - the output encoding
- Method Detail
  - protected static java.lang.String evaluateThresholdParameter(java.lang.String thresholdValue)
    
    Returns the threshold string value for the integer input.
    Parameters:
    thresholdValue - The ThresholdValue integer to evaluate.
    Returns:
    The string valueof the Threshold object.
  - void generateReport(java.io.Writer outputWriter)
    
    Generate report.
  - protected static java.lang.String getSpotBugsVersion()
    
    Gets the Spotbugs Version of the report.
    Returns:
    The Spotbugs Version used on the report.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

spotbugs-maven-plugin Groovy Documentation

[Groovy] Class XDocsReporter

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String NOLINE_KEY

java.util.List<java.lang.String> bugClasses

java.util.ResourceBundle bundle

java.util.List<java.lang.String> compileSourceRoots

java.lang.String effort

Log log

java.nio.charset.Charset outputEncoding

groovy.xml.slurpersupport.GPathResult spotbugsResults

java.util.List<java.lang.String> testSourceRoots

java.lang.String threshold

Constructor Detail

XDocsReporter(java.util.ResourceBundle bundle, Log log, java.lang.String threshold, java.lang.String effort, java.nio.charset.Charset outputEncoding)

Method Detail

protected static java.lang.String evaluateThresholdParameter(java.lang.String thresholdValue)

void generateReport(java.io.Writer outputWriter)

protected static java.lang.String getSpotBugsVersion()