A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

append(StringBuilder, String, int) - Method in HelpMojo

Append a description to the buffer by respecting the indentSize and lineLength parameters.

artifactId - Property in PluginArtifact

artifactResolver - Property in FindBugsGui

Artifact resolver, needed to download the coreplugin jar.

artifactResolver - Property in FindBugsMojo

Artifact resolver, needed to download the coreplugin jar.

artifactResolver - Property in FindbugsViolationCheckMojo

Artifact resolver, needed to download the coreplugin jar.

assembleJxrHyperlink(GPathResult) - Method in FindbugsReportGenerator

Assembles the hyperlink to point to the source code.

B

basedir - Property in FindbugsReportGenerator

BLANK - Property in FindBugsInfo

bugClasses - Property in FindbugsReportGenerator

bugClasses - Property in XDocsReporter

bugCount - Property in FindBugsMojo

bugCount - Property in FindbugsReportGenerator

The running total of bugs reported.

bugCount - Property in FindbugsViolationCheckMojo

build() - Method in HelpMojo

bundle - Property in FindBugsGui

Resource bundle for a specific locale.

bundle - Property in FindBugsMojo

bundle - Property in FindbugsReportGenerator

The bundle to get the messages from.

BUNDLE_NAME - Property in FindBugsInfo

The name of the property resource bundle (Filesystem).

bundle - Property in XDocsReporter

The bundle to get the messages from.

C

canGenerateReport() - Method in FindBugsMojo

Checks whether prerequisites for generating this report are given.

CLASS_SUFFIX - Property in FindBugsInfo

classFilesDirectory - Property in FindBugsGui

Directory containing the class files for FindBugs to analyze.

classFilesDirectory - Property in FindBugsMojo

Directory containing the class files for FindBugs to analyze.

classFilesDirectory - Property in FindbugsViolationCheckMojo

Directory containing the class files for FindBugs to analyze.

COLUMN_BUG_KEY - Property in FindbugsReportGenerator

The key to get the column title for the bug.

COLUMN_BUGS_KEY - Property in FindbugsReportGenerator

The key to get the column title for the bugs.

COLUMN_CATEGORY_KEY - Property in FindbugsReportGenerator

The key to get the column title for the category.

COLUMN_CLASS_KEY - Property in FindbugsReportGenerator

The key to column title for the Class.

COLUMN_CLASSES_KEY - Property in FindbugsReportGenerator

The key to column title for the Classes.

COLUMN_DETAILS_KEY - Property in FindbugsReportGenerator

The key to get the column title for the details.

COLUMN_ERRORS_KEY - Property in FindbugsReportGenerator

The key to column title for the errors.

COLUMN_FILES_KEY - Property in FindbugsReportGenerator

The key to column title for the files.

COLUMN_LINE_KEY - Property in FindbugsReportGenerator

The key to get the column title for the line.

COLUMN_MISSINGCLASSES_KEY - Property in FindbugsReportGenerator

The key to column title for the files.

COLUMN_PRIORITY_KEY - Property in FindbugsReportGenerator

The key to get the column title for the priority.

COMMA - Property in FindBugsInfo

compileSourceRoots - Property in FindBugsMojo

The directories containing the sources to be compiled.

compileSourceRoots - Property in FindbugsReportGenerator

The directories containing the sources to be compiled.

compileSourceRoots - Property in FindbugsViolationCheckMojo

The directories containing the sources to be compiled.

compileSourceRoots - Property in XDocsReporter

The directories containing the sources to be compiled.

currentClassName - Property in FindbugsReportGenerator

The name of the current class which is analysed by FindBugs.

D

debug - Property in FindBugsGui

turn on Findbugs debugging

debug - Property in FindBugsMojo

turn on Findbugs debugging

debug - Property in FindbugsViolationCheckMojo

turn on Findbugs debugging

DEFAULT_LINE_LENGTH - Field in HelpMojo

DESCRIPTION_KEY - Property in FindBugsInfo

