<html><head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>FindBugs™ Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="next" href="introduction.html" title="Chapter 1. Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="application">FindBugs</span>™ Manual</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="introduction.html">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="findbugs-manual"></a><span class="application">FindBugs</span>™ Manual</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">David</span> <span class="othername">H.</span> <span class="surname">Hovemeyer</span></h3></div><div class="author"><h3 class="author"><span class="firstname">William</span> <span class="othername">W.</span> <span class="surname">Pugh</span></h3></div></div></div><div><p class="copyright">Copyright © 2003, 2004, 2005, 2006 University of Maryland</p></div><div><div class="legalnotice"><a name="d0e33"></a><p> This manual is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License. To view a copy of this license, visit <a href="http://creativecommons.org/licenses/by-nc-sa/1.0/" target="_top">http://creativecommons.org/licenses/by-nc-sa/1.0/</a> or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. </p><p> The name FindBugs and the FindBugs logo is trademarked by the University of Maryland. </p></div></div><div><p class="pubdate">10:24:29 EDT, 31 May, 2007</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="introduction.html">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="introduction.html#d0e73">1. Requirements</a></span></dt></dl></dd><dt><span class="chapter"><a href="installing.html">2. Installing and Running <span class="application">FindBugs</span>™</a></span></dt><dd><dl><dt><span class="sect1"><a href="installing.html#d0e104">1. Extracting the Distribution</a></span></dt><dt><span class="sect1"><a href="installing.html#d0e158">2. Configuration</a></span></dt><dt><span class="sect1"><a href="installing.html#commandLineOptions">3. Command Line Options</a></span></dt></dl></dd><dt><span class="chapter"><a href="building.html">3. Building <span class="application">FindBugs</span>™ from Source</a></span></dt><dd><dl><dt><span class="sect1"><a href="building.html#d0e582">1. Prerequisites</a></span></dt><dt><span class="sect1"><a href="building.html#d0e674">2. Extracting the Source Distribution</a></span></dt><dt><span class="sect1"><a href="building.html#d0e687">3. Modifying <code class="filename">build.properties</code></a></span></dt><dt><span class="sect1"><a href="building.html#d0e739">4. Running <span class="application">Ant</span></a></span></dt><dt><span class="sect1"><a href="building.html#d0e833">5. Running <span class="application">FindBugs</span>™</a></span></dt></dl></dd><dt><span class="chapter"><a href="gui.html">4. Using the <span class="application">FindBugs</span>™ Graphical User Interface</a></span></dt><dd><dl><dt><span class="sect1"><a href="gui.html#d0e868">1. Creating a Project</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e910">2. Running the Analysis</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e915">3. Browsing Results</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e944">4. Loading and saving results</a></span></dt></dl></dd><dt><span class="chapter"><a href="textui.html">5. Using the <span class="application">FindBugs</span>™ Command Line Interface</a></span></dt><dt><span class="chapter"><a href="anttask.html">6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</a></span></dt><dd><dl><dt><span class="sect1"><a href="anttask.html#d0e1022">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1060">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1131">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1156">4. Parameters</a></span></dt></dl></dd><dt><span class="chapter"><a href="eclipse.html">7. Using the <span class="application">FindBugs</span>™ Eclipse plugin</a></span></dt><dd><dl><dt><span class="sect1"><a href="eclipse.html#d0e1458">1. Requirements</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1466">2. Installation</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1513">3. Using the Plugin</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1536">4. Troubleshooting</a></span></dt></dl></dd><dt><span class="chapter"><a href="filter.html">8. Filter Files</a></span></dt><dd><dl><dt><span class="sect1"><a href="filter.html#d0e1566">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1616">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1809">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1834">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1864">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1917">6. Complete Example</a></span></dt></dl></dd><dt><span class="chapter"><a href="analysisprops.html">9. Analysis Properties</a></span></dt><dt><span class="chapter"><a href="annotations.html">10. Annotations</a></span></dt><dt><span class="chapter"><a href="datamining.html">11. Data mining of bugs with <span class="application">FindBugs</span>™</a></span></dt><dd><dl><dt><span class="sect1"><a href="datamining.html#commands">1. Commands</a></span></dt><dt><span class="sect1"><a href="datamining.html#examples">2. Examples</a></span></dt><dt><span class="sect1"><a href="datamining.html#antexemple">3. Ant exemple</a></span></dt></dl></dd><dt><span class="chapter"><a href="license.html">12. License</a></span></dt><dt><span class="chapter"><a href="acknowledgments.html">13. Acknowledgments</a></span></dt><dd><dl><dt><span class="sect1"><a href="acknowledgments.html#d0e2992">1. Contributors</a></span></dt><dt><span class="sect1"><a href="acknowledgments.html#d0e3115">2. Software Used</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>9.1. <a href="analysisprops.html#analysisproptable">Configurable Analysis Properties</a></dt><dt>11.1. <a href="datamining.html#filterOptionsTable">Options for filterBugs command</a></dt><dt>11.2. <a href="datamining.html#mineBugHistoryColumns">Columns in mineBugHistory output</a></dt><dt>11.3. <a href="datamining.html#defectDensityColumns">Columns in defectDensity output</a></dt><dt>11.4. <a href="datamining.html#setBugDatabaseInfoOptions">setBugDatabaseInfo Options</a></dt><dt>11.5. <a href="datamining.html#listBugDatabaseInfoColumns">listBugDatabaseInfo Columns</a></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="introduction.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html>