org.codehaus.mojo.findbugs
Class XDocsReporter

java.lang.Object
  org.codehaus.mojo.findbugs.XDocsReporter

All Implemented Interfaces:

FindBugsInfo

public class XDocsReporter
extends Object
implements FindBugsInfo

The reporter controls the generation of the FindBugs report.

Version:

$Id: XDocsReporter.groovy 10629 2009-09-07 21:39:31Z gleclaire $

Author:

Garvin LeClaire

Field Summary

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

Constructor Summary

XDocsReporter(ResourceBundle bundle, Log log, String threshold, String effort, String outputEncoding)
Default constructor.

Method Summary

protected String	evaluateThresholdParameter(String thresholdValue) Returns the threshold string value for the integer input.
void	generateReport()
List	getBugClasses()
ResourceBundle	getBundle()
List	getCompileSourceRoots()
String	getEffort()
groovy.util.slurpersupport.GPathResult	getFindbugsResults()
protected String	getFindBugsVersion() Gets the Findbugs Version of the report.
Log	getLog()
groovy.lang.MetaClass	getMetaClass()
static String	getNOLINE_KEY()
String	getOutputEncoding()
Writer	getOutputWriter()
Object	getProperty(String name)
String	getThreshold()
Object	invokeMethod(String name, Object args)
void	setBugClasses(List value)
void	setBundle(ResourceBundle value)
void	setCompileSourceRoots(List value)
void	setEffort(String value)
void	setFindbugsResults(groovy.util.slurpersupport.GPathResult value)
void	setLog(Log value)
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setOutputEncoding(String value)
void	setOutputWriter(Writer value)
void	setProperty(String name, Object value)
void	setThreshold(String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XDocsReporter

public XDocsReporter(ResourceBundle bundle,
                     Log log,
                     String threshold,
                     String effort,
                     String outputEncoding)

Default constructor.

Parameters:

bundle - - The Resource Bundle to use

Method Detail

getNOLINE_KEY

public static final String getNOLINE_KEY()

getBundle

public ResourceBundle getBundle()

setBundle

public void setBundle(ResourceBundle value)

getLog

public Log getLog()

setLog

public void setLog(Log value)

getThreshold

public String getThreshold()

setThreshold

public void setThreshold(String value)

getEffort

public String getEffort()

setEffort

public void setEffort(String value)

getOutputWriter

public Writer getOutputWriter()

setOutputWriter

public void setOutputWriter(Writer value)

getFindbugsResults

public groovy.util.slurpersupport.GPathResult getFindbugsResults()

setFindbugsResults

public void setFindbugsResults(groovy.util.slurpersupport.GPathResult value)

getBugClasses

public List getBugClasses()

setBugClasses

public void setBugClasses(List value)

getCompileSourceRoots

public List getCompileSourceRoots()

setCompileSourceRoots

public void setCompileSourceRoots(List value)

getOutputEncoding

public String getOutputEncoding()

setOutputEncoding

public void setOutputEncoding(String value)

evaluateThresholdParameter

protected String evaluateThresholdParameter(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.

getFindBugsVersion

protected String getFindBugsVersion()

Gets the Findbugs Version of the report.

Returns:

The Findbugs Version used on the report.

generateReport

public void generateReport()

getMetaClass

public groovy.lang.MetaClass getMetaClass()

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

invokeMethod

public Object invokeMethod(String name,
                           Object args)

getProperty

public Object getProperty(String name)

setProperty

public void setProperty(String name,
                        Object value)