The key to get the description of the Plug-In from the bundle.

detail - Field in HelpMojo

If true, display all settable properties for each goal.

DETAILSLINK_KEY - Property in FindbugsReportGenerator

The key to get the link to FindBugs description page from the bundle.

doHeading() - Method in FindbugsReportGenerator

Prints the top header sections of the report.

E

effort - Property in FindBugsGui

Effort of the bug finders.

effort - Property in FindBugsMojo

Effort of the bug finders.

effort - Property in FindbugsReportGenerator

The used effort for searching bugs.

effort - Property in FindbugsViolationCheckMojo

Effort of the bug finders.

EFFORT_KEY - Property in FindbugsReportGenerator

The key to get the effort of the report from the bundle.

effort - Property in XDocsReporter

The used effort for searching bugs.

encoding - Property in FindBugsGui

The file encoding to use when reading the source files.

EOL - Property in FindBugsInfo

errorCount - Property in FindBugsMojo

errorCount - Property in FindbugsReportGenerator

The running total of errors reported.

errorCount - Property in FindbugsViolationCheckMojo

evaluateThresholdParameter(String) - Method in XDocsReporter

Returns the threshold string value for the integer input.

excludeBugsFile - Property in FindBugsMojo

excludeBugsFile - Property in FindbugsViolationCheckMojo

excludeFilterFile - Property in FindBugsMojo

excludeFilterFile - Property in FindbugsViolationCheckMojo

execute() - Method in FindBugsGui

execute() - Method in FindBugsMojo

execute() - Method in FindbugsViolationCheckMojo

execute() - Method in HelpMojo

{@inheritDoc}

executeCheck(Locale) - Method in FindBugsMojo

executeFindbugs(File) - Method in FindBugsMojo

Set up and run the Findbugs engine.

executeReport(Locale) - Method in FindBugsMojo

Executes the generation of the report.

F

factory - Property in FindBugsGui

Used to look up Artifacts in the remote repository.

factory - Property in FindBugsMojo

Used to look up Artifacts in the remote repository.

failOnError - Property in FindBugsMojo

Fail the build on an error.

failOnError - Property in FindbugsViolationCheckMojo

Fail the build on an error.

fileCount - Property in FindbugsReportGenerator

The running total of files analyzed.

FILES_KEY - Property in FindbugsReportGenerator

The key to get the files title of the Plug-In from the bundle.

findbugsEfforts - Property in FindBugsInfo

FindBugsGui - Class in org.codehaus.mojo.findbugs

Launch the Findbugs GUI.

FindBugsGui() - Constructor in FindBugsGui

FindBugsInfo - Interface in org.codehaus.mojo.findbugs

Generates a FindBugs Report when the site plugin is run.

FindBugsMojo - Class in org.codehaus.mojo.findbugs

Generates a FindBugs Report when the site plugin is run.

FindBugsMojo() - Constructor in FindBugsMojo

FindBugsPluginsTrait - Trait in org.codehaus.mojo.findbugs

FindBugs plugin support for Mojos.

findbugsPriority - Property in FindBugsInfo

FindbugsReportGenerator - Class in org.codehaus.mojo.findbugs

The reporter controls the generation of the FindBugs report.

FindbugsReportGenerator(Sink, ResourceBundle, File, SiteTool) - Constructor in FindbugsReportGenerator

Default constructor.

findbugsResults - Property in FindbugsReportGenerator

findbugsResults - Property in XDocsReporter

findbugsThresholds - Property in FindBugsInfo

FindbugsViolationCheckMojo - Class in org.codehaus.mojo.findbugs

Fail the build if there were any FindBugs violations in the source code.

FindbugsViolationCheckMojo() - Constructor in FindbugsViolationCheckMojo

findbugsXmlOutput - Property in FindBugsMojo

This has been deprecated and is on by default.

findbugsXmlOutput - Property in FindbugsViolationCheckMojo

Location where generated html will be created.

