XDocsReporter (Groovy Documentation)

org.codehaus.mojo.findbugs.XDocsReporter

The reporter controls the generation of the FindBugs report.
Authors:
Garvin LeClaire

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`	`bugClasses`
`java.util.ResourceBundle`	`bundle` The bundle to get the messages from.
`java.util.List`	`compileSourceRoots` The directories containing the sources to be compiled.
`java.lang.String`	`effort` The used effort for searching bugs.
`groovy.util.slurpersupport.GPathResult`	`findbugsResults`
`org.apache.maven.plugin.logging.Log`	`log` The logger to write logs to.
`java.lang.String`	`outputEncoding`
`java.io.Writer`	`outputWriter` The output Writer stream.
`java.util.List`	`testSourceRoots`
`java.lang.String`	`threshold` The threshold of bugs severity.

Constructor Summary

Constructors
Constructor and description
`XDocsReporter (java.util.ResourceBundle bundle, org.apache.maven.plugin.logging.Log log, java.lang.String threshold, java.lang.String effort, java.lang.String outputEncoding)` Default constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`evaluateThresholdParameter(java.lang.String thresholdValue)` Returns the threshold string value for the integer input.
	`void`	`generateReport()`
	`protected java.lang.String`	`getFindBugsVersion()` Gets the Findbugs Version of the report.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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
  - static final java.lang.String NOLINE_KEY
    
    The key to get the value if the line number is not available.
  - java.util.List bugClasses
  - java.util.ResourceBundle bundle
    
    The bundle to get the messages from.
  - java.util.List compileSourceRoots
    
    The directories containing the sources to be compiled.
  - java.lang.String effort
    
    The used effort for searching bugs.
  - groovy.util.slurpersupport.GPathResult findbugsResults
  - org.apache.maven.plugin.logging.Log log
    
    The logger to write logs to.
  - java.lang.String outputEncoding
  - java.io.Writer outputWriter
    
    The output Writer stream.
  - java.util.List testSourceRoots
  - java.lang.String threshold
    
    The threshold of bugs severity.
- Constructor Detail
  - XDocsReporter(java.util.ResourceBundle bundle, org.apache.maven.plugin.logging.Log log, java.lang.String threshold, java.lang.String effort, java.lang.String outputEncoding)
    
    Default constructor.
    Parameters:
    bundle - - The Resource Bundle to use
- Method Detail
  - protected 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()
  - protected java.lang.String getFindBugsVersion()
    
    Gets the Findbugs Version of the report.
    Returns:
    The Findbugs Version used on the report.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

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 bugClasses

java.util.ResourceBundle bundle

java.util.List compileSourceRoots

java.lang.String effort

groovy.util.slurpersupport.GPathResult findbugsResults

org.apache.maven.plugin.logging.Log log

java.lang.String outputEncoding

java.io.Writer outputWriter

java.util.List testSourceRoots

java.lang.String threshold

Constructor Detail

XDocsReporter(java.util.ResourceBundle bundle, org.apache.maven.plugin.logging.Log log, java.lang.String threshold, java.lang.String effort, java.lang.String outputEncoding)

Method Detail

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

void generateReport()

protected java.lang.String getFindBugsVersion()