org.codehaus.mojo.findbugs
Class XDocsReporter

java.lang.Object
  extended by org.codehaus.mojo.findbugs.XDocsReporter
All Implemented Interfaces:
groovy.lang.GroovyObject, FindBugsInfo

public class XDocsReporter
extends java.lang.Object
implements groovy.lang.GroovyObject, FindBugsInfo

The reporter controls the generation of the FindBugs report.

Version:
$Id: XDocsReporter.groovy 12226 2010-05-24 10:52:23Z gleclaire $
Author:
Garvin LeClaire

Field Summary
 
Fields inherited from interface org.codehaus.mojo.findbugs.FindBugsInfo
BUNDLE_NAME, DESCRIPTION_KEY, findbugsEfforts, findbugsPriority, findbugsThresholds, JAVA_REGEX_PATTERN, JAVA_SOURCES_KEY, NAME_KEY, PLUGIN_NAME, SOURCE_ROOT_KEY, TEST_SOURCE_ROOT_KEY
 
Constructor Summary
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.
 
Method Summary
protected  java.lang.String evaluateThresholdParameter(java.lang.String thresholdValue)
          Returns the threshold string value for the integer input.
 void generateReport()
           
 java.util.List getBugClasses()
           
 java.util.ResourceBundle getBundle()
           
 java.util.List getCompileSourceRoots()
           
 java.lang.String getEffort()
           
 groovy.util.slurpersupport.GPathResult getFindbugsResults()
           
protected  java.lang.String getFindBugsVersion()
          Gets the Findbugs Version of the report.
 org.apache.maven.plugin.logging.Log getLog()
           
 groovy.lang.MetaClass getMetaClass()
           
static java.lang.String getNOLINE_KEY()
           
 java.lang.String getOutputEncoding()
           
 java.io.Writer getOutputWriter()
           
 java.lang.Object getProperty(java.lang.String name)
           
 java.lang.String getThreshold()
           
 java.lang.Object invokeMethod(java.lang.String name, java.lang.Object args)
           
 void setBugClasses(java.util.List value)
           
 void setBundle(java.util.ResourceBundle value)
           
 void setCompileSourceRoots(java.util.List value)
           
 void setEffort(java.lang.String value)
           
 void setFindbugsResults(groovy.util.slurpersupport.GPathResult value)
           
 void setLog(org.apache.maven.plugin.logging.Log value)
           
 void setMetaClass(groovy.lang.MetaClass metaClass)
           
 void setOutputEncoding(java.lang.String value)
           
 void setOutputWriter(java.io.Writer value)
           
 void setProperty(java.lang.String name, java.lang.Object value)
           
 void setThreshold(java.lang.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(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

getNOLINE_KEY

public static final java.lang.String getNOLINE_KEY()

getBundle

public java.util.ResourceBundle getBundle()

setBundle

public void setBundle(java.util.ResourceBundle value)

getLog

public org.apache.maven.plugin.logging.Log getLog()

setLog

public void setLog(org.apache.maven.plugin.logging.Log value)

getThreshold

public java.lang.String getThreshold()

setThreshold

public void setThreshold(java.lang.String value)

getEffort

public java.lang.String getEffort()

setEffort

public void setEffort(java.lang.String value)

getOutputWriter

public java.io.Writer getOutputWriter()

setOutputWriter

public void setOutputWriter(java.io.Writer value)

getFindbugsResults

public groovy.util.slurpersupport.GPathResult getFindbugsResults()

setFindbugsResults

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

getBugClasses

public java.util.List getBugClasses()

setBugClasses

public void setBugClasses(java.util.List value)

getCompileSourceRoots

public java.util.List getCompileSourceRoots()

setCompileSourceRoots

public void setCompileSourceRoots(java.util.List value)

getOutputEncoding

public java.lang.String getOutputEncoding()

setOutputEncoding

public void setOutputEncoding(java.lang.String value)

evaluateThresholdParameter

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.

getFindBugsVersion

protected java.lang.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()
Specified by:
getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)
Specified by:
setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public java.lang.Object invokeMethod(java.lang.String name,
                                     java.lang.Object args)
Specified by:
invokeMethod in interface groovy.lang.GroovyObject

getProperty

public java.lang.Object getProperty(java.lang.String name)
Specified by:
getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Specified by:
setProperty in interface groovy.lang.GroovyObject


Copyright © 2005-2011 Codehaus. All Rights Reserved.