findbugsXmlOutputDirectory - Property in FindBugsGui

Specifies the directory where the findbugs native xml output will be generated.

findbugsXmlOutputDirectory - Property in FindBugsMojo

Specifies the directory where the findbugs native xml output will be generated.

findbugsXmlOutputDirectory - Property in FindbugsViolationCheckMojo

Specifies the directory where the findbugs native xml output will be generated.

findNamedChild(Node, String) - Method in HelpMojo

findSingleChild(Node, String) - Method in HelpMojo

fork - Property in FindBugsMojo

Fork a VM for FindBugs analysis.

fork - Property in FindbugsViolationCheckMojo

Fork a VM for FindBugs analysis.

FORWARD_SLASH - Property in FindBugsInfo

G

generateReport() - Method in FindbugsReportGenerator

Class Summary

generateReport() - Method in XDocsReporter

generateXDoc(Locale) - Method in FindBugsMojo

getArtifactResolver() - Method in FindBugsPluginsTrait

getBundle(def) - Method in FindBugsMojo

getDescription(Locale) - Method in FindBugsMojo

Returns the plugins description for the "generated reports" overview page.

getEffortParameter() - Method in FindBugsPluginsTrait

Returns the effort parameter to use.

getFactory() - Method in FindBugsPluginsTrait

getFindbugsArgs(File) - Method in FindBugsMojo

Get the Findbugs command line arguments.

getFindbugsAuxClasspath() - Method in FindBugsMojo

Get the Findbugs AuxClasspath.

getFindbugsPlugins() - Method in FindBugsPluginsTrait

Adds the specified plugins to findbugs.

getFindBugsVersion() - Method in XDocsReporter

Gets the Findbugs Version of the report.

getFindbugsXmlOutputDirectory() - Method in FindBugsPluginsTrait

getIndentLevel(String) - Method in HelpMojo

Gets the indentation level of the specified line.

getJavaSources(Locale) - Method in FindBugsMojo

Collects the java sources from the source roots.

getLocalRepository() - Method in FindBugsPluginsTrait

getLog() - Method in FindBugsPluginsTrait

getName(Locale) - Method in FindBugsMojo

Returns the plugins name for the "generated reports" overview page and the menu.

getOutputDirectory() - Method in FindBugsMojo

Returns the report output directory.

getOutputName() - Method in FindBugsMojo

Returns report output file name, without the extension.

getPluginList() - Method in FindBugsPluginsTrait

getPlugins() - Method in FindBugsPluginsTrait

getProject() - Method in FindBugsMojo

Return the project.

getPropertyFromExpression(String) - Method in HelpMojo

getRemoteRepositories() - Method in FindBugsPluginsTrait

getReportTitle() - Method in FindbugsReportGenerator

Gets the report title.

getResourceAsFile(String, String) - Method in ResourceHelper

getResourceFile(String) - Method in ResourceHelper

Get the File reference for a File passed in as a string reference.

getResourceManager() - Method in FindBugsPluginsTrait

getSingleChild(Node, String) - Method in HelpMojo

getSiteRenderer() - Method in FindBugsMojo

Return the Site Renderer.

getThresholdParameter() - Method in FindBugsMojo

Returns the threshold parameter to use.

getValue(Node, String) - Method in HelpMojo

goal - Field in HelpMojo

The name of the goal for which to show help.

groupId - Property in PluginArtifact

H

HelpMojo - Class in org.codehaus.mojo.findbugs

Display help information on findbugs-maven-plugin.

HelpMojo() - Constructor in HelpMojo

I

includeFilterFile - Property in FindBugsMojo

includeFilterFile - Property in FindbugsViolationCheckMojo

includeTests - Property in FindBugsMojo

Run Findbugs on the tests.

includeTests - Property in FindbugsReportGenerator

Run Findbugs on the tests.

includeTests - Property in FindbugsViolationCheckMojo

Run Findbugs on the tests.

indentSize - Field in HelpMojo

The number of spaces per indentation level, should be positive.

isJxrPluginEnabled() - Method in FindBugsMojo

Determines if the JXR-Plugin is included in the report section of the POM.

isJXRReportEnabled - Property in FindbugsReportGenerator

Signals if the jxr report plugin is enabled.

isNotEmpty(String) - Method in HelpMojo

J

JAVA_REGEX_PATTERN - Property in FindBugsInfo

The regex pattern to search for java class files.

JAVA_SOURCES_KEY - Property in FindBugsInfo

The key to get the java source message of the Plug-In from the bundle.

jvmArgs - Property in FindBugsMojo

jvmArgs - Property in FindbugsViolationCheckMojo

K

L

lineLength - Field in HelpMojo

The maximum length of a display line, should be positive.

LINK_KEY - Property in FindbugsReportGenerator

The key to get the report link of the Plug-In from the bundle.

LINKTITLE_KEY - Property in FindbugsReportGenerator

The key to get the report link title of the Plug-In from the bundle.

locale - Property in FindBugsGui

locale to use for Resource bundle.

localRepository - Property in FindBugsGui

The local repository, needed to download the coreplugin jar.

localRepository - Property in FindBugsMojo

The local repository, needed to download the coreplugin jar.

localRepository - Property in FindbugsViolationCheckMojo

The local repository, needed to download the coreplugin jar.

log - Property in FindbugsReportGenerator

The logger to write logs to.

log - Property in ResourceHelper

log - Property in XDocsReporter

The logger to write logs to.

M

maxHeap - Property in FindBugsGui

Maximum Java heap size in megabytes (default=512).

maxHeap - Property in FindBugsMojo

Maximum Java heap size in megabytes (default=512).

maxHeap - Property in FindbugsViolationCheckMojo

Maximum Java heap size in megabytes (default=512).

maxRank - Property in FindBugsMojo

Maximum bug ranking to record.

maxRank - Property in FindbugsViolationCheckMojo

Maximum bug ranking to record.

mIsCurrentClassReportOpened - Property in FindbugsReportGenerator

Signals if the report for the current class is opened.

missingClassCount - Property in FindbugsReportGenerator

The running total of missing classes reported.

missingClassSet - Property in FindbugsReportGenerator

The Set of missing classes names reported.

N

NAME_KEY - Property in FindBugsInfo

The key to get the name of the Plug-In from the bundle.

nested - Property in FindBugsMojo

This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.

nested - Property in FindbugsViolationCheckMojo

This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.

NOLINE_KEY - Property in FindbugsReportGenerator

The key to get the value if the line number is not available.

NOLINE_KEY - Property in XDocsReporter

The key to get the value if the line number is not available.

O

omitVisitors - Property in FindBugsMojo

The visitor list to omit.

omitVisitors - Property in FindbugsViolationCheckMojo

The visitor list to omit.

onlyAnalyze - Property in FindBugsMojo

Restrict analysis to the given comma-separated list of classes and packages.

onlyAnalyze - Property in FindbugsViolationCheckMojo

Restrict analysis to the given comma-separated list of classes and packages.

openClassReportSection(String) - Method in FindbugsReportGenerator

Initialised a bug report section in the report for a particular class.

outputDirectory - Property in FindBugsMojo

Location where generated html will be created.

outputDirectory - Property in FindbugsReportGenerator

Location where generated html will be created.

outputDirectory - Property in FindbugsViolationCheckMojo

Location where generated html will be created.

outputDirectory - Property in ResourceHelper

outputEncoding - Property in FindBugsMojo

The file encoding to use when creating the HTML reports.

outputEncoding - Property in FindbugsViolationCheckMojo

The file encoding to use when creating the HTML reports.

outputEncoding - Property in XDocsReporter

outputFindbugsFile - Property in FindBugsMojo

outputWriter - Property in XDocsReporter

The output Writer stream.

P

PERIOD - Property in FindBugsInfo

PLUGIN_HELP_PATH - Field in HelpMojo

PLUGIN_NAME - Property in FindBugsInfo

The name of the Plug-In.

PluginArtifact - Class in org.codehaus.mojo.findbugs

PluginArtifact() - Constructor in PluginArtifact

pluginArtifacts - Property in FindBugsGui

List of artifacts this plugin depends on.

pluginArtifacts - Property in FindBugsMojo

List of artifacts this plugin depends on.

pluginArtifacts - Property in FindbugsViolationCheckMojo

List of artifacts this plugin depends on.

pluginList - Property in FindBugsGui

The plugin list to include in the report.

pluginList - Property in FindBugsMojo

pluginList - Property in FindbugsViolationCheckMojo

plugins - Property in FindBugsGui

plugins - Property in FindBugsMojo

printBody() - Method in FindbugsReportGenerator

@see edu.umd.cs.findbugs.BugReporter#finish()

printBug(String) - Method in FindbugsReportGenerator

Print the bug collection to a line in the table

printFilesSummary() - Method in FindbugsReportGenerator

Print the File Summary Section.

printSummary() - Method in FindbugsReportGenerator

Print the Summary Section.

project - Property in FindBugsGui

Maven Project

project - Property in FindBugsMojo

Maven Project

project - Property in FindbugsViolationCheckMojo

Maven Project

Q

R

relaxed - Property in FindBugsMojo

Relaxed reporting mode.

relaxed - Property in FindbugsViolationCheckMojo

Relaxed reporting mode.

remoteArtifactRepositories - Property in FindBugsMojo

Remote repositories which will be searched for the coreplugin jar.

remoteArtifactRepositories - Property in FindbugsViolationCheckMojo

Remote repositories which will be searched for the coreplugin jar.

remoteRepositories - Property in FindBugsGui

List of Remote Repositories used by the resolver

remoteRepositories - Property in FindBugsMojo

List of Remote Repositories used by the resolver

repeat(String, int) - Method in HelpMojo

REPORT_TITLE_KEY - Property in FindbugsReportGenerator

The key to get the report title of the Plug-In from the bundle.

ResourceHelper - Class in org.codehaus.mojo.findbugs

ResourceHelper(Log, File, ResourceManager) - Constructor in ResourceHelper

resourceManager - Property in FindBugsGui

@since 2.0

resourceManager - Property in FindBugsMojo

@since 2.0

resourceManager - Property in FindbugsViolationCheckMojo

@since 2.0

resourceManager - Property in ResourceHelper

S

setReportOutputDirectory(File) - Method in FindBugsMojo

@see org.apache.maven.reporting.AbstractMavenReport#setReportOutputDirectory(java.io.File)

sink - Property in FindbugsReportGenerator

The sink to write the report to.

siteRenderer - Property in FindBugsMojo

Doxia Site Renderer.

siteRenderer - Property in FindbugsViolationCheckMojo

Doxia Site Renderer.

siteTool - Property in FindBugsMojo

SiteTool.

siteTool - Property in FindbugsReportGenerator

"org.apache.maven.doxia.tools.SiteTool"

siteTool - Property in FindbugsViolationCheckMojo

SiteTool.

skip - Property in FindBugsMojo

Skip entire check.

skip - Property in FindbugsViolationCheckMojo

Skip entire check.

skipEmptyReport - Property in FindBugsMojo

Skip the FindBugs HTML report generation if there are no violations found.

SOURCE_ROOT_KEY - Property in FindBugsInfo

The key to get the source directory message of the Plug-In from the bundle.

sourceEncoding - Property in FindBugsMojo

The file encoding to use when reading the source files.

sourceEncoding - Property in FindbugsViolationCheckMojo

The file encoding to use when reading the source files.

SUMMARY_KEY - Property in FindbugsReportGenerator

The key to get the files title of the Plug-In from the bundle.

T

TEST_SOURCE_ROOT_KEY - Property in FindBugsInfo

The key to get the source directory message of the Plug-In from the bundle.

testClassFilesDirectory - Property in FindBugsMojo

Directory containing the test class files for FindBugs to analyze.

testClassFilesDirectory - Property in FindbugsViolationCheckMojo

Directory containing the test class files for FindBugs to analyze.

testSourceRoots - Property in FindBugsMojo

The directories containing the test-sources to be compiled.

testSourceRoots - Property in FindbugsReportGenerator

The directories containing the test-sources to be compiled.

testSourceRoots - Property in FindbugsViolationCheckMojo

The directories containing the test-sources to be compiled.

testSourceRoots - Property in XDocsReporter

threshold - Property in FindBugsMojo

Threshold of minimum bug severity to report.

threshold - Property in FindbugsReportGenerator

The threshold of bugs severity.

threshold - Property in FindbugsViolationCheckMojo

Threshold of minimum bug severity to report.

THRESHOLD_KEY - Property in FindbugsReportGenerator

The key to get the threshold of the report from the bundle.

threshold - Property in XDocsReporter

The threshold of bugs severity.

timeout - Property in FindBugsMojo

Specifies the amount of time, in milliseconds, that FindBugs may run before it is assumed to be hung and is terminated.

timeout - Property in FindbugsViolationCheckMojo

Specifies the amount of time, in milliseconds, that FindBugs may run before it is assumed to be hung and is terminated.

toLines(List<String>, String, int, int) - Method in HelpMojo

Adds the specified line to the output sequence, performing line wrapping if necessary.

trace - Property in FindBugsMojo

Prints a trace of detectors run and classes analyzed to standard output.

trace - Property in FindbugsViolationCheckMojo

Prints a trace of detectors run and classes analyzed to standard output.

type - Property in PluginArtifact

U

URL - Field in FindBugsInfo

URL_SEPARATOR - Property in FindBugsInfo

The character to separate URL tokens.

userPrefs - Property in FindBugsMojo

Set the path of the user preferences file to use.

V

valueForLine(GPathResult) - Method in FindbugsReportGenerator

Return the value to display.

version - Property in PluginArtifact

VERSIONTITLE_KEY - Property in FindbugsReportGenerator

The key to get the version title for FindBugs from the bundle.

visitors - Property in FindBugsMojo

The visitor list to run.

visitors - Property in FindbugsViolationCheckMojo

The visitor list to run.

W

writeGoal(StringBuilder, String, Element) - Method in HelpMojo

writeParameter(StringBuilder, Node, Node) - Method in HelpMojo

X

XDocsReporter - Class in org.codehaus.mojo.findbugs

The reporter controls the generation of the FindBugs report.

XDocsReporter(ResourceBundle, Log, String, String, String) - Constructor in XDocsReporter

Default constructor.

xmlEncoding - Property in FindBugsMojo

Encoding used for xml files.

xmlEncoding - Property in FindbugsViolationCheckMojo

Encoding used for xml files.

xmlOutput - Property in FindBugsMojo

Turn on and off xml output of the Findbugs report.

xmlOutput - Property in FindbugsViolationCheckMojo

Turn on and off xml output of the Findbugs report.

xmlOutputDirectory - Property in FindBugsMojo

Specifies the directory where the xml output will be generated.

xmlOutputDirectory - Property in FindbugsViolationCheckMojo

Specifies the directory where the xml output will be generated.

xrefLocation - Property in FindBugsMojo

Location of the Xrefs to link to.

xrefLocation - Property in FindbugsReportGenerator

Location of the Xrefs to link to.

xrefLocation - Property in FindbugsViolationCheckMojo

Location of the Xrefs to link to.

xrefTestLocation - Property in FindBugsMojo

Location of the Test Xrefs to link to.

xrefTestLocation - Property in FindbugsReportGenerator

Location of the Test Xrefs to link to.

xrefTestLocation - Property in FindbugsViolationCheckMojo

Location of the Test Xrefs to link to.

Y

Z

_