<property name="project.version" value="1.0.0" />\r
<property name="project.author" value="u6k.yu1@gmail.com" />\r
<taskdef name="launch4j" classname="net.sf.launch4j.ant.Launch4jTask" classpath="src/main/lib/launch4j-2.1.5-win32/launch4j.jar;src/main/lib/launch4j-2.1.5-win32/lib/xstream.jar" />\r
+ <taskdef resource="checkstyletask.properties" classpath="src/build/lib/checkstyle/checkstyle-all-4.3.jar" />\r
+ <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" classpath="src/build/lib/findbugs/lib/findbugs-ant.jar" />\r
<target name="init">\r
<delete dir="target" />\r
<tstamp />\r
<fileset dir="src/main/java" />\r
</javadoc>\r
</target>\r
- <target name="site" depends="init">\r
+ <target name="checkstyle" depends="init">\r
+ <mkdir dir="target/checkstyle" />\r
+ <checkstyle config="u6k-checkstyle-20070929.xml">\r
+ <fileset dir="src/main/java" includes="**/*.java" />\r
+ <formatter type="xml" toFile="target/checkstyle/checkstyle-report.xml" />\r
+ </checkstyle>\r
+ <style in="target/checkstyle/checkstyle-report.xml" out="target/checkstyle/checkstyle-report.html" style="src/build/lib/checkstyle/checkstyle-author.xsl" />\r
+ </target>\r
+ <target name="findbugs" depends="package">\r
+ <mkdir dir="target/findbugs" />\r
+ <findbugs home="src/build/lib/findbugs" output="xml" outputFile="target/findbugs/findbugs-report.xml" jvmargs="-Xms512M -Xmx512M">\r
+ <sourcePath>\r
+ <fileset dir="src/main/java" id="**/*.java" />
+ </sourcePath>\r
+ <class location="target/filelock-${project.version}.jar" />\r
+ </findbugs>\r
+ <style in="target/findbugs/findbugs-report.xml" out="target/findbugs/findbugs-report.html" style="src/build/lib/findbugs/src/xsl/default.xsl" />\r
+ </target>\r
+ <target name="site" depends="init,checkstyle,findbugs">\r
<mkdir dir="target/site" />\r
<!-- TODO -->\r
</target>\r
--- /dev/null
+ GNU LESSER GENERAL PUBLIC LICENSE\r
+ Version 2.1, February 1999\r
+\r
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.\r
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r
+ Everyone is permitted to copy and distribute verbatim copies\r
+ of this license document, but changing it is not allowed.\r
+\r
+[This is the first released version of the Lesser GPL. It also counts\r
+ as the successor of the GNU Library Public License, version 2, hence\r
+ the version number 2.1.]\r
+\r
+ Preamble\r
+\r
+ The licenses for most software are designed to take away your\r
+freedom to share and change it. By contrast, the GNU General Public\r
+Licenses are intended to guarantee your freedom to share and change\r
+free software--to make sure the software is free for all its users.\r
+\r
+ This license, the Lesser General Public License, applies to some\r
+specially designated software packages--typically libraries--of the\r
+Free Software Foundation and other authors who decide to use it. You\r
+can use it too, but we suggest you first think carefully about whether\r
+this license or the ordinary General Public License is the better\r
+strategy to use in any particular case, based on the explanations below.\r
+\r
+ When we speak of free software, we are referring to freedom of use,\r
+not price. Our General Public Licenses are designed to make sure that\r
+you have the freedom to distribute copies of free software (and charge\r
+for this service if you wish); that you receive source code or can get\r
+it if you want it; that you can change the software and use pieces of\r
+it in new free programs; and that you are informed that you can do\r
+these things.\r
+\r
+ To protect your rights, we need to make restrictions that forbid\r
+distributors to deny you these rights or to ask you to surrender these\r
+rights. These restrictions translate to certain responsibilities for\r
+you if you distribute copies of the library or if you modify it.\r
+\r
+ For example, if you distribute copies of the library, whether gratis\r
+or for a fee, you must give the recipients all the rights that we gave\r
+you. You must make sure that they, too, receive or can get the source\r
+code. If you link other code with the library, you must provide\r
+complete object files to the recipients, so that they can relink them\r
+with the library after making changes to the library and recompiling\r
+it. And you must show them these terms so they know their rights.\r
+\r
+ We protect your rights with a two-step method: (1) we copyright the\r
+library, and (2) we offer you this license, which gives you legal\r
+permission to copy, distribute and/or modify the library.\r
+\r
+ To protect each distributor, we want to make it very clear that\r
+there is no warranty for the free library. Also, if the library is\r
+modified by someone else and passed on, the recipients should know\r
+that what they have is not the original version, so that the original\r
+author's reputation will not be affected by problems that might be\r
+introduced by others.\r
+\f\r
+ Finally, software patents pose a constant threat to the existence of\r
+any free program. We wish to make sure that a company cannot\r
+effectively restrict the users of a free program by obtaining a\r
+restrictive license from a patent holder. Therefore, we insist that\r
+any patent license obtained for a version of the library must be\r
+consistent with the full freedom of use specified in this license.\r
+\r
+ Most GNU software, including some libraries, is covered by the\r
+ordinary GNU General Public License. This license, the GNU Lesser\r
+General Public License, applies to certain designated libraries, and\r
+is quite different from the ordinary General Public License. We use\r
+this license for certain libraries in order to permit linking those\r
+libraries into non-free programs.\r
+\r
+ When a program is linked with a library, whether statically or using\r
+a shared library, the combination of the two is legally speaking a\r
+combined work, a derivative of the original library. The ordinary\r
+General Public License therefore permits such linking only if the\r
+entire combination fits its criteria of freedom. The Lesser General\r
+Public License permits more lax criteria for linking other code with\r
+the library.\r
+\r
+ We call this license the "Lesser" General Public License because it\r
+does Less to protect the user's freedom than the ordinary General\r
+Public License. It also provides other free software developers Less\r
+of an advantage over competing non-free programs. These disadvantages\r
+are the reason we use the ordinary General Public License for many\r
+libraries. However, the Lesser license provides advantages in certain\r
+special circumstances.\r
+\r
+ For example, on rare occasions, there may be a special need to\r
+encourage the widest possible use of a certain library, so that it becomes\r
+a de-facto standard. To achieve this, non-free programs must be\r
+allowed to use the library. A more frequent case is that a free\r
+library does the same job as widely used non-free libraries. In this\r
+case, there is little to gain by limiting the free library to free\r
+software only, so we use the Lesser General Public License.\r
+\r
+ In other cases, permission to use a particular library in non-free\r
+programs enables a greater number of people to use a large body of\r
+free software. For example, permission to use the GNU C Library in\r
+non-free programs enables many more people to use the whole GNU\r
+operating system, as well as its variant, the GNU/Linux operating\r
+system.\r
+\r
+ Although the Lesser General Public License is Less protective of the\r
+users' freedom, it does ensure that the user of a program that is\r
+linked with the Library has the freedom and the wherewithal to run\r
+that program using a modified version of the Library.\r
+\r
+ The precise terms and conditions for copying, distribution and\r
+modification follow. Pay close attention to the difference between a\r
+"work based on the library" and a "work that uses the library". The\r
+former contains code derived from the library, whereas the latter must\r
+be combined with the library in order to run.\r
+\f\r
+ GNU LESSER GENERAL PUBLIC LICENSE\r
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\r
+\r
+ 0. This License Agreement applies to any software library or other\r
+program which contains a notice placed by the copyright holder or\r
+other authorized party saying it may be distributed under the terms of\r
+this Lesser General Public License (also called "this License").\r
+Each licensee is addressed as "you".\r
+\r
+ A "library" means a collection of software functions and/or data\r
+prepared so as to be conveniently linked with application programs\r
+(which use some of those functions and data) to form executables.\r
+\r
+ The "Library", below, refers to any such software library or work\r
+which has been distributed under these terms. A "work based on the\r
+Library" means either the Library or any derivative work under\r
+copyright law: that is to say, a work containing the Library or a\r
+portion of it, either verbatim or with modifications and/or translated\r
+straightforwardly into another language. (Hereinafter, translation is\r
+included without limitation in the term "modification".)\r
+\r
+ "Source code" for a work means the preferred form of the work for\r
+making modifications to it. For a library, complete source code means\r
+all the source code for all modules it contains, plus any associated\r
+interface definition files, plus the scripts used to control compilation\r
+and installation of the library.\r
+\r
+ Activities other than copying, distribution and modification are not\r
+covered by this License; they are outside its scope. The act of\r
+running a program using the Library is not restricted, and output from\r
+such a program is covered only if its contents constitute a work based\r
+on the Library (independent of the use of the Library in a tool for\r
+writing it). Whether that is true depends on what the Library does\r
+and what the program that uses the Library does.\r
+ \r
+ 1. You may copy and distribute verbatim copies of the Library's\r
+complete source code as you receive it, in any medium, provided that\r
+you conspicuously and appropriately publish on each copy an\r
+appropriate copyright notice and disclaimer of warranty; keep intact\r
+all the notices that refer to this License and to the absence of any\r
+warranty; and distribute a copy of this License along with the\r
+Library.\r
+\r
+ You may charge a fee for the physical act of transferring a copy,\r
+and you may at your option offer warranty protection in exchange for a\r
+fee.\r
+\f\r
+ 2. You may modify your copy or copies of the Library or any portion\r
+of it, thus forming a work based on the Library, and copy and\r
+distribute such modifications or work under the terms of Section 1\r
+above, provided that you also meet all of these conditions:\r
+\r
+ a) The modified work must itself be a software library.\r
+\r
+ b) You must cause the files modified to carry prominent notices\r
+ stating that you changed the files and the date of any change.\r
+\r
+ c) You must cause the whole of the work to be licensed at no\r
+ charge to all third parties under the terms of this License.\r
+\r
+ d) If a facility in the modified Library refers to a function or a\r
+ table of data to be supplied by an application program that uses\r
+ the facility, other than as an argument passed when the facility\r
+ is invoked, then you must make a good faith effort to ensure that,\r
+ in the event an application does not supply such function or\r
+ table, the facility still operates, and performs whatever part of\r
+ its purpose remains meaningful.\r
+\r
+ (For example, a function in a library to compute square roots has\r
+ a purpose that is entirely well-defined independent of the\r
+ application. Therefore, Subsection 2d requires that any\r
+ application-supplied function or table used by this function must\r
+ be optional: if the application does not supply it, the square\r
+ root function must still compute square roots.)\r
+\r
+These requirements apply to the modified work as a whole. If\r
+identifiable sections of that work are not derived from the Library,\r
+and can be reasonably considered independent and separate works in\r
+themselves, then this License, and its terms, do not apply to those\r
+sections when you distribute them as separate works. But when you\r
+distribute the same sections as part of a whole which is a work based\r
+on the Library, the distribution of the whole must be on the terms of\r
+this License, whose permissions for other licensees extend to the\r
+entire whole, and thus to each and every part regardless of who wrote\r
+it.\r
+\r
+Thus, it is not the intent of this section to claim rights or contest\r
+your rights to work written entirely by you; rather, the intent is to\r
+exercise the right to control the distribution of derivative or\r
+collective works based on the Library.\r
+\r
+In addition, mere aggregation of another work not based on the Library\r
+with the Library (or with a work based on the Library) on a volume of\r
+a storage or distribution medium does not bring the other work under\r
+the scope of this License.\r
+\r
+ 3. You may opt to apply the terms of the ordinary GNU General Public\r
+License instead of this License to a given copy of the Library. To do\r
+this, you must alter all the notices that refer to this License, so\r
+that they refer to the ordinary GNU General Public License, version 2,\r
+instead of to this License. (If a newer version than version 2 of the\r
+ordinary GNU General Public License has appeared, then you can specify\r
+that version instead if you wish.) Do not make any other change in\r
+these notices.\r
+\f\r
+ Once this change is made in a given copy, it is irreversible for\r
+that copy, so the ordinary GNU General Public License applies to all\r
+subsequent copies and derivative works made from that copy.\r
+\r
+ This option is useful when you wish to copy part of the code of\r
+the Library into a program that is not a library.\r
+\r
+ 4. You may copy and distribute the Library (or a portion or\r
+derivative of it, under Section 2) in object code or executable form\r
+under the terms of Sections 1 and 2 above provided that you accompany\r
+it with the complete corresponding machine-readable source code, which\r
+must be distributed under the terms of Sections 1 and 2 above on a\r
+medium customarily used for software interchange.\r
+\r
+ If distribution of object code is made by offering access to copy\r
+from a designated place, then offering equivalent access to copy the\r
+source code from the same place satisfies the requirement to\r
+distribute the source code, even though third parties are not\r
+compelled to copy the source along with the object code.\r
+\r
+ 5. A program that contains no derivative of any portion of the\r
+Library, but is designed to work with the Library by being compiled or\r
+linked with it, is called a "work that uses the Library". Such a\r
+work, in isolation, is not a derivative work of the Library, and\r
+therefore falls outside the scope of this License.\r
+\r
+ However, linking a "work that uses the Library" with the Library\r
+creates an executable that is a derivative of the Library (because it\r
+contains portions of the Library), rather than a "work that uses the\r
+library". The executable is therefore covered by this License.\r
+Section 6 states terms for distribution of such executables.\r
+\r
+ When a "work that uses the Library" uses material from a header file\r
+that is part of the Library, the object code for the work may be a\r
+derivative work of the Library even though the source code is not.\r
+Whether this is true is especially significant if the work can be\r
+linked without the Library, or if the work is itself a library. The\r
+threshold for this to be true is not precisely defined by law.\r
+\r
+ If such an object file uses only numerical parameters, data\r
+structure layouts and accessors, and small macros and small inline\r
+functions (ten lines or less in length), then the use of the object\r
+file is unrestricted, regardless of whether it is legally a derivative\r
+work. (Executables containing this object code plus portions of the\r
+Library will still fall under Section 6.)\r
+\r
+ Otherwise, if the work is a derivative of the Library, you may\r
+distribute the object code for the work under the terms of Section 6.\r
+Any executables containing that work also fall under Section 6,\r
+whether or not they are linked directly with the Library itself.\r
+\f\r
+ 6. As an exception to the Sections above, you may also combine or\r
+link a "work that uses the Library" with the Library to produce a\r
+work containing portions of the Library, and distribute that work\r
+under terms of your choice, provided that the terms permit\r
+modification of the work for the customer's own use and reverse\r
+engineering for debugging such modifications.\r
+\r
+ You must give prominent notice with each copy of the work that the\r
+Library is used in it and that the Library and its use are covered by\r
+this License. You must supply a copy of this License. If the work\r
+during execution displays copyright notices, you must include the\r
+copyright notice for the Library among them, as well as a reference\r
+directing the user to the copy of this License. Also, you must do one\r
+of these things:\r
+\r
+ a) Accompany the work with the complete corresponding\r
+ machine-readable source code for the Library including whatever\r
+ changes were used in the work (which must be distributed under\r
+ Sections 1 and 2 above); and, if the work is an executable linked\r
+ with the Library, with the complete machine-readable "work that\r
+ uses the Library", as object code and/or source code, so that the\r
+ user can modify the Library and then relink to produce a modified\r
+ executable containing the modified Library. (It is understood\r
+ that the user who changes the contents of definitions files in the\r
+ Library will not necessarily be able to recompile the application\r
+ to use the modified definitions.)\r
+\r
+ b) Use a suitable shared library mechanism for linking with the\r
+ Library. A suitable mechanism is one that (1) uses at run time a\r
+ copy of the library already present on the user's computer system,\r
+ rather than copying library functions into the executable, and (2)\r
+ will operate properly with a modified version of the library, if\r
+ the user installs one, as long as the modified version is\r
+ interface-compatible with the version that the work was made with.\r
+\r
+ c) Accompany the work with a written offer, valid for at\r
+ least three years, to give the same user the materials\r
+ specified in Subsection 6a, above, for a charge no more\r
+ than the cost of performing this distribution.\r
+\r
+ d) If distribution of the work is made by offering access to copy\r
+ from a designated place, offer equivalent access to copy the above\r
+ specified materials from the same place.\r
+\r
+ e) Verify that the user has already received a copy of these\r
+ materials or that you have already sent this user a copy.\r
+\r
+ For an executable, the required form of the "work that uses the\r
+Library" must include any data and utility programs needed for\r
+reproducing the executable from it. However, as a special exception,\r
+the materials to be distributed need not include anything that is\r
+normally distributed (in either source or binary form) with the major\r
+components (compiler, kernel, and so on) of the operating system on\r
+which the executable runs, unless that component itself accompanies\r
+the executable.\r
+\r
+ It may happen that this requirement contradicts the license\r
+restrictions of other proprietary libraries that do not normally\r
+accompany the operating system. Such a contradiction means you cannot\r
+use both them and the Library together in an executable that you\r
+distribute.\r
+\f\r
+ 7. You may place library facilities that are a work based on the\r
+Library side-by-side in a single library together with other library\r
+facilities not covered by this License, and distribute such a combined\r
+library, provided that the separate distribution of the work based on\r
+the Library and of the other library facilities is otherwise\r
+permitted, and provided that you do these two things:\r
+\r
+ a) Accompany the combined library with a copy of the same work\r
+ based on the Library, uncombined with any other library\r
+ facilities. This must be distributed under the terms of the\r
+ Sections above.\r
+\r
+ b) Give prominent notice with the combined library of the fact\r
+ that part of it is a work based on the Library, and explaining\r
+ where to find the accompanying uncombined form of the same work.\r
+\r
+ 8. You may not copy, modify, sublicense, link with, or distribute\r
+the Library except as expressly provided under this License. Any\r
+attempt otherwise to copy, modify, sublicense, link with, or\r
+distribute the Library is void, and will automatically terminate your\r
+rights under this License. However, parties who have received copies,\r
+or rights, from you under this License will not have their licenses\r
+terminated so long as such parties remain in full compliance.\r
+\r
+ 9. You are not required to accept this License, since you have not\r
+signed it. However, nothing else grants you permission to modify or\r
+distribute the Library or its derivative works. These actions are\r
+prohibited by law if you do not accept this License. Therefore, by\r
+modifying or distributing the Library (or any work based on the\r
+Library), you indicate your acceptance of this License to do so, and\r
+all its terms and conditions for copying, distributing or modifying\r
+the Library or works based on it.\r
+\r
+ 10. Each time you redistribute the Library (or any work based on the\r
+Library), the recipient automatically receives a license from the\r
+original licensor to copy, distribute, link with or modify the Library\r
+subject to these terms and conditions. You may not impose any further\r
+restrictions on the recipients' exercise of the rights granted herein.\r
+You are not responsible for enforcing compliance by third parties with\r
+this License.\r
+\f\r
+ 11. If, as a consequence of a court judgment or allegation of patent\r
+infringement or for any other reason (not limited to patent issues),\r
+conditions are imposed on you (whether by court order, agreement or\r
+otherwise) that contradict the conditions of this License, they do not\r
+excuse you from the conditions of this License. If you cannot\r
+distribute so as to satisfy simultaneously your obligations under this\r
+License and any other pertinent obligations, then as a consequence you\r
+may not distribute the Library at all. For example, if a patent\r
+license would not permit royalty-free redistribution of the Library by\r
+all those who receive copies directly or indirectly through you, then\r
+the only way you could satisfy both it and this License would be to\r
+refrain entirely from distribution of the Library.\r
+\r
+If any portion of this section is held invalid or unenforceable under any\r
+particular circumstance, the balance of the section is intended to apply,\r
+and the section as a whole is intended to apply in other circumstances.\r
+\r
+It is not the purpose of this section to induce you to infringe any\r
+patents or other property right claims or to contest validity of any\r
+such claims; this section has the sole purpose of protecting the\r
+integrity of the free software distribution system which is\r
+implemented by public license practices. Many people have made\r
+generous contributions to the wide range of software distributed\r
+through that system in reliance on consistent application of that\r
+system; it is up to the author/donor to decide if he or she is willing\r
+to distribute software through any other system and a licensee cannot\r
+impose that choice.\r
+\r
+This section is intended to make thoroughly clear what is believed to\r
+be a consequence of the rest of this License.\r
+\r
+ 12. If the distribution and/or use of the Library is restricted in\r
+certain countries either by patents or by copyrighted interfaces, the\r
+original copyright holder who places the Library under this License may add\r
+an explicit geographical distribution limitation excluding those countries,\r
+so that distribution is permitted only in or among countries not thus\r
+excluded. In such case, this License incorporates the limitation as if\r
+written in the body of this License.\r
+\r
+ 13. The Free Software Foundation may publish revised and/or new\r
+versions of the Lesser General Public License from time to time.\r
+Such new versions will be similar in spirit to the present version,\r
+but may differ in detail to address new problems or concerns.\r
+\r
+Each version is given a distinguishing version number. If the Library\r
+specifies a version number of this License which applies to it and\r
+"any later version", you have the option of following the terms and\r
+conditions either of that version or of any later version published by\r
+the Free Software Foundation. If the Library does not specify a\r
+license version number, you may choose any version ever published by\r
+the Free Software Foundation.\r
+\f\r
+ 14. If you wish to incorporate parts of the Library into other free\r
+programs whose distribution conditions are incompatible with these,\r
+write to the author to ask for permission. For software which is\r
+copyrighted by the Free Software Foundation, write to the Free\r
+Software Foundation; we sometimes make exceptions for this. Our\r
+decision will be guided by the two goals of preserving the free status\r
+of all derivatives of our free software and of promoting the sharing\r
+and reuse of software generally.\r
+\r
+ NO WARRANTY\r
+\r
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO\r
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.\r
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR\r
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY\r
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE\r
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE\r
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME\r
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.\r
+\r
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN\r
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY\r
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU\r
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR\r
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE\r
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING\r
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A\r
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF\r
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH\r
+DAMAGES.\r
+\r
+ END OF TERMS AND CONDITIONS\r
+\f\r
+ How to Apply These Terms to Your New Libraries\r
+\r
+ If you develop a new library, and you want it to be of the greatest\r
+possible use to the public, we recommend making it free software that\r
+everyone can redistribute and change. You can do so by permitting\r
+redistribution under these terms (or, alternatively, under the terms of the\r
+ordinary General Public License).\r
+\r
+ To apply these terms, attach the following notices to the library. It is\r
+safest to attach them to the start of each source file to most effectively\r
+convey the exclusion of warranty; and each file should have at least the\r
+"copyright" line and a pointer to where the full notice is found.\r
+\r
+ <one line to give the library's name and a brief idea of what it does.>\r
+ Copyright (C) <year> <name of author>\r
+\r
+ This library is free software; you can redistribute it and/or\r
+ modify it under the terms of the GNU Lesser General Public\r
+ License as published by the Free Software Foundation; either\r
+ version 2.1 of the License, or (at your option) any later version.\r
+\r
+ This library is distributed in the hope that it will be useful,\r
+ but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
+ Lesser General Public License for more details.\r
+\r
+ You should have received a copy of the GNU Lesser General Public\r
+ License along with this library; if not, write to the Free Software\r
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r
+\r
+Also add information on how to contact you by electronic and paper mail.\r
+\r
+You should also get your employer (if you work as a programmer) or your\r
+school, if any, to sign a "copyright disclaimer" for the library, if\r
+necessary. Here is a sample; alter the names:\r
+\r
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the\r
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.\r
+\r
+ <signature of Ty Coon>, 1 April 1990\r
+ Ty Coon, President of Vice\r
+\r
+That's all there is to it!\r
+\r
+\r
--- /dev/null
+/*\r
+ * $Header: /cvsroot/checkstyle/checkstyle/LICENSE.apache,v 1.2 2002/02/04 12:40:53 oburn Exp $\r
+ * $Revision: 1.2 $\r
+ * $Date: 2002/02/04 12:40:53 $\r
+ *\r
+ * ====================================================================\r
+ *\r
+ * The Apache Software License, Version 1.1\r
+ *\r
+ * Copyright (c) 1999 The Apache Software Foundation. All rights\r
+ * reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ *\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ * notice, this list of conditions and the following disclaimer.\r
+ *\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ * notice, this list of conditions and the following disclaimer in\r
+ * the documentation and/or other materials provided with the\r
+ * distribution.\r
+ *\r
+ * 3. The end-user documentation included with the redistribution, if\r
+ * any, must include the following acknowlegement:\r
+ * "This product includes software developed by the\r
+ * Apache Software Foundation (http://www.apache.org/)."\r
+ * Alternately, this acknowlegement may appear in the software itself,\r
+ * if and wherever such third-party acknowlegements normally appear.\r
+ *\r
+ * 4. The names "The Jakarta Project", "Jakarta-Regexp", and "Apache Software\r
+ * Foundation" must not be used to endorse or promote products derived\r
+ * from this software without prior written permission. For written\r
+ * permission, please contact apache@apache.org.\r
+ *\r
+ * 5. Products derived from this software may not be called "Apache"\r
+ * nor may "Apache" appear in their names without prior written\r
+ * permission of the Apache Group.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED\r
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR\r
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF\r
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT\r
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
+ * SUCH DAMAGE.\r
+ * ====================================================================\r
+ *\r
+ * This software consists of voluntary contributions made by many\r
+ * individuals on behalf of the Apache Software Foundation. For more\r
+ * information on the Apache Software Foundation, please see\r
+ * <http://www.apache.org/>.\r
+ *\r
+ */\r
--- /dev/null
+\r
+ Apache License\r
+ Version 2.0, January 2004\r
+ http://www.apache.org/licenses/\r
+\r
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\r
+\r
+ 1. Definitions.\r
+\r
+ "License" shall mean the terms and conditions for use, reproduction,\r
+ and distribution as defined by Sections 1 through 9 of this document.\r
+\r
+ "Licensor" shall mean the copyright owner or entity authorized by\r
+ the copyright owner that is granting the License.\r
+\r
+ "Legal Entity" shall mean the union of the acting entity and all\r
+ other entities that control, are controlled by, or are under common\r
+ control with that entity. For the purposes of this definition,\r
+ "control" means (i) the power, direct or indirect, to cause the\r
+ direction or management of such entity, whether by contract or\r
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the\r
+ outstanding shares, or (iii) beneficial ownership of such entity.\r
+\r
+ "You" (or "Your") shall mean an individual or Legal Entity\r
+ exercising permissions granted by this License.\r
+\r
+ "Source" form shall mean the preferred form for making modifications,\r
+ including but not limited to software source code, documentation\r
+ source, and configuration files.\r
+\r
+ "Object" form shall mean any form resulting from mechanical\r
+ transformation or translation of a Source form, including but\r
+ not limited to compiled object code, generated documentation,\r
+ and conversions to other media types.\r
+\r
+ "Work" shall mean the work of authorship, whether in Source or\r
+ Object form, made available under the License, as indicated by a\r
+ copyright notice that is included in or attached to the work\r
+ (an example is provided in the Appendix below).\r
+\r
+ "Derivative Works" shall mean any work, whether in Source or Object\r
+ form, that is based on (or derived from) the Work and for which the\r
+ editorial revisions, annotations, elaborations, or other modifications\r
+ represent, as a whole, an original work of authorship. For the purposes\r
+ of this License, Derivative Works shall not include works that remain\r
+ separable from, or merely link (or bind by name) to the interfaces of,\r
+ the Work and Derivative Works thereof.\r
+\r
+ "Contribution" shall mean any work of authorship, including\r
+ the original version of the Work and any modifications or additions\r
+ to that Work or Derivative Works thereof, that is intentionally\r
+ submitted to Licensor for inclusion in the Work by the copyright owner\r
+ or by an individual or Legal Entity authorized to submit on behalf of\r
+ the copyright owner. For the purposes of this definition, "submitted"\r
+ means any form of electronic, verbal, or written communication sent\r
+ to the Licensor or its representatives, including but not limited to\r
+ communication on electronic mailing lists, source code control systems,\r
+ and issue tracking systems that are managed by, or on behalf of, the\r
+ Licensor for the purpose of discussing and improving the Work, but\r
+ excluding communication that is conspicuously marked or otherwise\r
+ designated in writing by the copyright owner as "Not a Contribution."\r
+\r
+ "Contributor" shall mean Licensor and any individual or Legal Entity\r
+ on behalf of whom a Contribution has been received by Licensor and\r
+ subsequently incorporated within the Work.\r
+\r
+ 2. Grant of Copyright License. Subject to the terms and conditions of\r
+ this License, each Contributor hereby grants to You a perpetual,\r
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r
+ copyright license to reproduce, prepare Derivative Works of,\r
+ publicly display, publicly perform, sublicense, and distribute the\r
+ Work and such Derivative Works in Source or Object form.\r
+\r
+ 3. Grant of Patent License. Subject to the terms and conditions of\r
+ this License, each Contributor hereby grants to You a perpetual,\r
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r
+ (except as stated in this section) patent license to make, have made,\r
+ use, offer to sell, sell, import, and otherwise transfer the Work,\r
+ where such license applies only to those patent claims licensable\r
+ by such Contributor that are necessarily infringed by their\r
+ Contribution(s) alone or by combination of their Contribution(s)\r
+ with the Work to which such Contribution(s) was submitted. If You\r
+ institute patent litigation against any entity (including a\r
+ cross-claim or counterclaim in a lawsuit) alleging that the Work\r
+ or a Contribution incorporated within the Work constitutes direct\r
+ or contributory patent infringement, then any patent licenses\r
+ granted to You under this License for that Work shall terminate\r
+ as of the date such litigation is filed.\r
+\r
+ 4. Redistribution. You may reproduce and distribute copies of the\r
+ Work or Derivative Works thereof in any medium, with or without\r
+ modifications, and in Source or Object form, provided that You\r
+ meet the following conditions:\r
+\r
+ (a) You must give any other recipients of the Work or\r
+ Derivative Works a copy of this License; and\r
+\r
+ (b) You must cause any modified files to carry prominent notices\r
+ stating that You changed the files; and\r
+\r
+ (c) You must retain, in the Source form of any Derivative Works\r
+ that You distribute, all copyright, patent, trademark, and\r
+ attribution notices from the Source form of the Work,\r
+ excluding those notices that do not pertain to any part of\r
+ the Derivative Works; and\r
+\r
+ (d) If the Work includes a "NOTICE" text file as part of its\r
+ distribution, then any Derivative Works that You distribute must\r
+ include a readable copy of the attribution notices contained\r
+ within such NOTICE file, excluding those notices that do not\r
+ pertain to any part of the Derivative Works, in at least one\r
+ of the following places: within a NOTICE text file distributed\r
+ as part of the Derivative Works; within the Source form or\r
+ documentation, if provided along with the Derivative Works; or,\r
+ within a display generated by the Derivative Works, if and\r
+ wherever such third-party notices normally appear. The contents\r
+ of the NOTICE file are for informational purposes only and\r
+ do not modify the License. You may add Your own attribution\r
+ notices within Derivative Works that You distribute, alongside\r
+ or as an addendum to the NOTICE text from the Work, provided\r
+ that such additional attribution notices cannot be construed\r
+ as modifying the License.\r
+\r
+ You may add Your own copyright statement to Your modifications and\r
+ may provide additional or different license terms and conditions\r
+ for use, reproduction, or distribution of Your modifications, or\r
+ for any such Derivative Works as a whole, provided Your use,\r
+ reproduction, and distribution of the Work otherwise complies with\r
+ the conditions stated in this License.\r
+\r
+ 5. Submission of Contributions. Unless You explicitly state otherwise,\r
+ any Contribution intentionally submitted for inclusion in the Work\r
+ by You to the Licensor shall be under the terms and conditions of\r
+ this License, without any additional terms or conditions.\r
+ Notwithstanding the above, nothing herein shall supersede or modify\r
+ the terms of any separate license agreement you may have executed\r
+ with Licensor regarding such Contributions.\r
+\r
+ 6. Trademarks. This License does not grant permission to use the trade\r
+ names, trademarks, service marks, or product names of the Licensor,\r
+ except as required for reasonable and customary use in describing the\r
+ origin of the Work and reproducing the content of the NOTICE file.\r
+\r
+ 7. Disclaimer of Warranty. Unless required by applicable law or\r
+ agreed to in writing, Licensor provides the Work (and each\r
+ Contributor provides its Contributions) on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\r
+ implied, including, without limitation, any warranties or conditions\r
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\r
+ PARTICULAR PURPOSE. You are solely responsible for determining the\r
+ appropriateness of using or redistributing the Work and assume any\r
+ risks associated with Your exercise of permissions under this License.\r
+\r
+ 8. Limitation of Liability. In no event and under no legal theory,\r
+ whether in tort (including negligence), contract, or otherwise,\r
+ unless required by applicable law (such as deliberate and grossly\r
+ negligent acts) or agreed to in writing, shall any Contributor be\r
+ liable to You for damages, including any direct, indirect, special,\r
+ incidental, or consequential damages of any character arising as a\r
+ result of this License or out of the use or inability to use the\r
+ Work (including but not limited to damages for loss of goodwill,\r
+ work stoppage, computer failure or malfunction, or any and all\r
+ other commercial damages or losses), even if such Contributor\r
+ has been advised of the possibility of such damages.\r
+\r
+ 9. Accepting Warranty or Additional Liability. While redistributing\r
+ the Work or Derivative Works thereof, You may choose to offer,\r
+ and charge a fee for, acceptance of support, warranty, indemnity,\r
+ or other liability obligations and/or rights consistent with this\r
+ License. However, in accepting such obligations, You may act only\r
+ on Your own behalf and on Your sole responsibility, not on behalf\r
+ of any other Contributor, and only if You agree to indemnify,\r
+ defend, and hold each Contributor harmless for any liability\r
+ incurred by, or claims asserted against, such Contributor by reason\r
+ of your accepting any such warranty or additional liability.\r
+\r
+ END OF TERMS AND CONDITIONS\r
+\r
+ APPENDIX: How to apply the Apache License to your work.\r
+\r
+ To apply the Apache License to your work, attach the following\r
+ boilerplate notice, with the fields enclosed by brackets "[]"\r
+ replaced with your own identifying information. (Don't include\r
+ the brackets!) The text should be enclosed in the appropriate\r
+ comment syntax for the file format. We also recommend that a\r
+ file or class name and description of purpose be included on the\r
+ same "printed page" as the copyright notice for easier\r
+ identification within third-party archives.\r
+\r
+ Copyright [yyyy] [name of copyright owner]\r
+\r
+ Licensed under the Apache License, Version 2.0 (the "License");\r
+ you may not use this file except in compliance with the License.\r
+ You may obtain a copy of the License at\r
+\r
+ http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+ distributed under the License is distributed on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ See the License for the specific language governing permissions and\r
+ limitations under the License.\r
--- /dev/null
+\r
+SOFTWARE RIGHTS\r
+$Id: RIGHTS.antlr,v 1.1 2001/06/22 13:11:01 oburn Exp $\r
+\r
+ANTLR 1989-2000 Developed by jGuru.com (MageLang Institute), \r
+http://www.ANTLR.org and http://www.jGuru.com\r
+\r
+We reserve no legal rights to the ANTLR--it is fully in the\r
+public domain. An individual or company may do whatever\r
+they wish with source code distributed with ANTLR or the\r
+code generated by ANTLR, including the incorporation of\r
+ANTLR, or its output, into commerical software.\r
+\r
+We encourage users to develop software with ANTLR. However,\r
+we do ask that credit is given to us for developing\r
+ANTLR. By "credit", we mean that if you use ANTLR or\r
+incorporate any source code into one of your programs\r
+(commercial product, research project, or otherwise) that\r
+you acknowledge this fact somewhere in the documentation,\r
+research report, etc... If you like ANTLR and have\r
+developed a nice tool with the output, please mention that\r
+you developed it using ANTLR. In addition, we ask that the\r
+headers remain intact in our source code. As long as these\r
+guidelines are kept, we expect to continue enhancing this\r
+system and expect to make other tools available as they are\r
+completed.\r
+\r
+The primary ANTLR guy:\r
+\r
+Terence Parr\r
+http://www.jGuru.com\r
+parrt@jguru.com\r
--- /dev/null
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">\r
+ <xsl:output method="html" indent="yes"/>\r
+ <xsl:decimal-format decimal-separator="." grouping-separator=","/>\r
+ <!-- \r
+ Checkstyle XML Style Sheet by Daniel Grenner \r
+ <daniel DOT grenner AT enea DOT se> \r
+ This stylesheet groups the errors by author name, if used in combination\r
+ with the WriteTag check:\r
+\r
+ <module name="WriteTag">\r
+ <property name="tag" value="@author"/>\r
+ <property name="tagFormat" value="\S"/>\r
+ <property name="severity" value="ignore"/>\r
+ </module>\r
+\r
+ The output contains both error and warning messages.\r
+ Files without errors or warnings are not included.\r
+ This stylesheet is based on checkstyle-noframes.xsl.\r
+ -->\r
+\r
+ <xsl:key name="keyAuthorID" match="//file/error[contains(@message,'@author')]" use="@message" />\r
+ <xsl:key name="keySeverityID" match="//file/error" use="@severity" />\r
+ <xsl:template match="checkstyle">\r
+ <html>\r
+ <head>\r
+ <style type="text/css">\r
+ .bannercell {\r
+ border: 0px;\r
+ padding: 0px;\r
+ }\r
+ body {\r
+ margin-left: 10;\r
+ margin-right: 10;\r
+ font:normal 68% verdana,arial,helvetica;\r
+ background-color:#FFFFFF;\r
+ color:#000000;\r
+ }\r
+ .a td {\r
+ background: #efefef;\r
+ }\r
+ .b td {\r
+ background: #fff;\r
+ }\r
+ th, td {\r
+ text-align: left;\r
+ vertical-align: top;\r
+ }\r
+ th {\r
+ font-weight:bold;\r
+ background: #ccc;\r
+ color: black;\r
+ }\r
+ table, th, td {\r
+ font-size:100%;\r
+ border: none\r
+ }\r
+ table.log tr td, tr th {\r
+\r
+ }\r
+ h2 {\r
+ font-weight:bold;\r
+ font-size:140%;\r
+ margin-bottom: 5;\r
+ }\r
+ h3 {\r
+ font-size:100%;\r
+ font-weight:bold;\r
+ background: #525D76;\r
+ color: white;\r
+ text-decoration: none;\r
+ padding: 5px;\r
+ margin-right: 2px;\r
+ margin-left: 2px;\r
+ margin-bottom: 0;\r
+ }\r
+ </style>\r
+ </head>\r
+ <body>\r
+ <a name="#top"/>\r
+ <!-- jakarta logo -->\r
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
+ <tr>\r
+ <td class="bannercell" rowspan="2">\r
+ <!--a href="http://jakarta.apache.org/">\r
+ <img src="http://jakarta.apache.org/images/jakarta-logo.gif" alt="http://jakarta.apache.org" align="left" border="0"/>\r
+ </a-->\r
+ </td>\r
+ <td class="text-align:right">\r
+ <h2>CheckStyle Audit</h2>\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="text-align:right">Designed for use with <a href="http://checkstyle.sourceforge.net/">CheckStyle</a> and <a href="http://jakarta.apache.org">Ant</a>.</td>\r
+ </tr>\r
+ </table>\r
+ <hr size="1"/>\r
+\r
+ <!-- Summary part -->\r
+ <xsl:apply-templates select="." mode="summary"/>\r
+ <hr size="1" width="100%" align="left"/>\r
+\r
+ <!-- Author List part -->\r
+ <xsl:apply-templates select="." mode="authorlist"/>\r
+ <hr size="1" width="100%" align="left"/>\r
+\r
+ <!-- For each package create its part -->\r
+ <xsl:for-each select="file">\r
+ <xsl:sort select="./error[contains(@message,'@author=')]/@message"/>\r
+ <xsl:apply-templates select="."/>\r
+ <p/>\r
+ <p/>\r
+ </xsl:for-each>\r
+ <hr size="1" width="100%" align="left"/>\r
+ </body>\r
+ </html>\r
+ </xsl:template>\r
+ <xsl:template match="checkstyle" mode="summary">\r
+ <h3>Summary</h3>\r
+ <xsl:variable name="fileCount" select="count(file)"/>\r
+ <xsl:variable name="errorCount" select="count(key('keySeverityID', 'error'))"/>\r
+ <xsl:variable name="warningCount" select="count(key('keySeverityID', 'warning'))"/>\r
+ <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">\r
+ <tr>\r
+ <th>Files</th>\r
+ <th>Errors</th>\r
+ <th>Warnings</th>\r
+ </tr>\r
+ <tr>\r
+ <xsl:call-template name="alternated-row"/>\r
+ <td>\r
+ <xsl:value-of select="$fileCount"/>\r
+ </td>\r
+ <td>\r
+ <xsl:value-of select="$errorCount"/>\r
+ </td>\r
+ <td>\r
+ <xsl:value-of select="$warningCount"/>\r
+ </td>\r
+ </tr>\r
+ </table>\r
+ </xsl:template>\r
+ <xsl:template match="checkstyle" mode="authorlist">\r
+ <h3>Authors</h3>\r
+\r
+ <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">\r
+ <tr>\r
+ <th>Name</th>\r
+ <th>Errors</th>\r
+ <th>Warnings</th>\r
+ </tr>\r
+\r
+ <!-- Process each Author -->\r
+ <xsl:for-each select="file/error[generate-id(.) = generate-id(key('keyAuthorID', @message)[1])]">\r
+ <xsl:sort select="@message" />\r
+\r
+ <xsl:variable name="authorFull" select="@message"/>\r
+ <xsl:variable name="author" select="substring-after($authorFull,'@author=')"/>\r
+ <xsl:variable name="errors" select="count(key('keyAuthorID', @message)/../error[@severity='error'])"/>\r
+ <xsl:variable name="warnings" select="count(key('keyAuthorID', @message)/../error[@severity='warning'])"/>\r
+ <xsl:if test = "not ($author='' or ($errors + $warnings = 0))">\r
+ <tr>\r
+ <xsl:call-template name="alternated-row"/>\r
+ <td>\r
+ <a href="#{$author}">\r
+ <xsl:value-of select="$author"/>\r
+ </a>\r
+ </td>\r
+ <td><xsl:value-of select="$errors"/></td>\r
+ <td><xsl:value-of select="$warnings"/></td>\r
+ </tr>\r
+ </xsl:if>\r
+ </xsl:for-each>\r
+\r
+ </table>\r
+ </xsl:template>\r
+\r
+ <xsl:template match="file">\r
+ <xsl:variable name="errorCount" select="count(error[@severity='error']) + count(error[@severity='warning'])"/>\r
+ <xsl:if test="not ($errorCount=0)">\r
+\r
+ <xsl:variable name="author" select="substring-after(./error[contains(@message,'@author')]/@message,'@author=')"/>\r
+\r
+ <a name="#{$author}"/>\r
+ <h3>File <xsl:value-of select="@name"/>\r
+ <br/>\r
+ Author <xsl:value-of select="$author"/>\r
+ </h3>\r
+ <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">\r
+ <tr>\r
+ <th>Error Description</th>\r
+ <th>Line</th>\r
+ </tr>\r
+ <xsl:for-each select="error[not(@severity='info')]">\r
+ <xsl:sort select="@line" data-type="number"/>\r
+ <tr>\r
+ <xsl:call-template name="alternated-row"/>\r
+ <td>\r
+ <xsl:value-of select="@message"/>\r
+ </td>\r
+ <td>\r
+ <xsl:value-of select="@line"/>\r
+ </td>\r
+ </tr>\r
+ </xsl:for-each>\r
+ </table>\r
+ <a href="#top">Back to top</a>\r
+ </xsl:if>\r
+ </xsl:template>\r
+\r
+\r
+<xsl:template name="basename">\r
+ <xsl:param name="path"/>\r
+ <xsl:choose>\r
+ <xsl:when test="contains($path, '\')">\r
+ <xsl:call-template name="basename">\r
+ <xsl:with-param name="path">substring-after($path, '\')</xsl:with-param>\r
+ </xsl:call-template>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:value-of select="$path"/>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+</xsl:template>\r
+\r
+\r
+ <xsl:template name="alternated-row">\r
+ <xsl:attribute name="class"><xsl:if test="position() mod 2 = 1">a</xsl:if><xsl:if test="position() mod 2 = 0">b</xsl:if></xsl:attribute>\r
+ </xsl:template>\r
+\r
+</xsl:stylesheet>\r
--- /dev/null
+Copyright (c) 2000-2005 INRIA, France Telecom
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holders nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
--- /dev/null
+AppleJavaExtensions
+v 1.2
+
+This is a pluggable jar of stub classes representing the new Apple eAWT and eIO APIs for Java 1.4 on Mac OS X. The purpose of these stubs is to allow for compilation of eAWT- or eIO-referencing code on platforms other than Mac OS X. The jar file is enclosed in a zip archive for easy expansion on other platforms.
+
+These stubs are not intended for the runtime classpath on non-Mac platforms. Please see the OSXAdapter sample for how to write cross-platform code that uses eAWT.
+
+Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple
+Computer, Inc. ("Apple") in consideration of your agreement to the
+following terms, and your use, installation, modification or
+redistribution of this Apple software constitutes acceptance of these
+terms. If you do not agree with these terms, please do not use,
+install, modify or redistribute this Apple software.
+
+In consideration of your agreement to abide by the following terms, and
+subject to these terms, Apple grants you a personal, non-exclusive
+license, under Apple's copyrights in this original Apple software (the
+"Apple Software"), to use, reproduce, modify and redistribute the Apple
+Software, with or without modifications, in source and/or binary forms;
+provided that if you redistribute the Apple Software in its entirety and
+without modifications, you must retain this notice and the following
+text and disclaimers in all such redistributions of the Apple Software.
+Neither the name, trademarks, service marks or logos of Apple Computer,
+Inc. may be used to endorse or promote products derived from the Apple
+Software without specific prior written permission from Apple. Except
+as expressly stated in this notice, no other rights or licenses, express
+or implied, are granted by Apple herein, including but not limited to
+any patent rights that may be infringed by your derivative works or by
+other works in which the Apple Software may be incorporated.
+
+The Apple Software is provided by Apple on an "AS IS" basis. APPLE
+MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+
+IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+Copyright © 2003-2006 Apple Computer, Inc., All Rights Reserved
\ No newline at end of file
--- /dev/null
+/*
+ * Apache License
+ * Version 2.0, January 2004
+ * http://www.apache.org/licenses/
+ *
+ * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ * 1. Definitions.
+ *
+ * "License" shall mean the terms and conditions for use, reproduction,
+ * and distribution as defined by Sections 1 through 9 of this document.
+ *
+ * "Licensor" shall mean the copyright owner or entity authorized by
+ * the copyright owner that is granting the License.
+ *
+ * "Legal Entity" shall mean the union of the acting entity and all
+ * other entities that control, are controlled by, or are under common
+ * control with that entity. For the purposes of this definition,
+ * "control" means (i) the power, direct or indirect, to cause the
+ * direction or management of such entity, whether by contract or
+ * otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ * outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ * "You" (or "Your") shall mean an individual or Legal Entity
+ * exercising permissions granted by this License.
+ *
+ * "Source" form shall mean the preferred form for making modifications,
+ * including but not limited to software source code, documentation
+ * source, and configuration files.
+ *
+ * "Object" form shall mean any form resulting from mechanical
+ * transformation or translation of a Source form, including but
+ * not limited to compiled object code, generated documentation,
+ * and conversions to other media types.
+ *
+ * "Work" shall mean the work of authorship, whether in Source or
+ * Object form, made available under the License, as indicated by a
+ * copyright notice that is included in or attached to the work
+ * (an example is provided in the Appendix below).
+ *
+ * "Derivative Works" shall mean any work, whether in Source or Object
+ * form, that is based on (or derived from) the Work and for which the
+ * editorial revisions, annotations, elaborations, or other modifications
+ * represent, as a whole, an original work of authorship. For the purposes
+ * of this License, Derivative Works shall not include works that remain
+ * separable from, or merely link (or bind by name) to the interfaces of,
+ * the Work and Derivative Works thereof.
+ *
+ * "Contribution" shall mean any work of authorship, including
+ * the original version of the Work and any modifications or additions
+ * to that Work or Derivative Works thereof, that is intentionally
+ * submitted to Licensor for inclusion in the Work by the copyright owner
+ * or by an individual or Legal Entity authorized to submit on behalf of
+ * the copyright owner. For the purposes of this definition, "submitted"
+ * means any form of electronic, verbal, or written communication sent
+ * to the Licensor or its representatives, including but not limited to
+ * communication on electronic mailing lists, source code control systems,
+ * and issue tracking systems that are managed by, or on behalf of, the
+ * Licensor for the purpose of discussing and improving the Work, but
+ * excluding communication that is conspicuously marked or otherwise
+ * designated in writing by the copyright owner as "Not a Contribution."
+ *
+ * "Contributor" shall mean Licensor and any individual or Legal Entity
+ * on behalf of whom a Contribution has been received by Licensor and
+ * subsequently incorporated within the Work.
+ *
+ * 2. Grant of Copyright License. Subject to the terms and conditions of
+ * this License, each Contributor hereby grants to You a perpetual,
+ * worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ * copyright license to reproduce, prepare Derivative Works of,
+ * publicly display, publicly perform, sublicense, and distribute the
+ * Work and such Derivative Works in Source or Object form.
+ *
+ * 3. Grant of Patent License. Subject to the terms and conditions of
+ * this License, each Contributor hereby grants to You a perpetual,
+ * worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ * (except as stated in this section) patent license to make, have made,
+ * use, offer to sell, sell, import, and otherwise transfer the Work,
+ * where such license applies only to those patent claims licensable
+ * by such Contributor that are necessarily infringed by their
+ * Contribution(s) alone or by combination of their Contribution(s)
+ * with the Work to which such Contribution(s) was submitted. If You
+ * institute patent litigation against any entity (including a
+ * cross-claim or counterclaim in a lawsuit) alleging that the Work
+ * or a Contribution incorporated within the Work constitutes direct
+ * or contributory patent infringement, then any patent licenses
+ * granted to You under this License for that Work shall terminate
+ * as of the date such litigation is filed.
+ *
+ * 4. Redistribution. You may reproduce and distribute copies of the
+ * Work or Derivative Works thereof in any medium, with or without
+ * modifications, and in Source or Object form, provided that You
+ * meet the following conditions:
+ *
+ * (a) You must give any other recipients of the Work or
+ * Derivative Works a copy of this License; and
+ *
+ * (b) You must cause any modified files to carry prominent notices
+ * stating that You changed the files; and
+ *
+ * (c) You must retain, in the Source form of any Derivative Works
+ * that You distribute, all copyright, patent, trademark, and
+ * attribution notices from the Source form of the Work,
+ * excluding those notices that do not pertain to any part of
+ * the Derivative Works; and
+ *
+ * (d) If the Work includes a "NOTICE" text file as part of its
+ * distribution, then any Derivative Works that You distribute must
+ * include a readable copy of the attribution notices contained
+ * within such NOTICE file, excluding those notices that do not
+ * pertain to any part of the Derivative Works, in at least one
+ * of the following places: within a NOTICE text file distributed
+ * as part of the Derivative Works; within the Source form or
+ * documentation, if provided along with the Derivative Works; or,
+ * within a display generated by the Derivative Works, if and
+ * wherever such third-party notices normally appear. The contents
+ * of the NOTICE file are for informational purposes only and
+ * do not modify the License. You may add Your own attribution
+ * notices within Derivative Works that You distribute, alongside
+ * or as an addendum to the NOTICE text from the Work, provided
+ * that such additional attribution notices cannot be construed
+ * as modifying the License.
+ *
+ * You may add Your own copyright statement to Your modifications and
+ * may provide additional or different license terms and conditions
+ * for use, reproduction, or distribution of Your modifications, or
+ * for any such Derivative Works as a whole, provided Your use,
+ * reproduction, and distribution of the Work otherwise complies with
+ * the conditions stated in this License.
+ *
+ * 5. Submission of Contributions. Unless You explicitly state otherwise,
+ * any Contribution intentionally submitted for inclusion in the Work
+ * by You to the Licensor shall be under the terms and conditions of
+ * this License, without any additional terms or conditions.
+ * Notwithstanding the above, nothing herein shall supersede or modify
+ * the terms of any separate license agreement you may have executed
+ * with Licensor regarding such Contributions.
+ *
+ * 6. Trademarks. This License does not grant permission to use the trade
+ * names, trademarks, service marks, or product names of the Licensor,
+ * except as required for reasonable and customary use in describing the
+ * origin of the Work and reproducing the content of the NOTICE file.
+ *
+ * 7. Disclaimer of Warranty. Unless required by applicable law or
+ * agreed to in writing, Licensor provides the Work (and each
+ * Contributor provides its Contributions) on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied, including, without limitation, any warranties or conditions
+ * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ * PARTICULAR PURPOSE. You are solely responsible for determining the
+ * appropriateness of using or redistributing the Work and assume any
+ * risks associated with Your exercise of permissions under this License.
+ *
+ * 8. Limitation of Liability. In no event and under no legal theory,
+ * whether in tort (including negligence), contract, or otherwise,
+ * unless required by applicable law (such as deliberate and grossly
+ * negligent acts) or agreed to in writing, shall any Contributor be
+ * liable to You for damages, including any direct, indirect, special,
+ * incidental, or consequential damages of any character arising as a
+ * result of this License or out of the use or inability to use the
+ * Work (including but not limited to damages for loss of goodwill,
+ * work stoppage, computer failure or malfunction, or any and all
+ * other commercial damages or losses), even if such Contributor
+ * has been advised of the possibility of such damages.
+ *
+ * 9. Accepting Warranty or Additional Liability. While redistributing
+ * the Work or Derivative Works thereof, You may choose to offer,
+ * and charge a fee for, acceptance of support, warranty, indemnity,
+ * or other liability obligations and/or rights consistent with this
+ * License. However, in accepting such obligations, You may act only
+ * on Your own behalf and on Your sole responsibility, not on behalf
+ * of any other Contributor, and only if You agree to indemnify,
+ * defend, and hold each Contributor harmless for any liability
+ * incurred by, or claims asserted against, such Contributor by reason
+ * of your accepting any such warranty or additional liability.
+ *
+ * END OF TERMS AND CONDITIONS
+ *
+ * APPENDIX: How to apply the Apache License to your work.
+ *
+ * To apply the Apache License to your work, attach the following
+ * boilerplate notice, with the fields enclosed by brackets "[]"
+ * replaced with your own identifying information. (Don't include
+ * the brackets!) The text should be enclosed in the appropriate
+ * comment syntax for the file format. We also recommend that a
+ * file or class name and description of purpose be included on the
+ * same "printed page" as the copyright notice for easier
+ * identification within third-party archives.
+ *
+ * Copyright [yyyy] [name of copyright owner]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
--- /dev/null
+<!-- Copyright 1992-2002 HaL Computer Systems, Inc.,
+ O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software
+ Corporation, Norman Walsh, Sun Microsystems, Inc., and the
+ Organization for the Advancement of Structured Information
+ Standards (OASIS).
+
+ $Id: LICENSE-docbook.txt,v 1.1 2005/11/28 21:36:47 daveho Exp $
+
+ Permission to use, copy, modify and distribute the DocBook XML DTD
+ and its accompanying documentation for any purpose and without fee
+ is hereby granted in perpetuity, provided that the above copyright
+ notice and this paragraph appear in all copies. The copyright
+ holders make no representation about the suitability of the DTD for
+ any purpose. It is provided "as is" without expressed or implied
+ warranty.
+
+ If you modify the DocBook DTD in any way, except for declaring and
+ referencing additional sets of general entities and declaring
+ additional notations, label your DTD as a variant of DocBook. See
+ the maintenance documentation for more information.
+
+ Please direct all questions, bug reports, or suggestions for
+ changes to the docbook@lists.oasis-open.org mailing list. For more
+ information, see http://www.oasis-open.org/docbook/.
+-->
--- /dev/null
+BSD style license
+
+Redistribution and use of this software and associated documentation
+("Software"), with or without modification, are permitted provided that
+the following conditions are met:
+
+ 1. Redistributions of source code must retain copyright statements
+ and notices. Redistributions must also contain a copy of this
+ document.
+
+ 2. Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the following
+ disclaimer in the documentation and/or other materials provided
+ with the distribution.
+
+ 3. The name "DOM4J" must not be used to endorse or promote
+ products derived from this Software without prior written
+ permission of MetaStuff, Ltd. For written permission, please
+ contact dom4j-info@metastuff.com.
+
+ 4. Products derived from this Software may not be called "DOM4J"
+ nor may "DOM4J" appear in their names without prior written
+ permission of MetaStuff, Ltd. DOM4J is a registered trademark of
+ MetaStuff, Ltd.
+
+ 5. Due credit should be given to the DOM4J Project
+ (http://dom4j.org/).
+
+THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS''
+AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Copyright 2001 (C) MetaStuff, Ltd. All Rights Reserved.
--- /dev/null
+The Java code in the package net.jcip.annotations
+is copyright (c) 2005 Brian Goetz
+and is released under the Creative Commons Attribution License
+(http://creativecommons.org/licenses/by/2.5)
+Official home: http://www.jcip.net
--- /dev/null
+The JSR-305 reference implementation (lib/jsr305.jar) is
+distributed under the terms of the New BSD license:
+
+ http://www.opensource.org/licenses/bsd-license.php
+
+See the JSR-305 home page for more information:
+
+ http://code.google.com/p/jsr-305/
--- /dev/null
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+\f
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+\f
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+\f
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+\f
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+\f
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+\f
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+\f
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+\f
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the library's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ <signature of Ty Coon>, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
+
+
--- /dev/null
+To get started, see doc/index.html and doc/manual/index.html
+
+The FindBugs source license is in the file LICENSE.txt
+
+Both the name FindBugs and the FindBugs bug mark are
+trademarked by the University of Maryland.
+
+The Apache BCEL license is in the file LICENSE-bcel.txt
+
+The ASM license is in the file LICENSE-ASM.txt
+
+The dom4j license is in the file LICENSE-dom4j.txt
+
+The AppleJavaExtensions license is in the file LICENSE-AppleJavaExtensions.txt
+
+The Docbook 4.2 XML DTD license is in the file LICENSE-docbook.txt
+
+The JSR-305 reference implementation license is in LICENSE-jsr305.txt
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.AddMessages
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
--- /dev/null
+#! /bin/sh
+
+# Merge a historical bug collection and a bug collection, producing an updated
+# historical bug collection
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.Update
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.PrintingBugReporter
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.CopyBuggySource
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Generate a defect density table from a bug collection
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.DefectDensity
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.BugHistory
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Create the union of two results files, preserving
+# annotations in both files in the result.
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.UnionResults
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Deprecated
+
+# Create the union of two results files, preserving
+# annotations in both files in the result.
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.UnionResults
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Merge a historical bug collection and a bug collection, producing an updated
+# historical bug collection
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.Update
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# A convenient way to call the main() method of a class
+# in findbugs.jar.
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+if [ $# -eq 0 ]; then
+ echo "Usage: fbwrap <main class name> <args...>"
+ exit 1
+fi
+
+fb_mainclass="$1"
+shift
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# General purpose utility for filtering/transforming
+# bug collection and/or historical bug collections
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.Filter
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Launch FindBugs from the command line.
+
+escape_arg() {
+ echo "$1" | sed -e "s,\\([\\\"' ]\\),\\\\\\1,g"
+}
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+maxheap=768
+
+ShowHelpAndExit() {
+ fb_appjar="$findbugs_home/lib/findbugsGUI.jar"
+ fb_mainclass="edu.umd.cs.findbugs.ShowHelp"
+ fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+ exit 0
+}
+
+# Set defaults
+fb_appjar="$findbugs_home/lib/findbugsGUI.jar"
+fb_mainclass="edu.umd.cs.findbugs.LaunchAppropriateUI"
+user_jvmargs=''
+ea_arg=''
+debug_arg=''
+conservespace_arg=''
+workhard_arg=''
+user_props=''
+
+# Handle command line arguments.
+while [ $# -gt 0 ]; do
+ case $1 in
+ -gui)
+ # this is the default
+ ;;
+
+ -gui1)
+ user_props="-Dfindbugs.launchUI=1 $user_props"
+ ;;
+
+ -textui)
+ fb_appjar="$findbugs_home/lib/findbugs.jar"
+ fb_mainclass="edu.umd.cs.findbugs.FindBugs2"
+ ;;
+
+ -jvmArgs)
+ shift
+ user_jvmargs="$1"
+ ;;
+
+ -ea)
+ ea_arg='-ea'
+ ;;
+
+ -maxHeap)
+ shift
+ maxheap="$1"
+ ;;
+
+ -javahome)
+ shift
+ fb_javacmd="$1/bin/java"
+ ;;
+
+ -debug)
+ debug_arg="-Dfindbugs.debug=true"
+ ;;
+
+ -conserveSpace)
+ conservespace_arg="-Dfindbugs.conserveSpace=true"
+ ;;
+
+ -property)
+ shift
+ user_props="-D$1 $user_props"
+ ;;
+
+ -D*=*)
+ user_props="$1 $user_props"
+ ;;
+
+ -version)
+ fb_mainclass=edu.umd.cs.findbugs.Version
+ fb_appargs="-release"
+ while [ $# -gt 0 ]; do
+ shift
+ done
+ fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+ exit 0
+ ;;
+
+ -help)
+ ShowHelpAndExit
+ ;;
+
+ # All unrecognized arguments will be accumulated and
+ # passed to the application.
+ *)
+ fb_appargs="$fb_appargs `escape_arg "$1"`"
+ ;;
+ esac
+
+ shift
+done
+
+fb_jvmargs="$user_jvmargs $debug_arg $conservespace_arg $workhard_arg $user_props $ea_arg"
+fb_maxheap="-Xmx${maxheap}m"
+
+# Extra JVM args for MacOSX.
+if [ $fb_osname = "Darwin" ]; then
+ fb_jvmargs="$fb_jvmargs \
+ -Xdock:name=FindBugs -Xdock:icon=${findbugs_home}/lib/buggy.icns \
+ -Dapple.laf.useScreenMenuBar=true"
+fi
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+@echo off\r
+:: Launch FindBugs on a Windows system.\r
+:: Adapted from scripts found at http://www.ericphelps.com/batch/\r
+:: This will only work on Windows NT or later!\r
+\r
+:: Don't affect environment outside of this invocation\r
+setlocal\r
+\r
+:: ----------------------------------------------------------------------\r
+:: Set up default values\r
+:: ----------------------------------------------------------------------\r
+set appjar=findbugsGUI.jar\r
+set javahome=\r
+set launcher=javaw.exe\r
+set start=start "FindBugs"\r
+set jvmargs=\r
+set debugArg=\r
+set conserveSpaceArg=\r
+set workHardArg=\r
+set args=\r
+set javaProps=\r
+set maxheap=384\r
+\r
+:: Try finding the default FINDBUGS_HOME directory\r
+:: from the directory path of this script\r
+set default_findbugs_home=%~dp0..\r
+\r
+:: Honor JAVA_HOME environment variable if it is set\r
+if "%JAVA_HOME%"=="" goto nojavahome\r
+if not exist "%JAVA_HOME%\bin\javaw.exe" goto nojavahome\r
+set javahome=%JAVA_HOME%\bin\\r
+:nojavahome\r
+\r
+goto loop\r
+\r
+:: ----------------------------------------------------------------------\r
+:: Process command-line arguments\r
+:: ----------------------------------------------------------------------\r
+\r
+:shift2\r
+shift\r
+:shift1\r
+shift\r
+\r
+:loop\r
+\r
+:: Remove surrounding quotes from %1 and %2\r
+set firstArg=%~1\r
+set secondArg=%~2\r
+\r
+if not "%firstArg%"=="-gui" goto notGui\r
+set appjar=findbugsGUI.jar\r
+set launcher=javaw.exe\r
+goto shift1\r
+:notGui\r
+\r
+if not "%firstArg%"=="-gui1" goto notGui1\r
+set appjar=findbugsGUI.jar\r
+set javaProps=-Dfindbugs.launchUI=1 %javaProps%\r
+set launcher=javaw.exe\r
+goto shift1\r
+:notGui1\r
+\r
+if not "%firstArg%"=="-textui" goto notTextui\r
+set appjar=findbugs.jar\r
+set launcher=java.exe\r
+set start=\r
+goto shift1\r
+:notTextui\r
+\r
+if not "%firstArg%"=="-debug" goto notDebug\r
+set launcher=java.exe\r
+set start=\r
+set debugArg=-Dfindbugs.debug=true\r
+goto shift1\r
+:notDebug\r
+\r
+if "%firstArg%"=="-home" set FINDBUGS_HOME=%secondArg%\r
+if "%firstArg%"=="-home" goto shift2\r
+\r
+if "%firstArg%"=="-jvmArgs" set jvmargs=%secondArg%\r
+if "%firstArg%"=="-jvmArgs" goto shift2\r
+\r
+if "%firstArg%"=="-maxHeap" set maxheap=%secondArg%\r
+if "%firstArg%"=="-maxHeap" goto shift2\r
+\r
+if "%firstArg%"=="-conserveSpace" set conserveSpaceArg=-Dfindbugs.conserveSpace=true\r
+if "%firstArg%"=="-conserveSpace" goto shift1\r
+\r
+if "%firstArg%"=="-workHard" set workHardArg=-Dfindbugs.workHard=true\r
+if "%firstArg%"=="-workHard" goto shift1\r
+\r
+if "%firstArg%"=="-javahome" set javahome=%secondArg%\bin\\r
+if "%firstArg%"=="-javahome" goto shift2\r
+\r
+if "%firstArg%"=="-property" set javaProps=-D%secondArg% %javaProps%\r
+if "%firstArg%"=="-property" goto shift2\r
+\r
+if "%firstArg%"=="-help" goto help\r
+\r
+if "%firstArg%"=="" goto launch\r
+\r
+set args=%args% "%firstArg%"\r
+goto shift1\r
+\r
+:: ----------------------------------------------------------------------\r
+:: Launch FindBugs\r
+:: ----------------------------------------------------------------------\r
+:launch\r
+:: Make sure FINDBUGS_HOME is set.\r
+:: If it isn't, try using the default value based on the\r
+:: directory path of the invoked script.\r
+:: Note that this will fail miserably if the value of FINDBUGS_HOME\r
+:: has quote characters in it.\r
+if not "%FINDBUGS_HOME%"=="" goto checkHomeValid\r
+set FINDBUGS_HOME=%default_findbugs_home%\r
+\r
+:checkHomeValid\r
+if not exist "%FINDBUGS_HOME%\lib\%appjar%" goto homeNotSet\r
+\r
+:found_home\r
+:: Launch FindBugs!\r
+%start% "%javahome%%launcher%" %debugArg% %conserveSpaceArg% %workHardArg% %javaProps% "-Dfindbugs.home=%FINDBUGS_HOME%" -Xmx%maxheap%m %jvmargs% -jar "%FINDBUGS_HOME%\lib\%appjar%" %args%\r
+goto end\r
+\r
+:: ----------------------------------------------------------------------\r
+:: Display usage information\r
+:: ----------------------------------------------------------------------\r
+:help\r
+echo Usage: findbugs [options]\r
+echo -home dir Use dir as FINDBUGS_HOME\r
+echo -gui Use the Graphical UI (default behavior)\r
+echo -gui1 Use the older Graphical UI\r
+echo -textui Use the Text UI\r
+echo -jvmArgs args Pass args to JVM\r
+echo -maxHeap size Set maximum Java heap size in megabytes (default %maxheap%)\r
+echo -javahome dir Specify location of JRE\r
+echo -help Display this message\r
+echo -debug Enable debug tracing in FindBugs\r
+echo -conserveSpace Conserve memory at the expense of precision\r
+echo All other options are passed to the FindBugs application\r
+goto end\r
+\r
+:: ----------------------------------------------------------------------\r
+:: Report that FINDBUGS_HOME is not set (and was not specified)\r
+:: ----------------------------------------------------------------------\r
+:homeNotSet\r
+echo Could not find FindBugs home directory. There may be a problem\r
+echo with the FindBugs installation. Try setting FINDBUGS_HOME, or\r
+echo re-installing.\r
+goto end\r
+\r
+:end\r
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.ListBugDatabaseInfo
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.MineBugHistory
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.PrintAppVersion
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.visitclass.PrintClass
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.RejarClassesForAnalysis
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.SetBugDatabaseInfo
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+# Deprecated
+
+# Create the union of two results files, preserving
+# annotations in both files in the result.
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.workflow.UnionResults
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+#! /bin/sh
+
+program="$0"
+
+# Follow symlinks until we get to the actual file.
+while [ -h "$program" ]; do
+ link=`ls -ld "$program"`
+ link=`expr "$link" : '.*-> \(.*\)'`
+ if [ "`expr "$link" : '/.*'`" = 0 ]; then
+ # Relative
+ dir=`dirname "$program"`
+ program="$dir/$link"
+ else
+ # Absolute
+ program="$link"
+ fi
+done
+
+# Assume findbugs home directory is the parent
+# of the directory containing the script (which should
+# normally be "$findbugs_home/bin").
+dir=`dirname "$program"`
+findbugs_home="$dir/.."
+
+# Handle FHS-compliant installations (e.g., Fink)
+if [ -d "$findbugs_home/share/findbugs" ]; then
+ findbugs_home="$findbugs_home/share/findbugs"
+fi
+
+# Make absolute
+findbugs_home=`cd "$findbugs_home" && /bin/pwd`
+
+fb_pathsep=':'
+
+# Handle cygwin, courtesy of Peter D. Stout
+fb_osname=`uname`
+if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ findbugs_home=`cygpath --mixed "$findbugs_home"`
+ fb_pathsep=';'
+fi
+
+if [ ! -d "$findbugs_home" ]; then
+ echo "The path $findbugs_home,"
+ echo "which is where I think FindBugs is located,"
+ echo "does not seem to be a directory."
+ exit 1
+fi
+
+# Choose default java binary
+fb_javacmd=java
+if [ ! -z "$JAVA_HOME" ] && [ -x "$JAVA_HOME/bin/java" ]; then
+ if [ `expr "$fb_osname" : CYGWIN` -ne 0 ]; then
+ fb_javacmd=`cygpath --mixed "$JAVA_HOME"`/bin/java
+ else
+ fb_javacmd="$JAVA_HOME/bin/java"
+ fi
+fi
+
+fb_mainclass=edu.umd.cs.findbugs.xml.XPathFind
+
+fb_javacmd=${fb_javacmd:-"java"}
+fb_maxheap=${fb_maxheap:-"-Xmx584m"}
+fb_appjar=${fb_appjar:-"$findbugs_home/lib/findbugs.jar"}
+set -f
+#echo command: \
+exec "$fb_javacmd" \
+ -classpath "$fb_appjar$fb_pathsep$CLASSPATH" \
+ -Dfindbugs.home="$findbugs_home"\
+ $fb_maxheap $fb_jvmargs $fb_mainclass ${@:+"$@"} $fb_appargs
+
+# vim:ts=3
--- /dev/null
+Adding Detectors to FindBugs
+May 12, 2003
+Updated June 6, 2003 (detector meta-information, cleanups)
+
+===============
+1. Introduction
+===============
+
+FindBugs uses a plugin-based approach to adding detectors.
+This makes it easy for users to add their own detectors alongside
+the ones that come built in.
+
+Basic idea: FindBugs has some Jar files in a "plugins" directory.
+At startup, each of those jar files is checked for a "findbugs.xml"
+file. That XML file registers instances of Detectors, as well
+as particular "bug patterns" that the detector reports.
+
+At startup, FindBugs loads all plugin Jar files. At analysis time,
+all detectors named in the findbugs.xml files from those plugins
+are instantiated and applied to analyzed class files.
+
+In order to format reported BugInstances as text for display,
+a messages file is loaded from the plugin. In order to support multiple
+language translations, a locale search is performed in a manner
+similar to the handling of resource bundles. For example, if the
+locale is "pt_BR", then the files
+
+ messages_pt_BR.xml
+ messages_pt.xml
+ messages.xml
+
+are tried, in that order.
+
+The "findbugs.xml" and "messages.xml" files used by the standard FindBugs
+bug pattern detectors (coreplugin.jar) can be found in the "etc" directory
+of the findbugs source distribution.
+
+
+============================
+2. Example findbugs.xml file
+============================
+
+<DetectorPlugin>
+
+ <Detector class="org.foobar.findbugs.FindUnreleasedLocks" speed="slow" />
+ <Detector class="org.foobar.findbugs.ExperimentalDetector" speed="fast" disabled="true" />
+
+ <!-- More Detector elements would go here... -->
+
+ <BugPattern type="UBL_UNRELEASED_LOCK" abbrev="UL" category="MT_CORRECTNESS" />
+
+ <!-- More BugPattern elements would go here... -->
+
+</DetectorPlugin>
+
+
+======================================
+3. Meaning of elements in findbugs.xml
+======================================
+
+ <DetectorPlugin> a collection of <Detector> and <BugPattern> elements.
+ Each plugin Jar file can (and usually will) provide multiple detectors
+ and define multiple bug patterns.
+
+ <Detector> specifies a class which implements the edu.umd.cs.findbugs.Detector
+ interface and has a constructor that takes a single parameter of type
+ edu.umd.cs.findbugs.BugReporter. This element has three possible attributes:
+
+ 1. The required "class" attribute specifies the Detector class.
+
+ 2. The optional "disabled" attribute, if set to "true", means
+ that by default, the detector will be disabled at runtime.
+ This is useful for detectors that aren't quite ready for prime time.
+
+ 3. The required "speed" attribute supplies a value to be shown in the
+ "Settings->Configure Detectors" dialog. It gives the user an idea of
+ how expensive the analysis will be to perform. The value of this
+ attribute should be one of "fast", "moderate", or "slow".
+
+ <BugPattern> specifies a kind of bug that will be reported.
+ It has three required attributes:
+
+ 1. "type" is a unique code identifying the bug. Only one BugPattern
+ can have a a particular type.
+
+ 2. "abbrev" is a short alphanumeric code for the bug.
+ Note that multiple BugPatterns can use the same abbreviation
+ if they are related. (See the BugCode element in messages.xml).
+
+ 3. "category" can be one of categories defined in the core plugin's messages.xml:
+
+ CORRECTNESS - code that was probably not what the developer intended
+ BAD_PRACTICE - violations of recommended and essential coding practice
+ STYLE - code that is confusing, anomalous, or written in a way that that leads itself to errors
+ MT_CORRECTNESS - multithreaded correctness issues
+ MALICIOUS_CODE - a potential vulnerability if exposed to malicious code
+ PERFORMANCE - a performance issue
+ I18N - internationalization and locale
+
+ or you may create your own category, in which case you should define
+ it in a <BugCategory> element in _your_ messages.xml file.
+
+============================
+4. Example messages.xml file
+============================
+
+<MessageCollection>
+
+ <Detector class="org.foobar.findbugs.FindUnreleasedLocks" >
+ <Details>
+ <![CDATA[
+ <p> This detector looks for JSR-166 locks that are not released on all paths
+ out of a method. Because it performs dataflow analysis, it is fairly slow.
+ ]]>
+ </Details>
+ </Detector>
+
+ <!-- More Detector nodes would go here... -->
+
+ <BugPattern type="UBL_UNRELEASED_LOCK">
+ <ShortDescription>Lock not released on all paths out of method</ShortDescription>
+
+ <LongDescription>{1} does not release lock on all paths out of method</LongDescription>
+
+ <Details>
+ <![CDATA[
+ <p> A JSR-166 lock acquired in this method is not released on all paths
+ out of the method. This could result in a deadlock if another thread
+ tries to acquire the lock. Generally, you should use a finally
+ block to ensure that acquired locks are always released.
+ ]]>
+ </Details>
+ </BugPattern>
+
+ <!-- More BugPattern nodes would go here... -->
+
+ <BugCode abbrev="UL">Unreleased locks</BugCode>
+
+ <!-- More BugCode nodes would go here... -->
+
+</MessageCollection>
+
+
+======================================
+5. Meaning of elements in messages.xml
+======================================
+
+ <MessageCollection> is the top level element
+
+ <BugCategory> elements optionally describe any categories you
+ may have created for your bug patterns. You can skip these if
+ you are using only the categories defined by the core plugin.
+
+ The <Description> child element has a brief (a word or three)
+ description of the category. The <Abbreviation> child element
+ is typically a single capital latter. The optional <Details>
+ child element may describe it in more detail (but no markup).
+
+ <Detector> holds meta-information about a Detector in the plugin.
+ The required "class" attribute specifies the Detector class.
+ Detector elements much have the following child elements:
+
+ The <Details> child element has a brief HTML description of the Detector.
+ It should have HTML markup that would be valid in a BODY element.
+ It should be specified in a CDATA section so that the HTML
+ tags are not misinterpreted as XML.
+
+ <BugPattern> holds all of the human-readable messages for the bug pattern
+ identified by the "type" attribute. The type corresponds to the
+ type attribute of the BugPattern elements described in findbugs.xml.
+ BugPattern elements must have the following child elements:
+
+ <ShortDescription> this is used for when "View->Full Descriptions"
+ is turned off in the GUI, and it's also used as the title for
+ descriptions in the Details window.
+
+ <LongDescription> this is used for when "View->Full Descriptions"
+ is turned on in the GUI, and for output using the command line UI.
+ The placeholders in the long description ({0}, {1}, etc.)
+ refer to BugAnnotations attached to the BugInstances reported by
+ the detector for this bug pattern. You may also use constructs
+ like {1.name} or {1.returnType}.
+
+ <Details> this is the descriptive text to be used in the Details
+ window. It consists of HTML markup to appear in the BODY element of an HTML
+ document. It should be specified in a CDATA section so that the HTML
+ tags are not misinterpreted as XML.
+
+ <BugCode> is the text which describes the common characteristic of all
+ of the BugPatterns which share an abbreviation. In the example above,
+ the abbreviation "UL" is for bugs in which a lock is not released.
+ The text of a BugCode element is shown for tree nodes in the GUI
+ which group bug instances by "bug type".
--- /dev/null
+<html>
+ <head>
+ <title>FindBugs Change Log</title>
+ <link rel="stylesheet" type="text/css" href="findbugs.css">
+
+ </head>
+
+ <body>
+
+ <table width="100%">
+ <tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+ <td align="left" valign="top">
+
+ <h1>
+ FindBugs Change Log, Version 1.3.0
+ </h1>
+
+ <p> Changes since version 1.2.1</p>
+ <ul>
+ <li>New Detectors</li>
+ <ul>
+ <li>edu.umd.cs.findbugs.detect.NoteDirectlyRelevantTypeQualifiers</li>
+ <li>edu.umd.cs.findbugs.detect.ReflectiveClasses</li>
+ <li>edu.umd.cs.findbugs.detect.SynchronizationOnSharedBuiltinConstant</li>
+ <ul>
+ <li>DL_SYNCHRONIZATION_ON_SHARED_CONSTANT
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.OverridingEqualsNotSymmetrical</li>
+ <ul>
+ <li>EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.CheckTypeQualifiers</li>
+ <ul>
+ <li>TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED</li>
+ <li>TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED</li>
+ <li>TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK</li>
+ <li>TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK</li>
+ </ul>
+ </ul>
+ <li>New Reports (existing detectors)</li>
+ <ul>
+ <li>edu.umd.cs.findbugs.detect.FindHEmismatch</li>
+ <ul>
+ <li>EQ_DOESNT_OVERRIDE_EQUALS </li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.Naming
+ <ul>
+ <li>NM_WRONG_PACKAGE</li>
+ <li>NM_WRONG_PACKAGE_INTENTIONAL</li>
+ <li>NM_SAME_SIMPLE_NAME_AS_SUPERCLASS</li>
+ <li>NM_SAME_SIMPLE_NAME_AS_INTERFACE</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.FindRefComparison</li>
+ <ul>
+ <li>EC_UNRELATED_TYPES_USING_POINTER_EQUALITY</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.IncompatMask</li>
+ <ul>
+ <li>BIT_SIGNED_CHECK</li>
+ <li>BIT_SIGNED_CHECK_HIGH_BIT</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.LazyInit</li>
+ <ul>
+ <li>LI_LAZY_INIT_UPDATE_STATIC</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.FindDeadLocalStores</li>
+ <ul>
+ <li>DLS_DEAD_STORE_OF_CLASS_LITERAL</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.MethodReturnCheck</li>
+ <ul>
+ <li>RV_RETURN_VALUE_IGNORED_BAD_PRACTICE</li>
+ <li>RV_EXCEPTION_NOT_THROWN</li>
+ </ul>
+ </ul>
+ <li>Changes to Existing Reports</li>
+ <ul>
+ <li>NS_NON_SHORT_CIRCUIT: BAD_PRACTICE -> STYLE</li>
+ <li>NS_DANGEROUS_NON_SHORT_CIRCUIT: CORRECTNESS -> STYLE</li>
+ <li>RC_REF_COMPARISON: CORRECTNESS -> BAD_PRACTICE</li>
+ </ul>
+ <li>GUI Changes</li>
+ <ul>
+ <li>Added importing and exporting of bug filters</li>
+ <li>Better handling of failed analysis runs</li>
+ <li>Added "-look" parameter for selecting look-and-feel</li>
+ <li>Fixed incorrect package filtering</li>
+ <li>Fixed issue where "synchronized" was not syntax-highlighted</li>
+ </ul>
+ <li>Ant-task Changes</li>
+ <ul>
+ <li>Refactored common ant-task code to AbstractFindBugsTask</li>
+ <li>Added tasks for computeBugHistory, convertXmlToText, filterBugs, mineBugHistory, setBugDatabaseInfo</li>
+ </ul>
+ <li>Manual</li>
+ <ul>
+ <li>Updates to GUI section, including new screenshots</li>
+ <li>Added description of rejarForAnalysis</li>
+ <li>Revamp of data-mining section</li>
+ </ul>
+ <li>Other Major</li>
+ <ul>
+ <li>Internal restructuring for lower memory overhead</li>
+ </ul>
+ <li>Other Minor</li>
+ <ul>
+ <li>Fixed typo: was STCAL_STATIC_SIMPLE_DATA_FORMAT_INSTANCE now STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE</li>
+ <li>-outputFile parameter became -output</li>
+ <li>More sensitivity and specificity inLazyInit detector</li>
+ <li>More sensitivity and specificity in Naming detector</li>
+ <li>More sensitivity and specificity in UnreadFields detector</li>
+ <li>More sensitivity in FindNullDeref detector</li>
+ <li>More sensitivity in FindBadCast2 detector</li>
+ <li>More specificity in FindReturnRef detector</li>
+ <li>Many other tweaks and bugfixes</li>
+ </ul>
+ </ul>
+
+ <p> Changes since version 1.2.0</p>
+ <ul>
+ <li>Bug fixes:
+ <ul>
+ <li><a href="http://fisheye2.cenqua.com/changelog/findbugs/?cs=8219">Fix</a> <a href="http://sourceforge.net/tracker/index.php?func=detail&aid=1726946&group_id=96405&atid=614693">bug</a> with detectors that were requested to be disabled but were enabled due to requirements of other detectors.</li>
+ <li>Fix bugs in incremental analysis within Eclipse plugin</li>
+ <li>Fix some analysis errors</li>
+ <li>Fix some threading bugs in GUI2</li>
+ <li>Report version as version when it was compiled, not when it was run</li>
+ <li>Copy analysis time stamp when filtering or transforming analysis files.</li>
+ </ul>
+ <li>Enabled StaticCalendarDetector
+ </li>
+ <li>Reworked GUI2 to use standard FindBugs filters
+ </li>
+ <ul>
+ <li>Allow a suppression filter to be stored in a project and persisted to the XML representation of a project.
+ </li>
+ </ul>
+
+ <li>Move away from old GUI2 save format (a directory containing an xml file and another file containing serialized filters).
+ </li>
+ <li>Supprt/recommend use of two new file extensions/formats:
+ <dl><dt>.fba - FindBugs Analysis File</dt>
+ <dd>Exactly the same as an existing bug collection file stored in XML format, but using a distinct file extension
+ to make it easier to figure out which xml files contain FindBugs results.</dd>
+ <dt>.fbp - FindBugs Project File</dt><dd>Contains just the information needed to run FindBugs and display the results (e.g., the files to be analyzed, the auxilary class path and the location of source files)</dl>
+ </dd></li>
+ </ul>
+ </p>
+ <p> Changes since version 1.1.3</p>
+ <ul>
+ <li>Added -xml:withAbridgedMessages option to generate xml containing shorter messages.
+ The messages will be shorted by doing things like eliding package names, and leaving off
+ the source line from the LongMessage.
+ These messages are appropriate if being used in a context where
+ the non-message components of the bug annotations will be used to provide more information
+ (e.g., clicking on the message for a MethodAnnotation will display the source for the method).
+ <ul><li>FindBugsDisplayFeatures.setAbridgedMessages(true) can be used to generate abridged messages
+ when FindBugs is being accessed directly (not via generated XML) from a GUI or IDE.
+ </li>
+ </ul>
+ <li>In null pointer analysis, try to be better about always showing two locations: where it is known null and
+ where it is dereferenced.
+ <li>Interprocedural analysis of which methods return nonnull values
+ <li>Use method calls to select order in which classes are analyzed, and order in which methods
+ are analyzed, to improve interprocedural analysis results.
+ <li>Significant improvements in memory footprint, memory allocation and CPU utilization
+ (20-30% reduction in all three)
+ <li>Added a project name, to provide better descriptions in the HTML output.
+ <li>Added new bug pattern: Casting to char, or bit masking with nonnegative value, and then checking to see
+ if the result is negative.
+ <li>Stopped reporting transient fields
+ of classes not marked as serializable. Transient is used by other persistence frameworks.
+ <li>Improvements to detector for SQL injection (Thanks to <a href="http://www.clock.org/~matt">Matt Hargett</a> for
+ his contributions
+ <li>Changed open/save options in GUI2 to not distinguish between FindBugs projects
+ and saved FindBugs analysis results.
+ <li>Improvements to detection of serious non-short-circuit evaluation.
+ <li>Updated Japanese localization (thanks to Ruimo Uno)
+
+ <li>Eclipse plugin changes:
+ <ul>
+ <li>Created Bug User Annotations and Bug Tree Views
+ <li>Use different icons for different bug priorities
+ <li>Provide more information in Bug Details view
+ </ul>
+ </ul>
+
+ <p>
+ Changes since version 1.1.2:
+ </p>
+ <ul>
+ <li>Fixed broken Ant task
+ <li>Added running ant task to smoketest
+ <li>Added validating xml and html output to smoketest
+ <li>Fixed some (but not all) issues with html output validation
+ <li>Added check for x.equals(x) and x.compareTo(x)
+ <li>Various bug fixes
+ </ul>
+ <p>
+ Changes since version 1.1.1:
+ </p>
+ <ul>
+ <li>
+ Added check for infinite iterative loops
+ </li>
+ <li>
+ Added check for use of incompatible types in a collection (e.g.,
+ checking to see if a Set<String> contains a StringBuffer).
+ </li>
+ <li>
+ Added check for invocations of equals or hashCode on a URL,
+ which,
+ <a
+ href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">surprising
+ many people</a>, requires DNS resolution.
+ </li>
+ <li>
+ Added check for classes that define compareTo but not equals;
+ such classes can exhibit some anomalous behavior (e.g., they are
+ treated differently by PriorityQueues in Java 5 and Java 6).
+ </li>
+ <li>
+ Added a check for useless self operations (e.g., x < x or x ^ x).
+ </li>
+ <li>
+ Fixed a datarace that could cause the GUI to fail on startup
+ </li>
+ <li>
+ Partial internationalization of the new GUI
+ </li>
+ <li>
+ Fix bug in "Redo analysis" option of new GUI
+ </li>
+ <li>
+ Tuning to reduce false positives
+ </li>
+ <li>
+ Fixed a bug in null pointer analysis that was generating false
+ positive null pointer warnings on exception paths. Fixing this
+ bug eliminates about 1/4 of the warnings on null pointer
+ exceptions on exception paths.
+ </li>
+ <li>
+ Fixed a bug in the processing of phi nodes for fields in the null
+ pointer analysis
+ </li>
+ <li>
+ Applied contributed patch that provides more quick fixes in
+ Eclipse plugin.
+ </li>
+ <li>
+ Fixed a number of bugs in the Eclipse auto update sites, and in the way
+ date qualifiers were being used in the Eclipse plugin. You may need to manually
+ disable your existing version of the plugin and download the 1.1.2 from the update
+ site to get the automatic update function working correctly.
+ The Eclipse update sites are described at <a href="http://findbugs.cs.umd.edu/eclipse/">http://findbugs.cs.umd.edu/eclipse/</a>.
+
+ </li>
+ <li>
+ Fixed progress bar in Eclipse plugin
+ </li>
+ <li>
+ A number of other bug fixes.
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 1.1.0:
+ </p>
+ <ul>
+ <li>
+ less scanning of classes not on the analysis path (This was
+ causing some performance problems.)
+ </li>
+ <li>
+ no unread field warnings for fields annotated with
+ javax.persistent or javax.ejb3
+ </li>
+ <li>
+ Eclipse plugin
+ <ul>
+ <li>
+ bug annotation info displayed in Bug Details tab
+ </li>
+ <li>
+ .fbwarnings data file now stored in .metadata (not in the
+ project itself)
+ </li>
+ </ul>
+ </li>
+ <li>
+ new SE_BAD_FIELD_INNER_CLASS pattern
+ </li>
+ <li>
+ updates to Japanese translation (ruimo)
+ </li>
+ <li>
+ fix some internal slashed/dotted path confusion
+ </li>
+ <li>
+ other minor improvements
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 1.0.0:
+ </p>
+
+ <ul>
+ <li>
+ Overall, the change from FindBugs 1.0.0 to FindBugs 1.1.0 has
+ been a big change. We've done a lot of work in a lot of areas,
+ and aren't even going to try to enumerate all the changes.
+ </li>
+ <li>
+ We spent a lot of time reviewing the results generated by
+ FindBugs for open source and commercial code bases, and made a
+ number of changes, small and large, to minimize the number of
+ false positives. Our primary focus for this was warnings reported
+ as high and medium priority correctness warnings. Our internal
+ evaluation is that we produce very few high/medium priority
+ correctness warnings where the analysis is actually wrong, and
+ that more than 75% of the high/medium priority correctness
+ warnings correspond to real coding defects that need addressing
+ in the source code. The remaining 25% are largely cases such as a
+ branch or statement that if taken would lead to an error, but in
+ fact is a dead branch or statement that can never be taken. Such
+ coding is confusing and hard to maintain, so it should arguably
+ be fixed, but it is unlikely to actually result in an error
+ during execution. Thus, some might classify those warnings as
+ false positives.
+
+ </li>
+ <li>
+ We've substantially improved the analysis for errors that could
+ result in null pointer dereferences. Overall, our experience has
+ been that these changes have roughly doubled the number of null
+ pointer errors we detect, without increasing the number of false
+ positives (in fact, our false positive rate has gone down). The
+ improvements are due to four factors:
+ <ul>
+ <li>
+ By default, we now do some interprocedural analysis to
+ determine methods that unconditionally dereference their
+ parameters.
+ </li>
+ <li>
+ FindBugs also comes with a model of which JDK methods
+ unconditionally dereference their parameters.
+ </li>
+ <li>
+ We do limited tracking of fields, so that we can detect null
+ values stored in fields that lead to exceptions.
+ </li>
+ <li>
+ We implemented a new analysis technique to find guaranteed
+ dereferences. Consider the following example:
+
+ <code>
+ <pre>public int f(Object x, boolean b) {
+ int result = 0;
+ if (x == null) result++;
+ else result--;
+ // at this point, we know x is null on a simple path
+ if (b) {
+ // at this point, x is only null on a complex path
+ // we don't know if the path in which x is null and b is true is feasible
+ return result + x.hashCode();
+ }
+ else {
+ // at this point, x is only null on a complex path
+ // we don't know if the path in which x is null and b is false is feasible
+ return result - x.hashCode();
+ }
+</pre>
+ </code>
+
+ <p>
+ FindBugs 1.0 used forward dataflow analysis to determine
+ whether each value is definitely null, null on a simple path,
+ possible null on a complex path, or definitely nonnull. Thus,
+ at the statement where
+ <code>
+ result
+ </code>
+ is decremented, we know that
+ <code>
+ x
+ </code>
+ is definitely null, and at the point before
+ <code>
+ if (b)
+ </code>
+ , we know that
+ <code>
+ x
+ </code>
+ is null on a simple path. If
+ <code>
+ x
+ </code>
+ were to be dereferenced here, we would generate a warning,
+ because if the else branch of the
+ <code>
+ if (x == null)
+ </code>
+ were ever taken, a null pointer exception would result.
+ </p>
+
+ <p>
+ However, in both the then and else branches of the
+ <code>
+ if (b)
+ </code>
+ statement,
+ <code>
+ x
+ </code>
+ is only null on a complex path that may be infeasible. It
+ might be that the program logic is such that if
+ <code>
+ x
+ </code>
+ is null, then
+ <code>
+ b
+ </code>
+ is never true, so generating a warning about the dereference
+ in the then clause might be a false positive. We could try to
+ analyze the program to determine whether it is possible for
+ <code>
+ x
+ </code>
+ to be null and
+ <code>
+ b
+ </code>
+ to be true, but that can be a hard analysis problem.
+ </p>
+
+ <p>
+ However,
+ <code>
+ x
+ </code>
+ is dereferenced in both the then
+ <em>and</em> else branches of the
+ <code>
+ if (b)
+ </code>
+ statement. So at the point immediately before
+ <code>
+ if (b)
+ </code>
+ , we know that
+ <code>
+ x
+ </code>
+ is null on a simple path
+ <em>and</em> that
+ <code>
+ x
+ </code>
+ is guaranteed to be dereferenced on all paths from this point
+ forward. FindBugs 1.1 performs a backwards data flow analysis
+ to determine the values that are guaranteed to be
+ dereferenced, and will generate a warning in this case.
+ </p>
+ </li>
+ </ul>
+ <p>
+ The following screen shot of our new GUI shows an example of
+ this analysis, as well as showing off our new GUI and points out
+ a limitation of our current plugins for Eclipse and Netbeans.
+ The screen shot shows a null pointer bug in HelpDisplay.java.
+ The test for
+ <code>
+ href!=null
+ </code>
+ on line 78 suggests that
+ <code>
+ href
+ </code>
+ could be null. If it is, then
+ <code>
+ href
+ </code>
+ will be dereferenced on either line 87 or on line 90, generating
+ a NPE. Note that our analysis here also understands that passing
+ <code>
+ href
+ </code>
+ to
+ <code>
+ URLEncoder.encode
+ </code>
+ will deference it, and thus treats line 87 as a dereference,
+ even though
+ <code>
+ href
+ </code>
+ is not actually dereferenced at that line. Within our new GUI,
+ all of these locations are highlighted and listed in the summary
+ panel. In the original GUI (and in HTML output) we list all of
+ the locations, but only the primary location is highlighted by
+ the original GUI. In the Eclipse and Netbeans plugins, only the
+ primary location is displayed; fixing this is on our todo list
+ (contributions welcome).
+ </p>
+ <p>
+ <img src="guaranteedDereference.png" alt="">
+
+
+ </p>
+
+ </li>
+ <li>
+ Preliminary support for detectors using the frameworks other than
+ BCEL, such as the
+ <a href="http://asm.objectweb.org/">ASM</a> bytecode framework.
+ You may experiment with writing ASM-based detectors, but beware
+ the API may still change (which could possibly also affect
+ BCEL-based detectors). In general, we've started trying to move
+ away from a deep dependence on BCEL, but that change is only
+ partially complete. Probably best to just avoid this until we
+ complete more work on this. This change is only visible to
+ FindBugs plugin developers, and shouldn't be visible to FindBugs
+ users.
+ </li>
+ <li>
+ <p>
+ Bug categories (CORRECTNESS, MT_CORRECTNESS, etc.) are no longer
+ hard-coded, but rather defined in xml files associated with
+ plugins, including the core plugin which defines the standard
+ categories. Third-party plugins can define their own categories.
+ </p>
+ </li>
+ <li>
+ <p>
+ Several bug patterns have been moved from CORRECTNESS and STYLE
+ into a new category, BAD_PRACTICE. The English localization of
+ STYLE has changed from "Style" to "Dodgy."
+ </p>
+ <p>
+ In general, we've worked very hard to limit CORRECTNESS bugs to
+ be real programming errors and sins of commission. We have
+ reclassified as BAD_PRACTICE a number of bad design practices
+ that result in overly fragile code, such as defining an equals
+ method that doesn't accept null or defining class with a equals
+ method that inherits hashCode from class Object.
+ </p>
+ <p>
+ In general, our guidelines for deciding whether a bug should be
+ classified as CORRECTNESS, BAD_PRACTICE or STYLE are:
+ </p>
+ <dl>
+ <dt>
+ CORRECTNESS
+ </dt>
+ <dd>
+ A problem that we can recognize with high confidence and is an
+ issue that we believe almost all developers would want to
+ examine and address. We recommend that software teams review
+ all high and medium priority warnings in their entire code
+ base.
+ </dd>
+ <dt>
+ BAD_PRACTICE
+ </dt>
+ <dd>
+ A problem that we can recognize with high confidence and
+ represents a clear violation of recommended and standard coding
+ practice. We believe each software team should decide which bad
+ practices identified by FindBugs it wants to prohibit in the
+ team's coding standard, and take action to remedy violations of
+ those coding standards.
+ </dd>
+ <dt>
+ STYLE
+ </dt>
+ <dd>
+ These are places where something strange or dodgy is going on,
+ such as a dead store to a local variable. Typically, less than
+ half of these represent actionable programming defects.
+ Reviewing these warnings in any code under active development
+ is probably a good idea, but reviewing all such warnings in
+ your entire code base might be appropriate only in some
+ situations. Individual or team programming styles can
+ substantially influence the effectiveness of each of these
+ warnings (e.g., you might have a coding practice or style in
+ your group that confuses one of the detectors into generating a
+ lot of STYLE warnings); you will likely want to selectively
+ suppress or report the STYLE warnings that are effective for
+ your group.
+ </dd>
+ </dl>
+ </li>
+ <li>
+ Released a preliminary version of a new GUI (known internally as
+ GUI2 -- not very creative, huh?)
+ </li>
+ <li>
+ Provided standard ways to mark user designations of bug warnings
+ (e.g., as NOT_A_BUG or SHOULD_FIX). The internal logic now
+ records this, it is represented in the XML file, and GUI2 allows
+ the designations to be applied (along with free-form user
+ annotations about each warning). The user designations and
+ annotations are not yet supported by the Eclipse plugin, but we
+ clearly want to support it in Eclipse shortly.
+ </li>
+ <li>
+ Added a check for a bad comparison with a signed byte with a
+ value not in the range -128..127. For example:
+ <code>
+ <pre>boolean find200(byte b[]) {
+ for(int i = 0; i < b.length; i++) if (b[i] == 200) return i;
+ return -1;
+}
+</pre>
+ </code>
+ </li>
+ <li>
+ Added a checking for testing if a value is equal to Double.NaN
+ (no value is equal to NaN, not even NaN).
+ </li>
+ <li>
+ Added a check for using a class with an equals method but no
+ hashCode method in a hashed data structure.
+ </li>
+ <li>
+ Added check for uncallable method of an anonymous inner class.
+ For example, in the following code, it is impossible to invoke
+ the initalValue method (because the name is misspelled and as a
+ result is doesn't override a method in ThreadLocal).
+ <code>
+ <pre>private static ThreadLocal serialNum = new ThreadLocal() {
+ protected synchronized Object initalValue() {
+ return new Integer(nextSerialNum++);
+ }
+ };
+</pre>
+ </code>
+ </li>
+ <li>
+ Added check for a dead local store caused by a switch statement
+ fallthrough
+ </li>
+ <li>
+ Added check for computing the absolute value of a random 32 bit
+ integer or of a hashcode. This is broken because
+ <code>
+ Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE
+ </code>
+ , and thus result of calling Math.abs, which is expected to be
+ nonnegative, will in fact be negative one time out of 2
+ <sup>
+ 32
+ </sup>
+ , which will invariably be the time your boss is demoing the
+ software to your customers.
+
+ </li>
+ <li>
+ More careful resolution of inherited methods and fields. Some of
+ the shortcuts we were taking in FindBugs 1.0.0 were leading to
+ inaccurate results, and it was fairly easy to address this by
+ making the analysis more accurate.
+ </li>
+ <li>
+ Overall, analysis times are about 1.6 times longer in FindBugs
+ 1.1.0 than in FindBugs 1.0.0. This is because we have enabled
+ substantial additional analysis at the default effort level (the
+ actual analysis engine is significantly faster than in FindBugs
+ 1.0). On a recent AMD Athlon processor, analyzing JDK1.6.0 (about
+ 1 million lines of code) requires about 15 minutes of wall clock
+ time.
+ </li>
+ <li>
+ Provided class and script (printClass) to print classfile in the
+ human readable format produced by BCEL
+ </li>
+ <li>
+ Provided -findSource option to setBugDatabaseInfo
+ </li>
+ </ul>
+
+
+ <p>
+ Changes since version 0.9.7:
+ </p>
+
+ <ul>
+ <li>
+ fix ObjectTypeFactory bug that was suppressing some bugs
+ </li>
+ <li>
+ opcode stack may determine definite zeros on some paths
+ </li>
+ <li>
+ opcode stack can track some constant string concatenations
+ (dbrosius)
+ </li>
+ <li>
+ default effort performs iterative opcode analysis (but min effort
+ does not)
+ </li>
+ <li>
+ default heap size upped to 384m
+ </li>
+ <li>
+ schema for XML output available: bugcollection.xsd
+ </li>
+ <li>
+ fixed some internal confusion between dotted and slashed class
+ names
+ </li>
+ <li>
+ New detectors
+ <ul>
+ <li>
+ CheckImmutableAnnotation.java: checks JCIP annotations
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated detectors
+ <ul>
+ <li>
+ BadRegEx.java: understands Pattern.LITERAL, warns about "."
+ </li>
+ <li>
+ FindUnreleasedLock.java: fewer false positives
+ </li>
+ <li>
+ DumbMethods.java: check for vacuous comparisons to MAX_INTEGER
+ or MIN_INTEGER, fix bugs detecting DM_NEXTINT_VIA_NEXTDOUBLE
+ </li>
+ <li>
+ FindPuzzlers.java: detect
+ <tt>n%2==1</tt>, detect toString() on array types
+ </li>
+ <li>
+ FindInconsistentSync2.java: detects IS_FIELD_NOT_GUARDED
+ </li>
+ <li>
+ MethodReturnCheck.java: add check for discarded newly
+ constructed values, increase priority of some ignored
+ constructed exceptions, better handling of bytecode compiled by
+ Eclipse
+ </li>
+ <li>
+ FindEmptySynchronizedBlock.java: better handling of bytecode
+ compiled by Eclipse
+ </li>
+ <li>
+ DoInsideDoPrivileged.java: warn if call to setAccessible isn't
+ in doPriviledged, don't report private methods
+ </li>
+ <li>
+ LoadOfKnownNullValue.java: fix bug that was reporting false
+ positives on
+ <code>
+ finally
+ </code>
+ blocks
+ </li>
+ <li>
+ CheckReturnAnnotationDatabase.java: better checks for unstarted
+ threads
+ </li>
+ <li>
+ ConfusionBetweenInheritedAndOuterMethod.java: fewer false
+ positives, fixed a package-handling bug
+ </li>
+ <li>
+ BadResultSetAccess.java: separate bug pattern for
+ PreparedStatements,
+ <code>
+ BRZA
+ </code>
+ category folded into
+ <code>
+ SQL
+ </code>
+ category
+ </li>
+ <li>
+ FindDeadLocalStores.java, FindBadCast2.java, DumbMethods.java,
+ RuntimeExceptionCapture.java: coalesce similar bugs within a
+ method into a single bug instance with multiple source lines
+ </li>
+ </ul>
+ </li>
+ <li>
+ Eclipse plugin
+ <ul>
+ <li>
+ plugin ID changed from
+ <tt>de.tobject.findbugs</tt> to
+ <tt>edu.umd.cs.findbugs.plugin.eclipse</tt>
+ </li>
+ <li>
+ support for findbugs eclipse auto-update site
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated test case files
+ <ul>
+ <li>
+ BadRegEx.java
+ </li>
+ <li>
+ JSR166.java
+ </li>
+ <li>
+ ConcurrentModificationBug.java
+ </li>
+ <li>
+ DeadStore.java
+ </li>
+ <li>
+ InstanceOf.java
+ </li>
+ <li>
+ LoadKnownNull.java
+ </li>
+ <li>
+ NeedsToCheckReturnValue.java
+ </li>
+ <li>
+ BadResultSetAccessTest.java
+ </li>
+ <li>
+ DeadStore.java
+ </li>
+ <li>
+ TestNonNull2.java
+ </li>
+ <li>
+ TestImmutable.java
+ </li>
+ <li>
+ TestGuardedBy.java
+ </li>
+ <li>
+ BadRandomInt.java
+ </li>
+ <li>
+ six test cases added to new
+ <code>
+ TigerTraps
+ </code>
+ directory
+ </li>
+ </ul>
+ </li>
+ <li>
+ fix bug that was generating duplicate uids
+ </li>
+ <li>
+ fix bug with
+ <code>
+ -onlyAnalyze some.package.*
+ </code>
+ on jdk1.4
+ </li>
+ <li>
+ fix regression bug in DismantleByteCode.getRefConstantOperand()
+ </li>
+ <li>
+ fix some minor bugs with the Swing GUI
+ </li>
+ <li>
+ reordered some bugInstances so that source line annotations come
+ last
+ </li>
+ <li>
+ removed references to unused java system properties
+ </li>
+ <li>
+ French translation updates (David Cotton)
+ </li>
+ <li>
+ Japanese translation updates (Hanai Shisei)
+ </li>
+ <li>
+ content cleanup for findbugs.xml and messages.xml
+ </li>
+ <li>
+ references to cvs hostname updated to
+ findbugs.cvs.sourceforge.net
+ </li>
+ <li>
+ documented xdoc output options, new
+ mineBugHistory/computeBugHistory options
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.9.6:
+ </p>
+
+ <ul>
+ <li>
+ performance improvements
+ </li>
+ <li>
+ ObjectType instances are cached to reduce memory footprint
+ </li>
+ <li>
+ for performance and memory reasons stateless detectors are no
+ longer cloned, must clear their own state between .class files
+ </li>
+ <li>
+ fixed bug in bytecode-set lookup for methods (was causing bad
+ results for IS2, perhaps others)
+ </li>
+ <li>
+ fix some OpcodeStack bugs with integer and long operations,
+ perform iterative analysis when effort is
+ <tt>max</tt>
+ </li>
+ <li>
+ HTML output includes LongMessage text again (regression in 0.95 -
+ 0.96)
+ </li>
+ <li>
+ New detectors
+ <ul>
+ <li>
+ CalledMethods.java: builds a list of invoked methods for other
+ detectors to consult (non-reporting)
+ </li>
+ <li>
+ UncallableMethodOfAnonymousClass.java: detect anonymous inner
+ classes that define methods that are probably intended to but
+ do not override methods in a superclass.
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated detectors
+ <ul>
+ <li>
+ FindFieldSelfAssignment.java: recognize separate fields with
+ the same name (one from superclass)
+ </li>
+ <li>
+ FindLocalSelfAssignment2.java: handles backward branches better
+ (Dave Brosius)
+ </li>
+ <li>
+ FindBadCast2.java: BC_NULL_INSTANCEOF changed to
+ NP_NULL_INSTANCEOF
+ </li>
+ <li>
+ FindPuzzlers.java: eliminate false positive on setDate() (Dave
+ Brosius)
+ </li>
+ </ul>
+ </li>
+ <li>
+ Eclipse plugin
+ <ul>
+ <li>
+ fix serious threading bug
+ </li>
+ <li>
+ preferences for Filters and effort (Peter Hendriks)
+ </li>
+ <li>
+ French localization (David Cotton)
+ </li>
+ <li>
+ fix bug when reporting inner classes (Peter Friese)
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated test case files
+ <ul>
+ <li>
+ Mwn.java (Carl Burke/Dave Brosius)
+ </li>
+ <li>
+ DumbMethodInvocations.java (Anto paul/Dave Brosius)
+ </li>
+ <!--sic-->
+ </ul>
+ </li>
+ <li>
+ XML output includes garbage collection duration
+ </li>
+ <li>
+ French messages updated (David Cotton)
+ </li>
+ <li>
+ Swing GUI shows file name after Load Bugs command
+ </li>
+ <li>
+ Ant task to launch the findbugs frame (Mark McKay)
+ </li>
+ <li>
+ miscellaneous code cleanup
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.9.5:
+ </p>
+
+ <ul>
+ <li>
+ Updated detectors
+ <ul>
+ <li>
+ FindNullDeref.java: respect NonNull and CheckForNull field
+ annotations
+ </li>
+ <li>
+ SerializableIdiom.java: detect non-private readObject and
+ writeObject methods
+ </li>
+ <li>
+ FindRefComparison.java: smarter array comparison detection
+ </li>
+ <li>
+ IsNullValueAnalysis.java: detect
+ <tt>null instanceof</tt>
+ </li>
+ <li>
+ FindLocalSelfAssignment2.java: suppress some false positives
+ (Dave Brosius)
+ </li>
+ <li>
+ FindUnreleasedLock.java: don't waste time processing classes
+ that don't refer to java.util.concurrent.locks
+ </li>
+ <li>
+ MutableStaticFields.java: report the source line (Dave Brosius)
+ </li>
+ <li>
+ SwitchFallthrough.java: better handling of System.exit() (Dave
+ Brosius)
+ </li>
+ <li>
+ MultithreadedInstanceAccess.java: better handling of
+ Servlet.init() (Dave Brosius)
+ </li>
+ <li>
+ ConfusionBetweenInheritedAndOuterMethod.java: now enabled
+ </li>
+ </ul>
+ </li>
+ <li>
+ Eclipse plugin
+ <ul>
+ <li>
+ background processing (Peter Friese)
+ </li>
+ <li>
+ internationalization, Japanese localization (Takashi Okamoto)
+ </li>
+ </ul>
+ </li>
+ <li>
+ findbugs
+ <tt>-onlyAnalyze</tt> option now works on windows platforms
+ </li>
+ <li>
+ mineBugHistory
+ <tt>-noTabs</tt> option for better alignment of output columns
+ </li>
+ <li>
+ filterBugs
+ <tt>-fixed</tt> option (also: will now recognize the most recent
+ version string)
+ </li>
+ <li>
+ XML output includes running time and memory usage data
+ </li>
+ <li>
+ miscellaneous minor corrections to the manual
+ </li>
+ <li>
+ better bytecode analysis of the
+ <tt>iinc</tt> instruction
+ </li>
+ <li>
+ fix bug in null pointer analysis
+ </li>
+ <li>
+ improved catch block heuristics
+ </li>
+ <li>
+ some type analysis tweaks
+ </li>
+ <li>
+ Bug priority changes
+ <ul>
+ <li>
+ DumbMethodInvocations.java: decrease priority of hard-coded
+ <tt>/tmp</tt> filenames
+ </li>
+ <li>
+ ComparatorIdiom.java: decrease priority of non-serializable
+ anonymous comparators
+ </li>
+ <li>
+ FindSqlInjection.java: decrease priority of appending a
+ constant or a static
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated bug explanations
+ <ul>
+ <li>
+ NM_VERY_CONFUSING (Dave Brosius)
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated test case files
+ <ul>
+ <li>
+ BadStoreOfNonSerializableObject.java
+ </li>
+ <li>
+ BadRandomInt.java
+ </li>
+ <li>
+ TestFieldAnnotations.java
+ </li>
+ <li>
+ UseInitCause.java
+ </li>
+ <li>
+ SqlInjection.java
+ </li>
+ <li>
+ ArrayEquality.java
+ </li>
+ <li>
+ BadIntegerOperations.java
+ </li>
+ <li>
+ Pilhuhn.java
+ </li>
+ <li>
+ InstanceOf.java
+ </li>
+ <li>
+ SwitchFallthrough.java (Dave Brosius)
+ </li>
+ </ul>
+ </li>
+ <li>
+ fix URL decoding bug when running under Java Web Start (Dave
+ Brosius)
+ </li>
+ <li>
+ distribution includes
+ <tt>project.xml</tt> file for NetBeans
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.9.4:
+ </p>
+ <ul>
+ <li>
+ New detectors
+ <ul>
+ <li>
+ VarArgsProblems.java
+ </li>
+ <li>
+ FindSqlInjection.java: now enabled
+ </li>
+ <li>
+ ComparatorIdiom.java: comparators usually implement
+ serializable
+ </li>
+ <li>
+ Naming.java: detect methods not overridden due to eponymously
+ typed args from different packages
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated detectors
+ <ul>
+ <li>
+ SwitchFallthrough.java: surpress some false positives
+ </li>
+ <li>
+ DuplicateBranches.java: surpress some false positives
+ </li>
+ <li>
+ IteratorIdioms.java: surpress some false positives
+ </li>
+ <li>
+ FindHEmismatch.java: surpress some false positives
+ </li>
+ <li>
+ QuestionableBooleanAssignment.java: finds more cases of
+ <tt>if (b=true)</tt> ilk
+ </li>
+ <li>
+ DumbMethods.java: detect int remainder by 1, delayed gc errors
+ </li>
+ <li>
+ SerializableIdiom.java: detect store of nonserializable object
+ into field of serializable class
+ </li>
+ <li>
+ FindNullDeref.java: fix potential exception
+ </li>
+ <li>
+ IsNullValue.java: fix potential exception
+ </li>
+ <li>
+ MultithreadedInstanceAccess.java: fix potential exception
+ </li>
+ <li>
+ PreferZeroLengthArrays.java: flag the method, not the line
+ </li>
+ </ul>
+ </li>
+ <li>
+ Remove some inadvertent dependencies on JDK 1.5
+ </li>
+ <li>
+ Sort order should be more consistent
+ </li>
+ <li>
+ XML output changes
+ <ul>
+ <li>
+ Option to sort XML bug output
+ </li>
+ <li>
+ Now contains instance IDs
+ </li>
+ <li>
+ uid no longer missing (was causing problems with fancy HTML
+ output)
+ </li>
+ <li>
+ Typo fixed
+ </li>
+ </ul>
+ </li>
+ <li>
+ Internal changes to track source files,
+ <tt>-sourceInfo</tt> option
+ </li>
+ <li>
+ Bug matching: first try exact bug pattern matching, option to
+ compare priorities, option to disable package moves
+ </li>
+ <li>
+ Architecture documentation in
+ <tt>design/architecture</tt>
+ </li>
+ <li>
+ Test cases move into their own CVS project
+ </li>
+ <li>
+ Don't report warnings that occur outside the analyzed classes
+ </li>
+ <li>
+ Fixes to the build.xml files
+ </li>
+ <li>
+ Better handling of @CheckReturnValue and @CheckForNull
+ annotations (also, some additional methods searched for check
+ return value and check for null)
+ </li>
+ <li>
+ Fixed some stream-closing bugs (one by
+ <tt>z-fb-user</tt>/Dave Brosius)
+ </li>
+ <li>
+ Bug priority changes
+ <ul>
+ <li>
+ increase priority of ignoring return value of
+ java.sql.Connection methods
+ </li>
+ <li>
+ increase priority of comparing classes like Integer using
+ <tt>==</tt>
+ </li>
+ <li>
+ decrease priority of IT_NO_SUCH_ELEMENT if we see any call to
+ <tt>next()</tt>
+ </li>
+ <li>
+ tweak priority of NM_METHOD_CONSTRUCTOR_CONFUSION
+ </li>
+ <li>
+ decrease priority of RV_RETURN_VALUE_IGNORED for an inherited
+ annotation that doesn't return same type as class
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated bug explanations
+ <ul>
+ <li>
+ RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE
+ </li>
+ <li>
+ DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED
+ </li>
+ <li>
+ IMA_INEFFICIENT_MEMBER_ACCESS (Dave Brosius)
+ </li>
+ <li>
+ some Japanese improvements to messages_ja.xml (
+ <tt>ruimo</tt>)
+ </li>
+ <li>
+ some German improvements to findbugs_de.properties (Dave
+ Brosius,
+ <tt>dvholten</tt>)
+ </li>
+ </ul>
+ </li>
+ <li>
+ Updated test case files
+ <ul>
+ <li>
+ BadIntegerOperations.java
+ </li>
+ <li>
+ SecondKaboom.java
+ </li>
+ <li>
+ OpenDatabase.java (Dave Brosius)
+ </li>
+ <li>
+ FindOpenStream.java (Dave Brosius)
+ </li>
+ <li>
+ BadRandomInt.java
+ </li>
+ </ul>
+ </li>
+ <li>
+ Source-lines info maintained for methods (handy for abstract and
+ native methods)
+ </li>
+ <li>
+ Remove surrounding opcodes from source line annotations
+ </li>
+ <li>
+ Better error when can't read file
+ </li>
+ <li>
+ Swing GUI: removed console pane from FindBugsFrame, fix missing
+ classes bug
+ </li>
+ <li>
+ Fixes to OpcodeStack.java
+ </li>
+ <li>
+ Detectors may attach a custom value to an OpcodeStack.Item (Dave
+ Brosius)
+ </li>
+ <li>
+ Filter.java: ability to add text messages to XML output, fix bug
+ with
+ <tt>-withMessages</tt>
+ </li>
+ <li>
+ SourceInfoMap supports ranges of source lines
+ </li>
+ <li>
+ Ant task supports the
+ <tt>timestampNow</tt> attribute
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.9.3:
+ </p>
+ <ul>
+ <li>
+ Substantial rework of datamining code
+ </li>
+ <li>
+ Removed bogus warnings about await on things other than Condition
+ not being in a loop
+ </li>
+ <li>
+ Fixed bug in OpcodeStack handling of dup2 of long/double values
+ </li>
+ <li>
+ Don't report array types as missing classes
+ </li>
+ <li>
+ Adjustment of some warnings on ignored return values
+ </li>
+ <li>
+ Added thread safety annotations from Java Concurrency in Practice
+ (no detectors written for these yet)
+ </li>
+ <li>
+ Added annotation for methods that, if overridden, should be
+ invoked by overriding methods via a call to super
+ </li>
+ <li>
+ Updated -html:fancy.xsl (Etienne Giraudy)
+ </li>
+ </ul>
+
+ <p>
+ Note: there was no version 0.9.2
+ </p>
+
+ <p>
+ Changes since version 0.9.1:
+ </p>
+ <ul>
+ <!-- New detectors -->
+ <li>
+ Embellish USM to find abstract methods that implement an
+ interface method (Dave Brosius)
+ </li>
+ <li>
+ New detector to find stores of literal booleans inside if or
+ while expressions (Dave Brosius)
+ </li>
+ <li>
+ New style detector to find final classes that declare protected
+ fields (Dave Brosius)
+ </li>
+ <li>
+ New detector to find subclass methods that simply forward,
+ verbatim, to the super class (Dave Brosius)
+ </li>
+ <li>
+ Detector to find instances where code is attempting to write an
+ object out via an implementation of DataOutput, but the object is
+ not guaranteed to be Serializable (Jon Christiansen, Bill Pugh)
+ </li>
+
+ <!-- Feature enhancements -->
+ <li>
+ Large (35%) analysis speedup (Bill Pugh)
+ </li>
+ <li>
+ Add line numbers to Swing GUI code panel (Dave Brosius)
+ </li>
+ <li>
+ Added effort options to Swing GUI (Dave Brosius)
+ </li>
+ <li>
+ Add ability to specify bugs file to open from command line for
+ GUI version, through -loadbugs (Phillip Martin)
+ </li>
+ <li>
+ New stylesheet for generating HTML: use option
+ <tt>-html:plain.xsl</tt> (Chris Nappin)
+ </li>
+ <li>
+ New stylesheet for generating HTML: use option
+ <tt>-html:fancy.xsl</tt> (Etienne Giraudy)
+ </li>
+ <li>
+ Updated Japanese bug message translations (Shisei Hanai)
+ </li>
+
+ <!-- Bug fixes -->
+ <li>
+ XHTML compliance fixes for bug details (Etienne Giraudy)
+ </li>
+ <li>
+ Various detector fixes (Shisei Hanai)
+ </li>
+ <li>
+ Fixed bugs in the project preferences dialog int the Eclipse
+ plugin (Takashi Okamoto, Thomas Einwaller)
+ </li>
+ <li>
+ Lowered priority of analysis thread in Swing GUI (David
+ Hovemeyer, suggested by Shisei Hanai and Jeffrey W. Badorek)
+ </li>
+ <li>
+ Fixed EclipsePlugin to correctly pick up auxclasspath entries
+ (Jon Christiansen)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.9.0:
+ </p>
+ <ul>
+ <li>
+ Fixed dependence on JRE 1.5: all features should work on JRE 1.4
+ again
+ </li>
+ <li>
+ Fixed -effort command line option handling for Swing GUI
+ </li>
+ <li>
+ Fixed conserveSpace and workHard attributes int Ant task
+ </li>
+ <li>
+ Added support for effort attribute in Ant task
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.8:
+ </p>
+ <ul>
+ <!-- New detectors and bug patterns -->
+ <li>
+ XMLFactoryBypass detector to find direct allocation of xml class
+ implementations (Dave Brosius)
+ </li>
+ <li>
+ InefficientMemberAccess detector to find accesses to owning class
+ private members (Dave Brosius)
+ </li>
+ <li>
+ DuplicateBranches detector checks switch statements too (Dave
+ Brosius)
+ </li>
+
+ <!-- Feature enhancements -->
+ <li>
+ FindBugs available from findbugs.sourceforge.net as Java Web
+ Start application (Dave Brosius)
+ </li>
+ <li>
+ Updated Japanese bug message translations (Shisei Hanai)
+ </li>
+ <li>
+ Improved bug detail message for covariant equals() (Shisei Hanai)
+ </li>
+ <li>
+ Modeling of instanceof checks is now enabled by default, making
+ the bad cast detector much more useful (Bill Pugh, David
+ Hovemeyer)
+ </li>
+ <li>
+ Support for detector ordering constraints in plugin descriptor
+ (David Hovemeyer)
+ </li>
+ <li>
+ Simpler option to control analysis effort: -effort:
+ <i>value</i>, where
+ <i>value</i> is one of
+ <code>
+ min
+ </code>
+ ,
+ <code>
+ default
+ </code>
+ , or
+ <code>
+ max
+ </code>
+ (David Hovemeyer)
+ </li>
+ <li>
+ Using -effort:max, FindNullDeref checks for null arguments passed
+ to methods which dereference them unconditionally (David
+ Hovemeyer)
+ </li>
+ <li>
+ FindNullDeref checks @Null and @NonNull annotations for
+ parameters and return values (David Hovemeyer)
+ </li>
+
+ <!-- Bug fixes -->
+ </ul>
+
+ <p>
+ Changes since version 0.8.7:
+ </p>
+
+ <ul>
+ <!-- New detectors and bug patterns -->
+ <li>
+ New detector to find duplicate code in if/else statements (Dave
+ Brosius)
+ </li>
+ <li>
+ Look for calls to wait() on Condition objects (David Hovemeyer)
+ </li>
+ <li>
+ Look for java.util.concurrent.Lock objects not released on every
+ path out of method (David Hovemeyer)
+ </li>
+ <li>
+ Look for calls to Thread.sleep() with a lock held (David
+ Hovemeyer)
+ </li>
+ <li>
+ More accurate detection of impossible casts (Bill Pugh, David
+ Hovemeyer)
+ </li>
+
+ <!-- Feature enhancements -->
+ <li>
+ Saved XML now contains project statistics (Jay Dunning)
+ </li>
+ <li>
+ Filter files can select by bug pattern type and warning priority
+ (David Hovemeyer)
+ </li>
+
+ <!-- Bug fixes -->
+ <li>
+ Restored some files inadvertently omitted from previous release
+ (Rohan Lloyd, David Hovemeyer)
+ </li>
+ <li>
+ Make sure detectors requiring JDK 1.5 runtime classes are only
+ executed if those classes are available (David Hovemeyer)
+ </li>
+ <li>
+ Don't display analysis error dialog unless there is really an
+ error (David Hovemeyer)
+ </li>
+ <li>
+ Updated and expanded French translations of bug patterns and
+ Swing GUI (Olivier Parent)
+ </li>
+ <li>
+ Fixed invalid character encoding in German Swing GUI translation
+ (Olivier Parent)
+ </li>
+ <li>
+ Fix locale used for date format in project stats (K. Hashimoto)
+ </li>
+ <li>
+ Fixed LongDescription elements in xml:withMessages output format
+ (K. Hashimoto)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.6:
+ </p>
+
+ <ul>
+ <!-- new detectors -->
+ <li>
+ Extend Naming detector to look for classes that are named
+ XXXException but that are not Exceptions (Dave Brosius)
+ </li>
+ <li>
+ New detector to find classes that expose semaphores in the public
+ implementation through the 'this' reference. (Dave Brosius)
+ </li>
+ <li>
+ New Style detector to find Struts Action/Servlet derived classes
+ that reference instance member variable not in synchronized
+ blocks. (Dave Brosius)
+ </li>
+ <li>
+ New Style detector to find classes that declare implementation of
+ interfaces that are already implemented by super classes (Dave
+ Brosius)
+ </li>
+ <li>
+ New Style detector to find circular dependencies between classes
+ (Dave Brosius)
+ </li>
+ <li>
+ New Style detector to find unnecessary math on constants (Dave
+ Brosius)
+ </li>
+ <li>
+ New detector to find equality comparisons using floating point
+ math (Jay Dunning)
+ </li>
+ <li>
+ New faster detector to find local self assignments (Bill Pugh)
+ </li>
+ <li>
+ New detector to find infinite recursive loops (Bill Pugh)
+ </li>
+ <li>
+ New detector to find for loops with an incorrect increment (Bill
+ Pugh)
+ </li>
+ <li>
+ New detector to find suspicious uses of BufferedReader.readLine()
+ and String.indexOf() (Bill Pugh)
+ </li>
+ <li>
+ New detector to find suspicious integer to double casts (David
+ Hovemeyer, Bill Pugh)
+ </li>
+ <li>
+ New detector to find invalid regular expression patterns (Bill
+ Pugh)
+ </li>
+ <li>
+ New detector to find Bloch/Gafter Java puzzlers (Bill Pugh)
+ </li>
+
+ <!-- feature enhancements -->
+ <li>
+ New system property to suppress reporting of DLS based on local
+ variable name (Glenn Boysko)
+ </li>
+ <li>
+ Enhancements to configuration dialog in Eclipse plugin, allow for
+ saving enabled detectors in Eclipse projects (Phil Crosby)
+ </li>
+ <li>
+ Sortable columns in detector dialog (Dave Brosius)
+ </li>
+ <li>
+ New tab in gui for showing bugs grouped by category (Dave
+ Brosius)
+ </li>
+ <li>
+ Improved German translation of Swing GUI (Thomas Kuehne)
+ </li>
+ <li>
+ Improved source file reporting in Emacs output format (Len Trigg)
+ </li>
+ <li>
+ Improvements to redundant null comparison detector (Bill Pugh)
+ </li>
+ <li>
+ Localization of run analysis and analysis error dialogs in Swing
+ GUI (K. Hashimoto)
+ </li>
+
+ <!-- Bug fixes -->
+ <li>
+ Don't scan equals methods in FindHEMismatch if code is native
+ (Greg Bentz)
+ </li>
+ <li>
+ French translation fixes (David Cotton)
+ </li>
+ <li>
+ Internationalization report fixes (K. Hashimoto)
+ </li>
+ <li>
+ Japanese translations updates (SHISEI Hanai)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.5:
+
+ </p>
+ <ul>
+ <!-- new detectors -->
+ <li>
+ New detector to find catch blocks that may inadvertently catch
+ runtime exceptions (Brian Goetz)
+ </li>
+ <li>
+ New detector to find objects that are instantiated based on
+ classes that only have static methods and fields, using the
+ synthesized constructor (Dave Brosius)
+ </li>
+ <li>
+ New detector to find calls to Thread.interrupted() in a non
+ static context, and especially with non currentThread() threads
+ (Dave Brosius)
+ </li>
+ <li>
+ New detector to find calls to equals() methods that use Object's
+ version. (Dave Brosius)
+ </li>
+ <li>
+ New detector to find Applets that call methods in the constructor
+ refering to the AppletStub (Dave Brosius)
+ </li>
+ <li>
+ New detector to find some cases of infinite recursion (Bill Pugh)
+ </li>
+ <li>
+ New detector to find dead stores to local variables (David
+ Hovemeyer, Bill Pugh)
+ </li>
+ <li>
+ Extend Dumb Method detector for toUpperCase(), toLowerCase()
+ without a locale, new Integer(1).toString(), new
+ XXX().getClass(), and new Thread() without a run implementation
+ (Dave Brosius)
+ <!-- feature enhancements -->
+ </li>
+ <li>
+ Ant task supports "errorProperty" attribute, which sets an Ant
+ property to "true" if an error occurs running FindBugs (Michael
+ Tamm)
+ </li>
+ <li>
+ Eclipse plugin allows filtering of warnings by bug category,
+ priority (David Hovemeyer)
+ </li>
+ <li>
+ Swing GUI allows filtering of warnings by bug category (David
+ Hovemeyer)
+ </li>
+ <li>
+ Ability to annotate methods using Java 1.5 annotations that
+ suppress FindBugs warnings (Bill Pugh)
+ </li>
+ <li>
+ New -adjustExperimental for lowering priority of BugPatterns that
+ are experimental (Dave Brosius)
+ </li>
+ <li>
+ Allow for command line options 'files' using the @ symbol (David
+ Hovemeyer)
+ </li>
+ <li>
+ New -adjustPriority command line option to for adjusting bug
+ priorites (David Hovemeyer)
+ </li>
+ <li>
+ Added an Edit menu (cut/copy/paste) to Swing GUI (Dave Brosius)
+ </li>
+ <li>
+ French translation supplied (David Cotton)
+ <!-- Bug fixes -->
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.4:
+
+ </p>
+ <ul>
+ <!-- new detectors -->
+ <li>
+ New detector for volatile references to arrays (Bill Pugh)
+ </li>
+ <li>
+ New detector to find instanceof usage where inheritance can be
+ determined statically (Dave Brosius)
+ </li>
+ <li>
+ New detector to find ResultSet.getXXX updateXXX calls using index
+ 0 (Dave Brosius)
+ </li>
+ <li>
+ New detector to find empty zip or jar entries (Bill Pugh)
+
+ <!-- feature enhancements -->
+ </li>
+ <li>
+ HTML output generation using built-in XSLT stylesheet or
+ user-defined stylesheet (David Hovemeyer)
+ </li>
+ <li>
+ Allow URLs to be specified to analyze zip/jar files, local
+ directories, and single classfiles (David Hovemeyer)
+ </li>
+ <li>
+ New command line option -onlyAnalyze restricts analysis to
+ selected classes and packages without reducing accuracy (David
+ Hovemeyer)
+ </li>
+ <li>
+ Allow Swing GUI to show source code in jar files on Windows
+ systems (Dave Brosius)
+
+ <!-- Bug fixes -->
+ </li>
+ <li>
+ Fix the Switch Fall Thru detector (Dave Brosius, David Hovemeyer,
+ Bill Pugh)
+ </li>
+ <li>
+ MacOS GUI fixes (Rohan Lloyd)
+ </li>
+ <li>
+ Fix false positive in BOA in case where method is correctly and
+ 'incorrectly' overridden (Dave Brosius)
+ </li>
+ <li>
+ Fixed memory blowup when analyzing methods which access a large
+ number of fields (David Hovemeyer)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.3:
+ </p>
+ <ul>
+ <li>
+ Initial and preliminary localization of the Swing GUI.
+ Translations by:
+ <ul>
+ <li>
+ German - Peter D. Stout, Holger Stenzhorn
+ </li>
+ <li>
+ Finnish - Juha Knuutila
+ </li>
+ <li>
+ Estonian - Tanel Lebedev
+ </li>
+ <li>
+ Japanese - Hanai Shisei
+ </li>
+ </ul>
+ </li>
+ <li>
+ Eliminated debug print statements inadvertently left enabled
+ </li>
+ <li>
+ Reverted some changes in the open stream detector: this should
+ fix some false positives that were introduced in the previous
+ release
+ </li>
+ <li>
+ Fixed a couple missing class reports
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.2:
+ </p>
+ <ul>
+
+ <!-- New detectors -->
+ <li>
+ New detector to find improperly overridden GUI Adapter classes
+ (Dave Brosius)
+ </li>
+ <li>
+ New detector to find improperly setup JUnit TestCases (Dave
+ Brosius)
+ </li>
+ <li>
+ New detector to find variables that mask class level fields (Dave
+ Brosius)
+ </li>
+ <li>
+ New detector to find comparisons of values computed with bitwise
+ operators that always yield the same result (Tom Truscott)
+ </li>
+ <li>
+ New detector to find unsafe getClass().getResource() calls (Bill
+ Pugh)
+ </li>
+ <li>
+ New detector to find GUI changes not in GUI thread but in static
+ main (Bill Pugh)
+ </li>
+ <li>
+ New detector to find calls to Collection.toArray() with
+ zero-length array argument; it is more efficient to pass an array
+ the size of the collection, which can be populated and returned
+ as the result (Dave Brosius)
+
+ <!-- Analysis improvements -->
+ </li>
+ <li>
+ Better suppression of false warnings in various detectors (Bill
+ Pugh, David Hovemeyer)
+ </li>
+ <li>
+ Enhancement to ReadReturnShouldBeChecked detector for skip()
+ (Dave Brosius)
+ </li>
+ <li>
+ Enhancement to DumbMethods detector (Dave Brosius)
+ </li>
+ <li>
+ Open stream detector does not report wrappers of streams passed
+ as method parameters (David Hovemeyer)
+
+ <!-- Feature enhancements -->
+ </li>
+ <li>
+ Cancel confirmation dialog in Swing GUI (Pete Angstadt)
+ </li>
+ <li>
+ Better relative path saving in Project file (Dave Brosius)
+ </li>
+ <li>
+ Detector Priority in GUI is now saved in prefs file (Dave
+ Brosius)
+ </li>
+ <li>
+ Controls in GUI to reorder source and classpath entries, and
+ ability to flip between Project details and bugs pages (Dave
+ Brosius)
+ </li>
+ <li>
+ In Swing GUI, analysis error dialog supports "Select All" and
+ "Copy" operations for easy generation of error reports (Dave
+ Brosius)
+ </li>
+ <li>
+ Complete translation of bug descriptions and messages into
+ Japanese (Hanai Shisei)
+
+ <!-- Bug fixes -->
+ </li>
+ <li>
+ Fixed bug in DroppedException detector (Dave Brosius)
+
+ <!-- Development stuff -->
+ </li>
+ <li>
+ The source distribution defaults to using JDK 1.5 javac to
+ compile, but support for compiling with JSR-14 prototype is still
+ supported
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.1:
+ </p>
+ <ul>
+ <li>
+ Fixed a critical ClassCastException bug (triggered if the
+ -workHard option was used, and an exception type was merged with
+ an array type during type inference)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.8.0:
+
+ </p>
+ <ul>
+ <li>
+ Disabled SwitchFallthrough detector to work around
+ NullPointerExceptions
+ </li>
+ <li>
+ Added some additional false positive suppression heuristics
+ </li>
+ </ul>
+
+ <p>
+ Also, two contributors to the 0.8.0 release were inadvertently
+ left out of the credits:
+
+ </p>
+ <ul>
+ <li>
+ Pete Angstadt fixed several problems in the Swing GUI
+ </li>
+ <li>
+ Francis Lalonde provided a task resource file for the FindBugs
+ Ant task
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.7.4:
+
+ </p>
+ <ul>
+ <li>
+ New detector to look for uses of "+" operator to concatenate
+ String objects in a loop (Dave Brosius)
+ </li>
+ <li>
+ Reference comparison detector looks for places where the argument
+ passed to the equals(Object) method isn't the same type as the
+ receiver object
+ </li>
+ <li>
+ Better suppression of false warnings in many detectors
+ </li>
+ <li>
+ Many improvements to Eclipse plugin (Andrei Loskutov, Peter
+ Friese)
+ </li>
+ <li>
+ Fixed problem with building Eclipse plugin on Windows (Thomas
+ Klaeger)
+ </li>
+ <li>
+ Open stream detector looks for unclosed PreparedStatement objects
+ (Thomas Klaeger, Rohan Lloyd)
+ </li>
+ <li>
+ Fix for open stream detector: it wasn't detecting close() methods
+ called through an invokeinterface instruction (Thomas Klaeger)
+ </li>
+ <li>
+ Refactoring of visitor classes to enforce use of accessors for
+ visited class features (Brian Goetz)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.7.3:
+
+ </p>
+ <ul>
+ <li>
+ Experimental modification of open stream detector to look for
+ non-escaping JDBC resources (connections and statements) that
+ aren't closed on all paths out of method
+ </li>
+ <li>
+ Eclipse plugin fixed so it compiles and runs on Eclipse 2.1.x
+ (Peter Friese)
+ </li>
+ <li>
+ Option to Swing GUI and command line to generate project file
+ using relative paths for archives, source directories, and aux
+ classpath entries (Dave Brosius)
+ </li>
+ <li>
+ Improvements to findbugs.bat script for launching FindBugs on
+ Windows (Dave Brosius)
+ </li>
+ <li>
+ Updated Japanese message translations (Hiroshi Okugawa)
+ </li>
+ <li>
+ Uncalled private methods are now reported as low priority, unless
+ they have the same name as another method in the class (which is
+ more likely to indicate an actual bug)
+ </li>
+ <li>
+ Added some missing data in the bug messages XML files
+ </li>
+ <li>
+ Fixed some problems building from source on Windows systems
+ </li>
+ <li>
+ Various minor bug fixes
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.7.2:
+
+ </p>
+ <ul>
+ <li>
+ Enhanced Eclipse plugin, which displays the detailed bug
+ description in a view (Phil Crosby)
+ </li>
+ <li>
+ Various tweaks to existing detectors to reduce false warnings
+ </li>
+ <li>
+ New command line option
+ <code>
+ -workHard
+ </code>
+ enables pruning of infeasible or unlikely exception edges, which
+ results in better accuracy in the open stream detector, at the
+ expense of a 30%-100% slowdown
+ </li>
+ <li>
+ New website and HTML documentation design
+ </li>
+ <li>
+ Documentation includes an HTML document with descriptions of all
+ bug patterns reported by FindBugs
+ </li>
+ <li>
+ Web page has a link to a
+ <a href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Japanese
+ translation</a> of the FindBugs manual, contributed by Hiroshi
+ Okugawa
+ </li>
+ <li>
+ Changed the Inconsistent Synchronization detector so that fields
+ synchronized 50% of the time (or more) are reported as medium
+ priority bugs (previously they were reported as low)
+ </li>
+ <li>
+ New detector to find code that catches
+ IllegalMonitorStateException
+ </li>
+ <li>
+ New detector to find private methods that are never called
+ </li>
+ <li>
+ New detector to find suspicious uses of non-short-circuiting
+ boolean operators (
+ <code>
+ &
+ </code>
+ and
+ <code>
+ |
+ </code>
+ , rather than
+ <code>
+ &&
+ </code>
+ and
+ <code>
+ ||
+ </code>
+ )
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.7.1:
+
+ </p>
+ <ul>
+ <li>
+ Incorporated patched version of BCEL, which allows classes
+ compiled with JDK 1.5.0 beta to be analyzed
+ </li>
+ <li>
+ Fixed some bugs related to lookups of array classes
+ </li>
+ <li>
+ Fixed bug that prevented GUI from loading XML result files when
+ running under JDK 1.5.0 beta
+ </li>
+ <li>
+ Added new experimental bug detector, LazyInit, which looks for
+ potentially buggy lazy initializations of static fields
+ </li>
+ <li>
+ Because of long filenames, switched to distributing the source
+ archive as a zip file rather than a tar file
+ </li>
+ <li>
+ The 0.7.1 source tarfile was botched - 0.7.2 has a valid source
+ archive
+ </li>
+ <li>
+ Fixed some problems in the Ant build script
+ </li>
+ <li>
+ Fixed NullPointerException when checking Class-Path attribute for
+ Jar files without manifests
+ </li>
+ <li>
+ Generate version numbers for the core and UI Eclipse plugins
+ using the Version class; all version numbers are now in a common
+ location
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.7.0:
+
+ </p>
+ <ul>
+ <li>
+ Eclipse plugin (contributed by Peter Friese)
+ </li>
+ <li>
+ Source package structure rearranged: all source (other than
+ Eclipse plugin UI) is in the edu.umd.cs.findbugs package, or a
+ subpackage
+ </li>
+ <li>
+ Class-Path attributes of manifests of analyzed jar files are used
+ to set the aux classpath automatically (Peter D. Stout)
+ </li>
+ <li>
+ GUI starts in directory specified by user.home property (Peter D.
+ Stout)
+ </li>
+ <li>
+ Added -project option to GUI (Mikko T.)
+ </li>
+ <li>
+ Added -look:{plastic,gtk,native} option to GUI, for setting look
+ and feel (Mikko T.)
+ </li>
+ <li>
+ Fixed DataflowAnalysisException in inconsistent synchronization
+ detector
+ </li>
+ <li>
+ Ant task supports failOnError parameter (Rohan Lloyd)
+ </li>
+ <li>
+ Serializable class warnings are downgraded to low priority for
+ GUI classes
+ </li>
+ <li>
+ MWN detector will only report calls to wait(), notify(), and
+ notifyAll() methods that have the correct signature
+ </li>
+ <li>
+ FindBugs works with latest CVS version of BCEL
+ </li>
+ <li>
+ Zip and Jar files may be added to the source path
+ </li>
+ <li>
+ The GUI will automatically find source files residing in analyzed
+ Zip or Jar files
+ </li>
+ </ul>
+
+ <p>
+ Note that the version number jumped from 0.6.6 to 0.6.9; there
+ were no 0.6.7 or 0.6.8 releases.
+
+ </p>
+ <p>
+ Changes since version 0.6.9:
+ </p>
+ <ul>
+ <li>
+ Added -conserveSpace option to reduce memory use at the expense
+ of analysis precision
+ </li>
+ <li>
+ Bug fixes in findbugs.bat script: JAVA_HOME handling,
+ autodetection of FINDBUGS_HOME, missing output with -textui
+ </li>
+ <li>
+ Fixed NullPointerException when a missing class is encountered
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.6:
+
+ </p>
+ <ul>
+ <li>
+ The null pointer dereference detector is more powerful
+ </li>
+ <li>
+ Significantly improved heuristics and bug fixes in inconsistent
+ synchronization detector
+ </li>
+ <li>
+ Improved heuristics in open stream and dropped exception
+ detectors; fewer false positives should be reported
+ </li>
+ <li>
+ Save HTML summary in XML results files, rather than recomputing;
+ this makes loading results in GUI much faster
+ </li>
+ <li>
+ Report at most one String comparison using == or != per method
+ </li>
+ <li>
+ The findbugs.bat script on Windows autodetects FINDBUGS_HOME, and
+ doesn't open a DOS window when launching the GUI (contributed by
+ TJSB)
+ </li>
+ <li>
+ Emacs reporting format (contributed by David Li)
+ </li>
+ <li>
+ Various bug fixes
+ </li>
+ </ul>
+
+ <p>
+ Changes since 0.6.5:
+
+ </p>
+ <ul>
+ <li>
+ Rewritten inconsistent synchronization detector; accuracy is
+ significantly improved, and bug reports are prioritized
+ </li>
+ <li>
+ New detector to find self assignment (x=x) of local variables
+ (suggested by Jeff Martin)
+ </li>
+ <li>
+ New detector to find calls to wait(), notify(), and notifyAll()
+ on an object which is not obviously locked
+ </li>
+ <li>
+ Open stream detector now reports Readers and Writers
+ </li>
+ <li>
+ Fixed bug in finalizer idioms detector which caused spurious
+ warnings about failure to call super.finalize() (reported by Jim
+ Menard)
+ </li>
+ <li>
+ Fixed bug where output stream was not closed using non-XML output
+ (reported by Sigiswald Madou)
+ </li>
+ <li>
+ Fixed corrupted HTML bug detail message (reported by Trevor
+ Harmon)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.4:
+
+ </p>
+ <ul>
+ <li>
+ For redundant comparison of reference values, fixed false
+ positives resulting from duplication of code in finally blocks
+ </li>
+ <li>
+ Fixed false positives resulting from wrapped byte array streams
+ left open
+ </li>
+ <li>
+ Fixed bug in Ant task preventing output file from working
+ properly if a relative path was used
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.3:
+
+ </p>
+ <ul>
+ <li>
+ Fixed bug in Ant task where output would be corrupted, and added
+ a
+ <code>
+ timeout
+ </code>
+ attribute
+ </li>
+ <li>
+ Added -outputFile option to text UI, for explicitly specifying an
+ output file
+ </li>
+ <li>
+ GUI has a summary window, for statistics about overall bug
+ densities (contributed by Mike Fagan)
+ </li>
+ <li>
+ Find redundant comparisons of reference values
+ </li>
+ <li>
+ More accurate detection of Strings compared with == and !=
+ operators
+ </li>
+ <li>
+ Detection of other reference types which should generally not be
+ compared with == and != operators; Boolean, Integer, etc.
+ </li>
+ <li>
+ Find non-transient non-serializable instance fields in
+ Serializable classes
+ </li>
+ <li>
+ Source code may be compiled with latest early access
+ generics-enabled javac (version 2.2)
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.2:
+
+ </p>
+ <ul>
+ <li>
+ GUI supports filtering bugs by priority
+ </li>
+ <li>
+ Ant task rewritten; supports all functionality offered by Text UI
+ (contributed by Mike Fagan)
+ </li>
+ <li>
+ Ant task is fully documented in the manual
+ </li>
+ <li>
+ Classes in nested archives are analyzed; this allows full support
+ for analyzing .ear and .war files (contributed by Mike Fagan)
+ </li>
+ <li>
+ DepthFirstSearch changed to use non-recursive implementation;
+ this should fix the StackOverflowErrors that several users
+ reported
+ </li>
+ <li>
+ Various minor bugfixes and improvements
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.1:
+
+ </p>
+ <ul>
+ <li>
+ New detector to look for useless control flow (suggested by
+ Richard P. King and Mike Fagan)
+ </li>
+ <li>
+ Look for places where return value of
+ java.io.File.createNewFile() is ignored (suggested by Richard P.
+ King)
+ </li>
+ <li>
+ Fixed bug in resolution of source files (only the first source
+ directory was searched)
+ </li>
+ <li>
+ Fixed a NullPointerException in the bytecode pattern matching
+ code
+ </li>
+ <li>
+ Ant task supports project files (contributed by Mike Fagan)
+ </li>
+ <li>
+ Unix findbugs script honors the
+ <code>
+ JAVA_HOME
+ </code>
+ environment variable (contributed by Pedro Morais)
+ </li>
+ <li>
+ Allow .war and .ear files to be analyzed
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.6.0:
+
+ </p>
+ <ul>
+ <li>
+ New bug pattern detector which looks for places where a null
+ pointer might be dereferenced
+ </li>
+ <li>
+ New bug pattern detector which looks for IO streams that are
+ opened, do not escape the method, and are not closed on all paths
+ out of the method
+ </li>
+ <li>
+ New bug pattern detector to find methods that can return null
+ instead of a zero-length array
+ </li>
+ <li>
+ New bug pattern detector to find places where the == or !=
+ operators are used to compare String objects
+ </li>
+ <li>
+ Command line interface can save bugs as XML
+ </li>
+ <li>
+ GUI can save bugs to and load bugs from XML
+ </li>
+ <li>
+ An "Annotations" window in the GUI allows the user to add textual
+ annotations to bug reports; these annotations are preserved when
+ bugs are saved as XML
+ </li>
+ <li>
+ In this release, the Japanese bug summary translations by Germano
+ Leichsenring are really included (they were inadvertently omitted
+ in the previous release)
+ </li>
+ <li>
+ Completely rewrote the control flow graph builder, hopefully for
+ the last time
+ </li>
+ <li>
+ Simplified implementation of control flow graphs, which should
+ reduce memory use and possibly improve performance
+ </li>
+ <li>
+ Improvements to command line interface (list bug priorities,
+ filter by priority, specify aux classpath, specify project to
+ analyze)
+ </li>
+ <li>
+ Various bug fixes and enhancements
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.5.4
+
+ </p>
+ <ul>
+ <li>
+ Added an
+ <a href="http://ant.apache.org/">Ant</a> task for FindBugs,
+ contributed by Mike Fagan.
+ </li>
+ <li>
+ Added a GUI dialog which allows individual bug pattern detectors
+ to be enabled or disabled. Disabling certain slow detectors
+ can greatly speed up analysis of large programs, at the expense
+ of reducing the number of potential bugs found.
+ </li>
+ <li>
+ Added a new detector for finding improperly ignored return values
+ for methods such as
+ <code>
+ String.trim()
+ </code>
+ . Suggested by Andreas Mandel.
+ </li>
+ <li>
+ Japanese translations of the bug summaries, contributed by
+ Germano Leichsenring.
+ </li>
+ <li>
+ Filtering of results is supported in command line interface. See
+ the
+ <a href="manual/index.html">FindBugs manual</a> for details.
+ </li>
+ <li>
+ Added "byte code patterns", a general pattern matching
+ infrastructure for bytecode instructions. This feature
+ significantly reduces the complexity of implementing new bug
+ pattern detectors.
+ </li>
+ <li>
+ Enabled a new general dataflow analysis to track values in
+ methods.
+ </li>
+ <li>
+ Switched to new control-flow graph builder implementation.
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.5.3
+
+ </p>
+ <ul>
+ <li>
+ Fixed a bug in the script used to launch FindBugs on Windows
+ platforms.
+ </li>
+ <li>
+ Fixed crashes when analyzing class files without source line
+ information.
+ </li>
+ <li>
+ All major errors are reported using an error dialog; file not
+ found errors are more informative.
+ </li>
+ <li>
+ Minor GUI improvements.
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.5.2
+
+ </p>
+ <ul>
+ <li>
+ All of the source code and related files are in a single
+ directory tree.
+ </li>
+ <li>
+ Updated some of the detectors to produce source line information.
+ </li>
+ <li>
+ <a href="http://ant.apache.org/">Ant</a> build script and several
+ GUI enhancements and fixes contributed by Mike Fagan.
+ </li>
+ <li>
+ Converted to use a
+ <a href="AddingDetectors.txt">plugin architecture</a> for loading
+ bug detectors.
+ </li>
+ <li>
+ Eliminated generics-related compiler warnings.
+ </li>
+ <li>
+ More complete documentation has been added.
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.5.1:
+ </p>
+ <ul>
+ <li>
+ Fixed a large number of bugs in the BCEL Repository and
+ FindBugs's use of the Repository. With these changes,
+ FindBugs should
+ <em>never</em> crash or otherwise misbehave because of Repository
+ lookup failures. Because of these changes, you must use a
+ modified version of
+ <code>
+ bcel.jar
+ </code>
+ with FindBugs. This jar file is included in the FindBugs
+ 0.5.2 binary release. A complete patch containing the
+ <a
+ href="http://faculty.ycp.edu/~dhovemey/bcel-30-April-2003.patch">modifications
+ against the BCEL CVS main branch as of April 30, 2003</a> is also
+ available.
+ </li>
+ <li>
+ Implemented the "auxiliary classpath entry list". Aux
+ classpath entries can be added to a project to provide classes
+ that are referenced by the analyzed application, but should not
+ themselves be analyzed. Having all referenced classes
+ available allows FindBugs to produce more accurate results.
+ </li>
+ </ul>
+
+ <p>
+ Changes since version 0.5.0:
+ </p>
+ <ul>
+ <li>
+ Many user interface bugs have been fixed.
+ </li>
+ <li>
+ Upgraded to a recent CVS version of BCEL, with some bug
+ fixes. This should prevent FindBugs from crashing when
+ there is a failure to find a class on the classpath.
+ </li>
+ <li>
+ Added support for Plastic look and feel from
+ <a href="http://www.jgoodies.com/">jgoodies.com</a>.
+ </li>
+ <li>
+ Major overhaul of infrastructure for doing dataflow analysis.
+ </li>
+ </ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+ </td>
+
+ </tr>
+ </table>
+
+ </body>
+
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs FAQ</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td>
+<h1>FindBugs FAQ</h1>
+
+<p> This document contains answers to frequently asked questions about
+<a href="index.html">FindBugs</a>. If you just want general
+information about FindBugs, have a look at the
+<a href="factSheet.html">fact sheet</a> and the
+<a href="manual/index.html">manual</a>.
+
+<h2>Contents</h2>
+<ol>
+<li> <a href="#q1">I'm getting java.lang.UnsupportedClassVersionError when I try to run FindBugs</a>
+<li> <a href="#q2">When I click the "Find Bugs!" button, I get a NoSuchMethodError or VerifyError</a>
+<li> <a href="#q3">FindBugs is running out of memory, or is taking a long time to finish</a>
+<li> <a href="#q4">What is the "auxiliary classpath"? Why should I specify it?</a>
+<li> <a href="#q5">The Eclipse plugin doesn't load</a>
+<li> <a href="#q6">I'm getting a lot of false "OS" and "ODR" warnings</a>
+<li> <a href="#q7">The Eclipse plugin loads, but doesn't work correctly</a>
+<li> <a href="#q8">Where is the Maven plugin for FindBugs?</a>
+<li> <a href="#q9">Where is the NetBeans plugin for FindBugs?</a>
+</ol>
+
+<h2><a name="q1">Q1: I'm getting java.lang.UnsupportedClassVersionError when I try to run FindBugs</a></h2>
+
+<p> FindBugs requires JRE 1.4.0 or later to run. If you use an earlier version,
+you will see an exception error message similar to the following:
+<pre>
+Exception in thread "main" java.lang.UnsupportedClassVersionError:
+edu/umd/cs/findbugs/gui/FindBugsFrame (Unsupported major.minor version 48.0)
+</pre>
+The solution is to upgrade to JRE 1.4.0 or later.
+
+<h2><a name="q2">Q2: When I click the "Find Bugs!" button, I get a NoSuchMethodError or VerifyError</a></h2>
+
+<p> The symptom of this bug is that when you start the FindBugs analysis,
+you see an exception similar to the following:
+<pre>
+java.lang.NoSuchMethodError: org.apache.bcel.Repository.setRepository(Lorg/apache/bcel/util/Repository;)V
+ at edu.umd.cs.findbugs.FindBugs.clearRepository(FindBugs.java:483)
+ ...
+</pre>
+
+or
+
+<pre>
+java.lang.VerifyError: Cannot inherit from final class
+ at java.lang.ClassLoader.defineClass0(Native Method)
+ at java.lang.ClassLoader.defineClass(ClassLoader.java:537)
+ ...
+</pre>
+
+<p> The problem here is that the wrong version of the
+<a href="http://jakarta.apache.org/bcel/">Apache BCEL</a>
+library is being found. FindBugs requires its own
+version of BCEL, which normally will be used automatically
+when you invoke the <code>findbugs</code> or <code>findbugs.bat</code>
+scripts used to launch FindBugs. If an old version of BCEL is installed
+in a location, such as "lib/endorsed" in the JRE installation,
+where it overrides classes on the application classpath,
+FindBugs will not execute properly.
+We know of several reasons this could happen
+
+<ul>
+<li> If you install the
+<a href="http://java.sun.com/webservices/downloads/webservicespack.html">Java(TM) Web Services
+Developer Pack 1.2</a>
+in the <code>lib/endorsed</code> directory of your Java Runtime Environment (JRE).
+The file <code>xsltc.jar</code> contains an old version of BCEL that is incompatible with
+FindBugs.
+
+<li> Another possibility is that you are using the IBM JDK.
+Some versions include a version of BCEL which conflicts with the
+one required by FindBugs. This problem is fixed in version 1.4.1 SP1,
+so upgrading your JDK should allow FindBugs to run correctly.
+
+<li> Some versions of the Apache Xalan XSLT processor include
+an old version of BCEL in <code>xalan.jar</code>.
+
+</ul>
+
+<p> In all of these cases, you should be able to run FindBugs
+by either removing the offending version of BCEL from your JRE,
+or installing a clean JRE or JDK and using that to run FindBugs.
+
+<p> Many thanks to Peter Meulmeester, Michael Levi, and Thomas Klaeger
+for providing information on this problem.
+
+<h2><a name="q3">Q3: FindBugs is running out of memory, or is taking a long time to finish</a></h2>
+
+<p> In general, FindBugs requires lots of memory and a relatively
+fast CPU. For large applications, 512M or more of heap space may be
+required. By default, FindBugs allocates 256M of heap space.
+You can increase this using the <code>-maxHeap <i>n</i></code> option,
+where <i>n</i> is the number of megabytes of heap space to allocate.
+
+<p>If you are using the GUI version of FindBugs, and have many classes to analyze,
+a good amount of memory is needed to generate the summary report. If the process
+appears to be hanging after all classes have been parsed, but before the final
+details have been shown, you can turn this summary report off, by specifying<br/>
+<code>-jvmArgs "-Dfindbugs.noSummary=true"</code><br/> on the command line.</p>
+
+<p> Version 0.6.9 of FindBugs introduced new types of analysis that
+improve precision, but require more memory and time to perform.
+In version 0.7.0 and later, you can disable these analyses by
+adding the <code>-conserveSpace</code> option to the FindBugs
+command line. E.g.:
+
+<pre>
+ findbugs -textui -conserveSpace -xml -project myProject.fb -outputFile out.xml
+</pre>
+
+<h2><a name="q4">Q4: What is the "auxiliary classpath"? Why should I specify it?</a></h2>
+
+<p> Many important facts about a Java class require information about
+the classes that it references. For example:
+<ul>
+<li> What other classes and interfaces the class inherits from
+<li> What exceptions can be thrown by methods in external classes
+and interfaces
+</ul>
+
+<p> The "auxiliary classpath" is a list of Jar files, directories, and
+class files containing classes that are <em>used</em> by the code you
+want FindBugs to analyze, but should not themselves be analyzed
+by FindBugs.
+
+<p> If FindBugs doesn't have complete information about referenced classes,
+it will not be able to produce results that are as accurate as possible.
+For example, having a complete repository of referenced classes allows
+FindBugs to prune control flow information so it can concentrate on
+paths through methods that are most likely to be feasible at runtime.
+Also, some bug detectors (such as the suspicious reference comparison detector)
+rely on being able to perform type inference, which requires complete
+type hierarchy information.
+
+<p> For these reasons, we strongly recommend that you completely specify
+the auxiliary classpath when you run FindBugs. You can do this
+by using the <code>-auxclasspath</code> command line option, or the
+"Classpath entries" list in the GUI project editor dialog.
+
+<p> If FindBugs cannot find a class referenced by your application, it
+will print out a message when the analysis completes, specifying the
+classes that were missing. You should modify the auxiliary classpath
+to specify how to find the missing classes, and then run FindBugs again.
+
+<h2><a name="q5">Q5: The Eclipse plugin doesn't load</a></h2>
+
+<p> The symptom of this problem is that Eclipse fails to load
+the FindBugs UI plugin with the message:
+<blockquote>
+Plug-in "edu.umd.cs.findbugs.plugin.eclipse" was disabled due to missing or disabled
+prerequisite plug-in "org.eclipse.ui.ide"
+</blockquote>
+
+<p> The reason for this problem is that the Eclipse
+plugin distributed with FindBugs
+does not work with 2.x versions of Eclipse.
+Please use Eclipse version 3.0 (June 2004) or newer.
+
+<h2><a name="q6">Q6: I'm getting a lot of false "OS" and "ODR" warnings</a></h2>
+
+<p> By default, FindBugs assumes that any method invocation can
+throw an unchecked runtime exception. As a result,
+it may assume that an unchecked exception thrown out of the
+method could bypass a call to a <code>close()</code> method
+for a stream or database resource.
+
+<p> You can use the <code>-workHard</code> command line argument
+or the <code>findbugs.workHard</code> boolean analysis property
+to make FindBugs work harder to prune unlikely exception
+edges. This generally reduces the number of
+false warnings, at the expense of slowing down the
+analysis.
+
+<h2><a name="q7">Q7: The Eclipse plugin loads, but doesn't work correctly</a></h2>
+
+<p> In versions 0.0.6 and 0.0.7 of the FindBugs Eclipse plugin,
+which correspond to the 0.7.4 and 0.8.0 releases,
+bugs in the experimental SwitchFallthrough detector can prevent
+FindBugs from running properly within Eclipse.
+
+<p> To work around the problem, make sure that SwitchFallthrough
+is disabled in the FindBugs Properties of your project.
+Right click on your project, and choose "Properties".
+In the Properties dialog, choose "FindBugs",
+and disable the checkbox next to SwitchFallthrough.
+
+<p> Another common problem with the Eclipse plugin is that
+the FindBugs warnings do not appear in the "Problems" view.
+Make sure that FindBugs warnings are enabled in the filters
+for this view. The Filters menu is accessible by
+clicking on the icon that looks like this:
+<blockquote>
+<img src="eclipse-filters-icon.png">
+</blockquote>
+Make sure the "FindBugs Problem" checkbox is enabled.
+
+<h2><a name="q8">Q8: Where is the Maven plugin for FindBugs?</a></h2>
+
+<p>
+The <a href="http://maven.apache.org/">Maven</a> Plugin for FindBugs
+may be found <a href="http://maven-plugins.sourceforge.net/maven-findbugs-plugin/index.html">here</a>.
+Please note that the Maven plugin is not maintained by the FindBugs developers,
+so we can't answer questions about it.
+</p>
+
+<h2><a name="q9">Q9: Where is the NetBeans plugin for FindBugs?</a></h2>
+
+<p>
+The <a href="http://www.netbeans.org/">NetBeans</a> Plugin for FindBugs
+may be obtained by pointing UpdateCenter to
+<a href="https://sqe.dev.java.net/updatecenters/nbheaven-updatecenter.xml">
+https://sqe.dev.java.net/updatecenters/nbheaven-updatecenter.xml</a>.
+
+(An older human-readable page is <a href="http://fnleisurehacker.fn.funpic.de/wordpress/?page_id=102">here</a>.)
+
+This distribution apparently bundles the detectors from
+fb-contrib,
+which are not controlled by the FindBugs project.
+The lead FindBugs team does not vouch for the relevance, accuracy or wisdom of the warnings
+ generated by any third-party plugin.
+and encourages all FindBugs users to carefully evaluate 3rd party plugins for FindBugs.
+</p>
+<p>
+Again, please note that the NetBeans plugin is not maintained by the FindBugs developers,
+so we can't answer questions about it.
+</p>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</table></tr>
+
+</body>
+
+</html>
--- /dev/null
+=============
+How it works:
+=============
+
+A filter file is an XML file with a top-level "FindBugsFilter" element
+which has some number of "Match" elements as children. Each Match
+element represents a predicate which is applied to generated bug instances.
+Usually, a filter will be used to exclude bug instances. For example:
+
+ findbugs -textui -exclude myExcludeFilter.xml myApp.jar
+
+However, a filter could also be used to select bug instances to specifically
+report:
+
+ findbugs -textui -include myIncludeFilter.xml myApp.jar
+
+Match has "class" and "classregex" attributes specifying what class or classes
+the predicate applies to.
+
+Match contains children, which are conjuncts of the predicate.
+(I.e., each of the children must be true for the predicate to be true.)
+
+=======================
+Types of Match clauses:
+=======================
+
+ <BugCode> specifies abbreviations of bugs.
+ The "name" attribute is a comma-seperated list of abbreviations.
+
+ <Method> specifies a method. The "name" attribute is the name
+ of the method. The "params" attribute is a comma separated list
+ of the types of the method's parameters. The "returns" attribute is
+ the method's return type. In "params" and "returns", class names
+ must be fully qualified. (E.g., "java.lang.String" instead of just
+ "String".) Note that "params" and "returns" are optional; you can
+ just specify "name", and the clause will match all methods with
+ that name. However, if you specify either "params" or "returns",
+ you must specify both of them.
+
+ <Or> combines Match clauses as disjuncts. I.e., you can put two
+ "Method" elements in an Or clause in order match either method.
+
+========
+Caveats:
+========
+
+Match clauses can only match information that is actually contained in the
+bug instances. Every bug instance has a class, so in general, excluding
+bugs by class will work.
+
+Some bug instances have two classes. For example, the DE (dropped exception)
+bugs report both the class containing the method where the dropped exception
+happens, and the class which represents the type of the dropped exception.
+Only the FIRST (primary) class is matched against Match clauses.
+So, for example, if you want to suppress IC (initialization circularity)
+reports for classes "com.foobar.A" and "com.foobar.B", you would use
+two Match clauses:
+
+ <Match class="com.foobar.A">
+ <BugCode name="IC" />
+ </Match>
+
+ <Match class="com.foobar.B">
+ <BugCode name="IC" />
+ </Match>
+
+Many kinds of bugs report what method they occur in. For those bug instances,
+you can put Method clauses in the Match element and they should work
+as expected.
+
+=========
+Examples:
+=========
+
+ 1. Match all bug reports for a class.
+
+ <Match class="com.foobar.MyClass" />
+
+ 2. Match certain tests from a class.
+ <Match class="com.foobar.MyClass">
+ <BugCode name="DE,UrF,SIC" />
+ </Match>
+
+ 3. Match certain tests from all classes.
+
+ <Match classregex=".*" >
+ <BugCode name="DE,UrF,SIC" />
+ </Match>
+
+ 4. Match bug types from specified methods of a class.
+
+ <Match class="com.foobar.MyClass">
+ <Or>
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <BugCode name="DC" />
+ </Match>
+
+=================
+Complete Example:
+=================
+
+<FindBugsFilter>
+ <Match class="com.foobar.ClassNotToBeAnalyzed" />
+
+ <Match class="com.foobar.ClassWithSomeBugsMatched">
+ <BugCode name="DE,UrF,SIC" />
+ </Match>
+
+ <!-- Match all XYZ violations. -->
+ <Match classregex=".*" >
+ <BugCode name="XYZ" />
+ </Match>
+
+ <!-- Match all doublecheck violations in these methods of "AnotherClass". -->
+ <Match class="com.foobar.AnotherClass">
+ <Or>
+ <Method name="nonOverloadedMethod" />
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <BugCode name="DC" />
+ </Match>
+</FindBugsFilter>
--- /dev/null
+<html><head><title>FindBugs Bug Descriptions (Unabridged)</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css"/>
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon"/>
+</head><body>
+
+<table width="100%"><tr>
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+<td align="left" valign="top">
+<h1>FindBugs Bug Descriptions (Unabridged)</h1>
+<p>This document lists all of the bug patterns reported by the
+latest development version of
+<a href="http://findbugs.sourceforge.net">FindBugs</a>. Note that this may include
+bug patterns not available in any released version of FindBugs,
+as well as bug patterns that are not enabled by default.
+<h2>Summary</h2>
+<table width="100%">
+<tr bgcolor="#b9b9fe"><th>Description</th><th>Category</th></tr>
+<tr bgcolor="#eeeeee"><td><a href="#AM_CREATES_EMPTY_JAR_FILE_ENTRY">AM: Creates an empty jar file entry</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#AM_CREATES_EMPTY_ZIP_FILE_ENTRY">AM: Creates an empty zip file entry</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS">BC: Equals method should not assume anything about the type of its argument</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_RANDOM_USED_ONLY_ONCE">BC: Random object created and used only once</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_SIGNED_CHECK">BIT: Check for sign of bitwise operation</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#CN_IDIOM">CN: Class implements Cloneable but does not define or use clone method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CN_IDIOM_NO_SUPER_CALL">CN: clone method does not call super.clone()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#CO_ABSTRACT_SELF">Co: Abstract class defines covariant compareTo() method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CO_SELF_NO_OBJECT">Co: Covariant compareTo() method defined</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DE_MIGHT_DROP">DE: Method might drop exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DE_MIGHT_IGNORE">DE: Method might ignore exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED">DP: Classloaders should only be created inside doPrivileged block</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DP_DO_INSIDE_DO_PRIVILEGED">DP: Method invoked that should be only be invoked inside a doPrivileged block</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_EXIT">Dm: Method invokes System.exit(...)</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_RUN_FINALIZERS_ON_EXIT">Dm: Method invokes dangerous method runFinalizersOnExit </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ES_COMPARING_PARAMETER_STRING_WITH_EQ">ES: Comparison of String parameter using == or !=</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ES_COMPARING_STRINGS_WITH_EQ">ES: Comparison of String objects using == or !=</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_ABSTRACT_SELF">Eq: Abstract class defines covariant equals() method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_COMPARETO_USE_OBJECT_EQUALS">Eq: Class defines compareTo(...) and uses Object.equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_SELF_NO_OBJECT">Eq: Covariant equals() method defined</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_SELF_USE_OBJECT">Eq: Covariant equals() method defined, Object.equals(Object) inherited</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_EMPTY">FI: Empty finalizer should be deleted</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_EXPLICIT_INVOCATION">FI: Explicit invocation of finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_FINALIZER_NULLS_FIELDS">FI: Finalizer nulls fields</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_FINALIZER_ONLY_NULLS_FIELDS">FI: Finalizer only nulls fields</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_MISSING_SUPER_CALL">FI: Finalizer does not call superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_NULLIFY_SUPER">FI: Finalizer nullifies superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_USELESS">FI: Finalizer does nothing but call superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_EQUALS_NO_HASHCODE">HE: Class defines equals() but not hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#HE_EQUALS_USE_HASHCODE">HE: Class defines equals() and uses Object.hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_HASHCODE_NO_EQUALS">HE: Class defines hashCode() but not equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#HE_HASHCODE_USE_OBJECT_EQUALS">HE: Class defines hashCode() and uses Object.equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_INHERITS_EQUALS_USE_HASHCODE">HE: Class inherits equals() and uses Object.hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION">IC: Superclass uses subclass during initialization</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IMSE_DONT_CATCH_IMSE">IMSE: Dubious catching of IllegalMonitorStateException</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ISC_INSTANTIATE_STATIC_CLASS">ISC: Needless instantiation of class that only supplies static methods</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IT_NO_SUCH_ELEMENT">It: Iterator next() method can't throw NoSuchElement exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION">J2EE: Store of non serializable object into HttpSession</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_CLONE_COULD_RETURN_NULL">NP: Clone method may return null</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT">NP: equals() method does not check for null argument</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_TOSTRING_COULD_RETURN_NULL">NP: toString method may return null</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_CLASS_NAMING_CONVENTION">Nm: Class names should start with an upper case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_CLASS_NOT_EXCEPTION">Nm: Class is not derived from an Exception, even though it is named as such</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_CONFUSING">Nm: Confusing method names</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_FIELD_NAMING_CONVENTION">Nm: Field names should start with an lower case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_METHOD_NAMING_CONVENTION">Nm: Method names should start with an lower case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_SAME_SIMPLE_NAME_AS_INTERFACE">Nm: Class names shouldn't shadow simple name of implemented interface</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_SAME_SIMPLE_NAME_AS_SUPERCLASS">Nm: Class names shouldn't shadow simple name of superclass</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_VERY_CONFUSING_INTENTIONAL">Nm: Very confusing method names</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_WRONG_PACKAGE_INTENTIONAL">Nm: Method doesn't override method in superclass due to wrong package for parameter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ODR_OPEN_DATABASE_RESOURCE">ODR: Method may fail to close database resource</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH">ODR: Method may fail to close database resource on exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#OS_OPEN_STREAM">OS: Method may fail to close stream</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#OS_OPEN_STREAM_EXCEPTION_PATH">OS: Method may fail to close stream on exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RC_REF_COMPARISON">RC: Suspicious reference comparison</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RR_NOT_CHECKED">RR: Method ignores results of InputStream.read()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SR_NOT_CHECKED">RR: Method ignores results of InputStream.skip()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_RETURN_VALUE_IGNORED_BAD_PRACTICE">RV: Method ignores return value</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SI_INSTANCE_BEFORE_FINALS_ASSIGNED">SI: Static initializer creates instance before all static final fields assigned</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE">SQL: Nonconstant string passed to execute method on an SQL statement</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING">SQL: A prepared statement is generated from a nonconstant String</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SW_SWING_METHODS_INVOKED_IN_SWING_THREAD">SW: Certain swing methods needs to be invoked in Swing thread</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_BAD_FIELD">Se: Non-transient non-serializable instance field in serializable class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_BAD_FIELD_INNER_CLASS">Se: Non-serializable class has a serializable inner class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_BAD_FIELD_STORE">Se: Non-serializable value stored into instance field of a serializable class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_COMPARATOR_SHOULD_BE_SERIALIZABLE">Se: Comparator doesn't implement Serializable</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_INNER_CLASS">Se: Serializable inner class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_METHOD_MUST_BE_PRIVATE">Se: Method must be private in order for serialization to work</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NONFINAL_SERIALVERSIONID">Se: serialVersionUID isn't final</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NONLONG_SERIALVERSIONID">Se: serialVersionUID isn't long</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NONSTATIC_SERIALVERSIONID">Se: serialVersionUID isn't static</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NO_SUITABLE_CONSTRUCTOR">Se: Class is Serializable but its superclass doesn't define a void constructor</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION">Se: Class is Externalizable but doesn't define a void constructor</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_READ_RESOLVE_MUST_RETURN_OBJECT">Se: The readResolve method must be declared with a return type
+of Object. </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_TRANSIENT_FIELD_NOT_RESTORED">Se: Transient field that isn't set by deserialization. </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NO_SERIALVERSIONID">SnVI: Class is Serializable, but doesn't define serialVersionUID</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UI_INHERITANCE_UNSAFE_GETRESOURCE">UI: Usage of GetResource may be unsafe if class is extended</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_IMPOSSIBLE_CAST">BC: Impossible cast</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_IMPOSSIBLE_INSTANCEOF">BC: instanceof will always return false</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_AND">BIT: Incompatible bit masks</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_AND_ZZ">BIT: Check to see if ((...) & 0) == 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_IOR">BIT: Incompatible bit masks</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_IOR_OF_SIGNED_BYTE">BIT: Bitwise OR of signed byte value</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_SIGNED_CHECK_HIGH_BIT">BIT: Check for sign of bitwise operation</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BOA_BADLY_OVERRIDDEN_ADAPTER">BOA: Class overrides a method implemented in super class Adapter wrongly</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR">Bx: Primitive value is unboxed and coerced for ternary operator</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DLS_DEAD_STORE_OF_CLASS_LITERAL">DLS: Dead store of class literal</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DLS_OVERWRITTEN_INCREMENT">DLS: Overwritten increment</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_BAD_MONTH">DMI: Bad constant value for month</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_CALLING_NEXT_FROM_HASNEXT">DMI: hasNext method invokes next</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_INVOKING_TOSTRING_ON_ARRAY">DMI: Invocation of toString on an array</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT">DMI: Double.longBitsToDouble invoked on an int</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION">Dm: Can't use reflection to check for presence of annotation with default retention</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_ARRAY_AND_NONARRAY">EC: equals() used to compare array and nonarray</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_BAD_ARRAY_COMPARE">EC: Invocation of equals() on an array, which is equivalent to ==</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_NULL_ARG">EC: Call to equals() with null argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_UNRELATED_CLASS_AND_INTERFACE">EC: Call to equals() comparing unrelated class and interface</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_UNRELATED_INTERFACES">EC: Call to equals() comparing different interface types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_UNRELATED_TYPES">EC: Call to equals() comparing different types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_UNRELATED_TYPES_USING_POINTER_EQUALITY">EC: Using pointer equality to compare different types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_DONT_DEFINE_EQUALS_FOR_ENUM">Eq: Covariant equals() method defined for enum</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC">Eq: equals method overrides equals in superclass and may not be symmetric</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER">FE: Doomed test for equality to NaN</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#GC_UNRELATED_TYPES">GC: No relationship between generic parameter and method argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_USE_OF_UNHASHABLE_CLASS">HE: Use of class without a hashCode() method in a hashed data structure</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_BAD_SHIFT_AMOUNT">ICAST: Integer shift by an amount not in the range 0..31</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL">ICAST: int value cast to double and then passed to Math.ceil</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND">ICAST: int value cast to float and then passed to Math.round</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD">IJU: JUnit assertion in run method will not be noticed by JUnit</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_BAD_SUITE_METHOD">IJU: TestCase declares a bad suite method </a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_NO_TESTS">IJU: TestCase has no tests</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_SETUP_NO_SUPER">IJU: TestCase implements setUp but doesn't call super.setUp()</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_SUITE_NOT_STATIC">IJU: TestCase implements a non-static suite method </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_TEARDOWN_NO_SUPER">IJU: TestCase implements tearDown but doesn't call super.tearDown()</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IL_CONTAINER_ADDED_TO_ITSELF">IL: A container is added to itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IL_INFINITE_LOOP">IL: An apparent infinite loop</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IL_INFINITE_RECURSIVE_LOOP">IL: An apparent infinite recursive loop</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IM_MULTIPLYING_RESULT_OF_IREM">IM: Integer multiply of result of integer remainder</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE">INT: Bad comparison of nonnegative value with negative constant</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#INT_BAD_COMPARISON_WITH_SIGNED_BYTE">INT: Bad comparison of signed byte</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_BAD_REM_BY_1">INT: Integer remainder modulo 1</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN">IP: A parameter is dead upon entry to a method but overwritten</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS">JCIP: Fields of immutable classes should be final</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MF_CLASS_MASKS_FIELD">MF: Class defines field that masks a superclass field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MF_METHOD_MASKS_FIELD">MF: Method defines a variable that obscures a field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_ALWAYS_NULL">NP: Null pointer dereference</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_ALWAYS_NULL_EXCEPTION">NP: Null pointer dereference in method on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_ARGUMENT_MIGHT_BE_NULL">NP: Method does not check for null argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_GUARANTEED_DEREF">NP: Null value is guaranteed to be dereferenced</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH">NP: Value is null and guaranteed to be dereferenced on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NONNULL_PARAM_VIOLATION">NP: Method call passes null to a nonnull parameter </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NONNULL_RETURN_VIOLATION">NP: Method may return null, but is declared @NonNull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_INSTANCEOF">NP: A known null value is checked to see if it is an instance of a type</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_ON_SOME_PATH">NP: Possible null pointer dereference</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_ON_SOME_PATH_EXCEPTION">NP: Possible null pointer dereference in method on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_PARAM_DEREF">NP: Method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS">NP: Method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_PARAM_DEREF_NONVIRTUAL">NP: Non-virtual method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_STORE_INTO_NONNULL_FIELD">NP: Store of null value into field annotated NonNull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_UNWRITTEN_FIELD">NP: Read of unwritten field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_BAD_EQUAL">Nm: Class defines equal(); should it be equals()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_LCASE_HASHCODE">Nm: Class defines hashcode(); should it be hashCode()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_LCASE_TOSTRING">Nm: Class defines tostring(); should it be toString()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_METHOD_CONSTRUCTOR_CONFUSION">Nm: Apparent method/constructor confusion</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_VERY_CONFUSING">Nm: Very confusing method names</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_WRONG_PACKAGE">Nm: Method doesn't override method in superclass due to wrong package for parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT">QBA: Method assigns boolean literal in boolean expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE">RCN: Nullcheck of value previously dereferenced</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION">RE: Invalid syntax for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION">RE: File.separator used for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RE_POSSIBLE_UNINTENDED_PATTERN">RE: "." used for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_01_TO_INT">RV: Random value from 0 to 1 is coerced to the integer 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_ABSOLUTE_VALUE_OF_HASHCODE">RV: Bad attempt to compute absolute value of signed 32-bit hashcode </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_ABSOLUTE_VALUE_OF_RANDOM_INT">RV: Bad attempt to compute absolute value of signed 32-bit random integer</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_DONT_JUST_NULL_CHECK_READLINE">RV: Method discards result of readLine after checking if it is nonnull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_EXCEPTION_NOT_THROWN">RV: Exception created and dropped rather than thrown</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_RETURN_VALUE_IGNORED">RV: Method ignores return value</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_FIELD_DOUBLE_ASSIGNMENT">SA: Double assignment of field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_FIELD_SELF_ASSIGNMENT">SA: Self assignment of field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_FIELD_SELF_COMPARISON">SA: Self comparison of field with itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_FIELD_SELF_COMPUTATION">SA: Nonsensical self computation involving a field (e.g., x & x)</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_DOUBLE_ASSIGNMENT">SA: Double assignment of local variable </a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_LOCAL_SELF_COMPARISON">SA: Self comparison of value with itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_SELF_COMPUTATION">SA: Nonsensical self computation involving a variable (e.g., x & x)</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH">SF: Dead store due to switch statement fall through</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIO_SUPERFLUOUS_INSTANCEOF">SIO: Unnecessary type check done using instanceof operator</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SQL_BAD_PREPARED_STATEMENT_ACCESS">SQL: Method attempts to access a prepared statement parameter with index 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SQL_BAD_RESULTSET_ACCESS">SQL: Method attempts to access a result set field with index 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STI_INTERRUPTED_ON_CURRENTTHREAD">STI: Unneeded use of currentThread() call, to call interrupted() </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STI_INTERRUPTED_ON_UNKNOWNTHREAD">STI: Static Thread.interrupted() method invoked on thread instance</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED">TQ: Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK">TQ: Value that might not carry a type qualifier reaches a use requiring that type qualifier</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK">TQ: Unknown value reaches a use which forbids values carrying type qualifier annotation</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED">TQ: Value annotated as never carrying a type qualifier used where value carrying that qualifier is required</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UCF_USELESS_CONTROL_FLOW_NEXT_LINE">UCF: Useless control flow to next line</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS">UMAC: Uncallable method defined in anonymous class</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UR_UNINIT_READ">UR: Uninitialized read of field in constructor</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UWF_NULL_FIELD">UwF: Field only ever set to null</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UWF_UNWRITTEN_FIELD">UwF: Unwritten field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG">VA: Primitive array passed to function expecting a variable number of object arguments</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_CONVERT_CASE">Dm: Consider using Locale parameterized version of invoked method</a></td><td>Internationalization</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EI_EXPOSE_REP">EI: May expose internal representation by returning reference to mutable object</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EI_EXPOSE_REP2">EI2: May expose internal representation by incorporating reference to mutable object</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_PUBLIC_SHOULD_BE_PROTECTED">FI: Finalizer should be protected, not public</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EI_EXPOSE_STATIC_REP2">MS: May expose internal static state by storing a mutable object into a static field</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_CANNOT_BE_FINAL">MS: Field isn't final and can't be protected from malicious code</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_EXPOSE_REP">MS: Public static method may expose internal representation by returning array</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_FINAL_PKGPROTECT">MS: Field should be both final and package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_MUTABLE_ARRAY">MS: Field is a mutable array</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_MUTABLE_HASHTABLE">MS: Field is a mutable Hashtable</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_OOI_PKGPROTECT">MS: Field should be moved out of an interface and made package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_PKGPROTECT">MS: Field should be package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_SHOULD_BE_FINAL">MS: Field isn't final but should be</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DC_DOUBLECHECK">DC: Possible double check of field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DL_SYNCHRONIZATION_ON_SHARED_CONSTANT">DL: Synchronization on shared constant could lead to deadlock</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_MONITOR_WAIT_ON_CONDITION">Dm: Monitor wait() called on Condition</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_USELESS_THREAD">Dm: A thread was created using the default empty run method</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ESync_EMPTY_SYNC">ESync: Empty synchronized block</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IS2_INCONSISTENT_SYNC">IS: Inconsistent synchronization</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IS_FIELD_NOT_GUARDED">IS: Field not guarded against concurrent access</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#JLM_JSR166_LOCK_MONITORENTER">JLM: Synchronization performed on java.util.concurrent Lock</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#LI_LAZY_INIT_STATIC">LI: Incorrect lazy initialization of static field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#LI_LAZY_INIT_UPDATE_STATIC">LI: Incorrect lazy initialization and update of static field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ML_SYNC_ON_UPDATED_FIELD">ML: Method synchronizes on an updated field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MWN_MISMATCHED_NOTIFY">MWN: Mismatched notify()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MWN_MISMATCHED_WAIT">MWN: Mismatched wait()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NN_NAKED_NOTIFY">NN: Naked notify</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_SYNC_AND_NULL_CHECK_FIELD">NP: Synchronize and null check on the same field.</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NO_NOTIFY_NOT_NOTIFYALL">No: Using notify() rather than notifyAll()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RS_READOBJECT_SYNC">RS: Class's readObject() method is synchronized</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RU_INVOKE_RUN">Ru: Invokes run on a thread (did you mean to start it instead?)</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SC_START_IN_CTOR">SC: Constructor invokes Thread.start()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SP_SPIN_ON_FIELD">SP: Method spins on field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE">STCAL: Call to static Calendar</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE">STCAL: Call to static DateFormat</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STCAL_STATIC_CALENDAR_INSTANCE">STCAL: Static Calendar</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE">STCAL: Static DateFormat</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SWL_SLEEP_WITH_LOCK_HELD">SWL: Method calls Thread.sleep() with a lock held</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TLW_TWO_LOCK_WAIT">TLW: Wait with two locks held</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UG_SYNC_SET_UNSYNC_GET">UG: Unsynchronized get method, synchronized set method</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UL_UNRELEASED_LOCK">UL: Method does not release lock on all paths</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UL_UNRELEASED_LOCK_EXCEPTION_PATH">UL: Method does not release lock on all exception paths</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UW_UNCOND_WAIT">UW: Unconditional wait</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#VO_VOLATILE_REFERENCE_TO_ARRAY">VO: A volatile reference to an array doesn't treat the array elements as volatile</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#WS_WRITEOBJECT_SYNC">WS: Class's writeObject() method is synchronized but nothing else is</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#WA_AWAIT_NOT_IN_LOOP">Wa: Condition.await() not in loop </a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#WA_NOT_IN_LOOP">Wa: Wait not in loop </a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BX_BOXING_IMMEDIATELY_UNBOXED">Bx: Primitive value is boxed and then immediately unboxed</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION">Bx: Primitive value is boxed then unboxed to perform primative coercion</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_BOXED_PRIMITIVE_TOSTRING">Bx: Method allocates a boxed primitive just to call toString</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_FP_NUMBER_CTOR">Bx: Method invokes inefficient floating-point Number constructor; use static valueOf instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_NUMBER_CTOR">Bx: Method invokes inefficient Number constructor; use static valueOf instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_BLOCKING_METHODS_ON_URL">Dm: The equals and hashCode methods of URL are blocking</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_COLLECTION_OF_URLS">Dm: Maps and sets of URLs can be performance hogs</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_BOOLEAN_CTOR">Dm: Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_GC">Dm: Explicit garbage collection; extremely dubious except in benchmarking code</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_NEW_FOR_GETCLASS">Dm: Method allocates an object, only to get the class object</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_NEXTINT_VIA_NEXTDOUBLE">Dm: Use the nextInt method of Random rather than nextDouble to generate a random integer</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_STRING_CTOR">Dm: Method invokes inefficient new String(String) constructor</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_STRING_EMPTY_EQUALS">Dm: Method invokes inefficient String.equals(""); use String.length() == 0 instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_STRING_TOSTRING">Dm: Method invokes toString() method on a String</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_STRING_VOID_CTOR">Dm: Method invokes inefficient new String() constructor</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HSC_HUGE_SHARED_STRING_CONSTANT">HSC: Huge string constants is duplicated across multiple class files</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ITA_INEFFICIENT_TO_ARRAY">ITA: Method uses toArray() with zero-length array argument</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SBSC_USE_STRINGBUFFER_CONCATENATION">SBSC: Method concatenates strings using + in a loop</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIC_INNER_SHOULD_BE_STATIC">SIC: Should be a static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SIC_INNER_SHOULD_BE_STATIC_ANON">SIC: Could be refactored into a named static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS">SIC: Could be refactored into a static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SS_SHOULD_BE_STATIC">SS: Unread field: should this field be static?</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UM_UNNECESSARY_MATH">UM: Method calls static Math class method on a constant value</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UPM_UNCALLED_PRIVATE_METHOD">UPM: Private method is never called</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#URF_UNREAD_FIELD">UrF: Unread field</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UUF_UNUSED_FIELD">UuF: Unused field</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#WMI_WRONG_MAP_ITERATOR">WMI: Inefficient use of keySet iterator instead of entrySet iterator</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_BAD_CAST_TO_ABSTRACT_COLLECTION">BC: Questionable cast to abstract collection </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_BAD_CAST_TO_CONCRETE_COLLECTION">BC: Questionable cast to concrete collection</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_UNCONFIRMED_CAST">BC: Unchecked/unconfirmed cast</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_VACUOUS_INSTANCEOF">BC: instanceof will always return true</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CI_CONFUSED_INHERITANCE">CI: Class is final but declares protected field</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DB_DUPLICATE_BRANCHES">DB: Method uses the same code for two branches</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DB_DUPLICATE_SWITCH_CLAUSES">DB: Method uses the same code for two switch clauses</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DLS_DEAD_LOCAL_STORE">DLS: Dead store to local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DLS_DEAD_LOCAL_STORE_OF_NULL">DLS: Dead store of null to local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_HARDCODED_ABSOLUTE_FILENAME">DMI: Code contains a hard coded reference to an absolute pathname</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_NONSERIALIZABLE_OBJECT_WRITTEN">DMI: Non serializable object written to ObjectOutput</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_USELESS_SUBSTRING">DMI: Invocation of substring(0), which returns the original value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED">Dm: Thread passed where Runnable expected</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_DOESNT_OVERRIDE_EQUALS">Eq: Class doesn't override equals in superclass</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FE_FLOATING_POINT_EQUALITY">FE: Test for floating point equality</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD">IA: Ambiguous invocation of either an inherited or outer method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IC_INIT_CIRCULARITY">IC: Initialization circularity</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_IDIV_CAST_TO_DOUBLE">ICAST: int division result cast to double or float</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ICAST_INTEGER_MULTIPLY_CAST_TO_LONG">ICAST: Result of integer multiplication cast to long</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT">ICAST: Unsigned right shift cast to short/byte</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IM_AVERAGE_COMPUTATION_COULD_OVERFLOW">IM: Computation of average could overflow</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IM_BAD_CHECK_FOR_ODD">IM: Check for oddness that won't work for negative numbers </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_VACUOUS_COMPARISON">INT: Vacuous comparison of integer value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MTIA_SUSPECT_SERVLET_INSTANCE_FIELD">MTIA: Class extends Servlet class and uses instance variables</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MTIA_SUSPECT_STRUTS_INSTANCE_FIELD">MTIA: Class extends Struts Action class and uses instance variables</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_IMMEDIATE_DEREFERENCE_OF_READLINE">NP: Immediate dereference of the result of readLine()</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_LOAD_OF_KNOWN_NULL_VALUE">NP: Load of known null value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE">NP: Possible null pointer dereference due to return value of called method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NS_DANGEROUS_NON_SHORT_CIRCUIT">NS: Potentially dangerous use of non-short-circuit logic</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NS_NON_SHORT_CIRCUIT">NS: Questionable use of non-short-circuit logic</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#PZLA_PREFER_ZERO_LENGTH_ARRAYS">PZLA: Consider returning a zero length array rather than null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#QF_QUESTIONABLE_FOR_LOOP">QF: Complicated, subtle or wrong increment in for-loop </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE">RCN: Redundant comparison of non-null value to null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES">RCN: Redundant comparison of two null values</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE">RCN: Redundant nullcheck of value known to be non-null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE">RCN: Redundant nullcheck of value known to be null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#REC_CATCH_EXCEPTION">REC: Exception is caught when Exception is not thrown</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RI_REDUNDANT_INTERFACES">RI: Class implements same interface as superclass</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_CHECK_FOR_POSITIVE_INDEXOF">RV: Method checks to see if result of String.indexOf is positive</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_REM_OF_HASHCODE">RV: Remainder of hashCode could be negative</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_REM_OF_RANDOM_INT">RV: Remainder of 32-bit signed random integer</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_SELF_ASSIGNMENT">SA: Self assignment of local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SF_SWITCH_FALLTHROUGH">SF: Switch statement found where one case falls through to the next case</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD">ST: Write to static field from instance method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS">Se: Transient field of class that isn't Serializable. </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UCF_USELESS_CONTROL_FLOW">UCF: Useless control flow</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR">UwF: Field not initialized in constructor</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#XFB_XML_FACTORY_BYPASS">XFB: Method directly allocates a specific implementation of xml interfaces</a></td><td>Dodgy</td></tr>
+</table>
+<h2>Descriptions</h2>
+<h3><a name="AM_CREATES_EMPTY_JAR_FILE_ENTRY">AM: Creates an empty jar file entry (AM_CREATES_EMPTY_JAR_FILE_ENTRY)</a></h3>
+
+
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty JarFile entry. The contents of the entry
+should be written to the JarFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
+
+
+<h3><a name="AM_CREATES_EMPTY_ZIP_FILE_ENTRY">AM: Creates an empty zip file entry (AM_CREATES_EMPTY_ZIP_FILE_ENTRY)</a></h3>
+
+
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty ZipFile entry. The contents of the entry
+should be written to the ZipFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
+
+
+<h3><a name="BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS">BC: Equals method should not assume anything about the type of its argument (BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS)</a></h3>
+
+
+<p>
+The <code>equals(Object o)</code> method shouldn't make any assumptions
+about the type of <code>o</code>. It should simply return
+false if <code>o</code> is not the same type as <code>this</code>.
+</p>
+
+
+<h3><a name="DMI_RANDOM_USED_ONLY_ONCE">BC: Random object created and used only once (DMI_RANDOM_USED_ONLY_ONCE)</a></h3>
+
+
+<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards
+the Random object. This produces mediocre quality random numbers and is inefficient.
+If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number
+is required invoke a method on the existing Random object to obtain it.
+</p>
+
+<p>If it is important that the generated Random numbers not be guessable, you <em>must</em> not create a new Random for each random
+number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead
+(and avoid allocating a new SecureRandom for each random number needed).
+</p>
+
+
+<h3><a name="BIT_SIGNED_CHECK">BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK)</a></h3>
+
+
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
+
+
+<h3><a name="CN_IDIOM">CN: Class implements Cloneable but does not define or use clone method (CN_IDIOM)</a></h3>
+
+
+<p>
+ Class implements Cloneable but does not define or
+ use the clone method.</p>
+
+
+<h3><a name="CN_IDIOM_NO_SUPER_CALL">CN: clone method does not call super.clone() (CN_IDIOM_NO_SUPER_CALL)</a></h3>
+
+
+<p> This non-final class defines a clone() method that does not call super.clone().
+If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"),
+and the subclass <i>B</i> calls super.clone(), then it is likely that
+<i>B</i>'s clone() method will return an object of type <i>A</i>,
+which violates the standard contract for clone().</p>
+
+<p> If all clone() methods call super.clone(), then they are guaranteed
+to use Object.clone(), which always returns an object of the correct type.</p>
+
+
+<h3><a name="CO_ABSTRACT_SELF">Co: Abstract class defines covariant compareTo() method (CO_ABSTRACT_SELF)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="CO_SELF_NO_OBJECT">Co: Covariant compareTo() method defined (CO_SELF_NO_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="DE_MIGHT_DROP">DE: Method might drop exception (DE_MIGHT_DROP)</a></h3>
+
+
+ <p> This method might drop an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
+
+
+<h3><a name="DE_MIGHT_IGNORE">DE: Method might ignore exception (DE_MIGHT_IGNORE)</a></h3>
+
+
+ <p> This method might ignore an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
+
+
+<h3><a name="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED">DP: Classloaders should only be created inside doPrivileged block (DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED)</a></h3>
+
+
+ <p> This code creates a classloader, which requires a security manager.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
+
+
+<h3><a name="DP_DO_INSIDE_DO_PRIVILEGED">DP: Method invoked that should be only be invoked inside a doPrivileged block (DP_DO_INSIDE_DO_PRIVILEGED)</a></h3>
+
+
+ <p> This code invokes a method that requires a security permission check.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
+
+
+<h3><a name="DM_EXIT">Dm: Method invokes System.exit(...) (DM_EXIT)</a></h3>
+
+
+ <p> Invoking System.exit shuts down the entire Java virtual machine. This
+ should only been done when it is appropriate. Such calls make it
+ hard or impossible for your code to be invoked by other code.
+ Consider throwing a RuntimeException instead.</p>
+
+
+<h3><a name="DM_RUN_FINALIZERS_ON_EXIT">Dm: Method invokes dangerous method runFinalizersOnExit (DM_RUN_FINALIZERS_ON_EXIT)</a></h3>
+
+
+ <p> <em>Never call System.runFinalizersOnExit
+or Runtime.runFinalizersOnExit for any reason: they are among the most
+dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>
+
+
+<h3><a name="ES_COMPARING_PARAMETER_STRING_WITH_EQ">ES: Comparison of String parameter using == or != (ES_COMPARING_PARAMETER_STRING_WITH_EQ)</a></h3>
+
+
+ <p>This code compares a <code>java.lang.String</code> parameter for reference
+equality using the == or != operators. Requiring callers to
+pass only String constants or interned strings to a method is unnecessarily
+fragile, and rarely leads to measurable performance gains. Consider
+using the <code>equals(Object)</code> method instead.</p>
+
+
+<h3><a name="ES_COMPARING_STRINGS_WITH_EQ">ES: Comparison of String objects using == or != (ES_COMPARING_STRINGS_WITH_EQ)</a></h3>
+
+
+ <p>This code compares <code>java.lang.String</code> objects for reference
+equality using the == or != operators.
+Unless both strings are either constants in a source file, or have been
+interned using the <code>String.intern()</code> method, the same string
+value may be represented by two different String objects. Consider
+using the <code>equals(Object)</code> method instead.</p>
+
+
+<h3><a name="EQ_ABSTRACT_SELF">Eq: Abstract class defines covariant equals() method (EQ_ABSTRACT_SELF)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="EQ_COMPARETO_USE_OBJECT_EQUALS">Eq: Class defines compareTo(...) and uses Object.equals() (EQ_COMPARETO_USE_OBJECT_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>compareTo(...)</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>.
+ Generally, the value of compareTo should return zero if and only if
+ equals returns true. If this is violated, weird and unpredictable
+ failures will occur in classes such as PriorityQueue.
+ In Java 5 the PriorityQueue.remove method uses the compareTo method,
+ while in Java 6 it uses the equals method.
+
+<p>From the JavaDoc for the compareTo method in the Comparable interface:
+<blockquote>
+It is strongly recommended, but not strictly required that <code>(x.compareTo(y)==0) == (x.equals(y))</code>.
+Generally speaking, any class that implements the Comparable interface and violates this condition
+should clearly indicate this fact. The recommended language
+is "Note: this class has a natural ordering that is inconsistent with equals."
+</blockquote>
+
+
+<h3><a name="EQ_SELF_NO_OBJECT">Eq: Covariant equals() method defined (EQ_SELF_NO_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="EQ_SELF_USE_OBJECT">Eq: Covariant equals() method defined, Object.equals(Object) inherited (EQ_SELF_USE_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of the <code>equals()</code>
+ method, but inherits the normal <code>equals(Object)</code> method
+ defined in the base <code>java.lang.Object</code> class.
+ The class should probably define a non-covariant version of <code>equals()</code>.
+ (I.e., a method with the signature <code>boolean equals(java.lang.Object)</code>.</p>
+
+
+<h3><a name="FI_EMPTY">FI: Empty finalizer should be deleted (FI_EMPTY)</a></h3>
+
+
+ <p> Empty <code>finalize()</code> methods are useless, so they should
+ be deleted.</p>
+
+
+<h3><a name="FI_EXPLICIT_INVOCATION">FI: Explicit invocation of finalizer (FI_EXPLICIT_INVOCATION)</a></h3>
+
+
+ <p> This method contains an explicit invocation of the <code>finalize()</code>
+ method on an object. Because finalizer methods are supposed to be
+ executed once, and only by the VM, this is a bad idea.</p>
+<p>If a connected set of objects beings finalizable, then the VM will invoke the
+finalize method on all the finalizable object, possibly at the same time in different threads.
+Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize
+on objects referenced by X, because they may already be getting finalized in a separate thread.
+
+
+<h3><a name="FI_FINALIZER_NULLS_FIELDS">FI: Finalizer nulls fields (FI_FINALIZER_NULLS_FIELDS)</a></h3>
+
+
+ <p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection,
+ and the object is going to be garbage collected anyway.
+
+
+<h3><a name="FI_FINALIZER_ONLY_NULLS_FIELDS">FI: Finalizer only nulls fields (FI_FINALIZER_ONLY_NULLS_FIELDS)</a></h3>
+
+
+ <p> This finalizer does nothing except null out fields. This is completely pointless, and requires that
+the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize
+method.
+
+
+<h3><a name="FI_MISSING_SUPER_CALL">FI: Finalizer does not call superclass finalizer (FI_MISSING_SUPER_CALL)</a></h3>
+
+
+ <p> This <code>finalize()</code> method does not make a call to its
+ superclass's <code>finalize()</code> method. So, any finalizer
+ actions defined for the superclass will not be performed.
+ Add a call to <code>super.finalize()</code>.</p>
+
+
+<h3><a name="FI_NULLIFY_SUPER">FI: Finalizer nullifies superclass finalizer (FI_NULLIFY_SUPER)</a></h3>
+
+
+ <p> This empty <code>finalize()</code> method explicitly negates the
+ effect of any finalizer defined by its superclass. Any finalizer
+ actions defined for the superclass will not be performed.
+ Unless this is intended, delete this method.</p>
+
+
+<h3><a name="FI_USELESS">FI: Finalizer does nothing but call superclass finalizer (FI_USELESS)</a></h3>
+
+
+ <p> The only thing this <code>finalize()</code> method does is call
+ the superclass's <code>finalize()</code> method, making it
+ redundant. Delete it.</p>
+
+
+<h3><a name="HE_EQUALS_NO_HASHCODE">HE: Class defines equals() but not hashCode() (HE_EQUALS_NO_HASHCODE)</a></h3>
+
+
+ <p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>. Therefore, the class may violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+
+<h3><a name="HE_EQUALS_USE_HASHCODE">HE: Class defines equals() and uses Object.hashCode() (HE_EQUALS_USE_HASHCODE)</a></h3>
+
+
+ <p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>, and inherits the implementation of
+ <code>hashCode()</code> from <code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre>
+
+
+<h3><a name="HE_HASHCODE_NO_EQUALS">HE: Class defines hashCode() but not equals() (HE_HASHCODE_NO_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>hashCode()</code> method but not an
+ <code>equals()</code> method. Therefore, the class may
+ violate the invariant that equal objects must have equal hashcodes.</p>
+
+
+<h3><a name="HE_HASHCODE_USE_OBJECT_EQUALS">HE: Class defines hashCode() and uses Object.equals() (HE_HASHCODE_USE_OBJECT_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>hashCode()</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>
+ (which defines equality by comparing object references). Although
+ this will probably satisfy the contract that equal objects must have
+ equal hashcodes, it is probably not what was intended by overriding
+ the <code>hashCode()</code> method. (Overriding <code>hashCode()</code>
+ implies that the object's identity is based on criteria more complicated
+ than simple reference equality.)</p>
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<p><pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre></p>
+
+
+<h3><a name="HE_INHERITS_EQUALS_USE_HASHCODE">HE: Class inherits equals() and uses Object.hashCode() (HE_INHERITS_EQUALS_USE_HASHCODE)</a></h3>
+
+
+ <p> This class inherits <code>equals(Object)</code> from an abstract
+ superclass, and <code>hashCode()</code> from
+<code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+ <p>If you don't want to define a hashCode method, and/or don't
+ believe the object will ever be put into a HashMap/Hashtable,
+ define the <code>hashCode()</code> method
+ to throw <code>UnsupportedOperationException</code>.</p>
+
+
+<h3><a name="IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION">IC: Superclass uses subclass during initialization (IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION)</a></h3>
+
+
+ <p> During the initialization of a class, the class makes an active use of a subclass.
+That subclass will not yet be initialized at the time of this use.
+For example, in the following code, <code>foo</code> will be null.</p>
+
+<pre>
+public class CircularClassInitialization {
+ static class InnerClassSingleton extends CircularClassInitialization {
+ static InnerClassSingleton singleton = new InnerClassSingleton();
+ }
+
+ static CircularClassInitialization foo = InnerClassSingleton.singleton;
+}
+</pre>
+
+
+
+<h3><a name="IMSE_DONT_CATCH_IMSE">IMSE: Dubious catching of IllegalMonitorStateException (IMSE_DONT_CATCH_IMSE)</a></h3>
+
+
+<p>IllegalMonitorStateException is generally only
+ thrown in case of a design flaw in your code (calling wait or
+ notify on an object you do not hold a lock on).</p>
+
+
+<h3><a name="ISC_INSTANTIATE_STATIC_CLASS">ISC: Needless instantiation of class that only supplies static methods (ISC_INSTANTIATE_STATIC_CLASS)</a></h3>
+
+
+<p> This class allocates an object that is based on a class that only supplies static methods. This object
+does not need to be created, just access the static methods directly using the class name as a qualifier.</p>
+
+
+<h3><a name="IT_NO_SUCH_ELEMENT">It: Iterator next() method can't throw NoSuchElement exception (IT_NO_SUCH_ELEMENT)</a></h3>
+
+
+ <p> This class implements the <code>java.util.Iterator</code> interface.
+ However, its <code>next()</code> method is not capable of throwing
+ <code>java.util.NoSuchElementException</code>. The <code>next()</code>
+ method should be changed so it throws <code>NoSuchElementException</code>
+ if is called when there are no more elements to return.</p>
+
+
+<h3><a name="J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION">J2EE: Store of non serializable object into HttpSession (J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION)</a></h3>
+
+
+<p>
+This code seems to be storing a non-serializable object into an HttpSession.
+If this session is passivated or migrated, an error will result.
+</p>
+
+
+<h3><a name="NP_CLONE_COULD_RETURN_NULL">NP: Clone method may return null (NP_CLONE_COULD_RETURN_NULL)</a></h3>
+
+
+ <p>
+ This clone method seems to return null in some circumstances, but clone is never
+ allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError
+ instead.
+ </p>
+
+
+<h3><a name="NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT">NP: equals() method does not check for null argument (NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT)</a></h3>
+
+
+ <p>
+ This implementation of equals(Object) violates the contract defined
+ by java.lang.Object.equals() because it does not check for null
+ being passed as the argument. All equals() methods should return
+ false if passed a null value.
+ </p>
+
+
+<h3><a name="NP_TOSTRING_COULD_RETURN_NULL">NP: toString method may return null (NP_TOSTRING_COULD_RETURN_NULL)</a></h3>
+
+
+ <p>
+ This toString method seems to return null in some circumstances. A liberal reading of the
+ spec could be interpreted as allowing this, but it is probably a bad idea and could cause
+ other code to break. Return the empty string or some other appropriate string rather than null.
+ </p>
+
+
+<h3><a name="NM_CLASS_NAMING_CONVENTION">Nm: Class names should start with an upper case letter (NM_CLASS_NAMING_CONVENTION)</a></h3>
+
+
+ <p> Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).
+</p>
+
+
+<h3><a name="NM_CLASS_NOT_EXCEPTION">Nm: Class is not derived from an Exception, even though it is named as such (NM_CLASS_NOT_EXCEPTION)</a></h3>
+
+
+<p> This class is not derived from another exception, but ends with 'Exception'. This will
+be confusing to users of this class.</p>
+
+
+<h3><a name="NM_CONFUSING">Nm: Confusing method names (NM_CONFUSING)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.</p>
+
+
+<h3><a name="NM_FIELD_NAMING_CONVENTION">Nm: Field names should start with an lower case letter (NM_FIELD_NAMING_CONVENTION)</a></h3>
+
+
+ <p>
+Names of fields that are not final should be in mixed case with a lowercase first letter and the first letters of subsequent words capitalized.
+</p>
+
+
+<h3><a name="NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER)</a></h3>
+
+
+<p>The identifier is a word that is reserversed as a keyword in later versions of Java, and your code will need to be changed
+in order to compile it in later versions of Java.</p>
+
+
+
+<h3><a name="NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER)</a></h3>
+
+
+<p>This identifier is used as a keyword in later versions of Java. This code, and
+any code that references this API,
+will need to be changed in order to compile it in later versions of Java.</p>
+
+
+
+<h3><a name="NM_METHOD_NAMING_CONVENTION">Nm: Method names should start with an lower case letter (NM_METHOD_NAMING_CONVENTION)</a></h3>
+
+
+ <p>
+Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.
+</p>
+
+
+<h3><a name="NM_SAME_SIMPLE_NAME_AS_INTERFACE">Nm: Class names shouldn't shadow simple name of implemented interface (NM_SAME_SIMPLE_NAME_AS_INTERFACE)</a></h3>
+
+
+ <p> This class/interface has a simple name that is identical to that of an implemented/extended interface, except
+that the interface is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
+
+
+<h3><a name="NM_SAME_SIMPLE_NAME_AS_SUPERCLASS">Nm: Class names shouldn't shadow simple name of superclass (NM_SAME_SIMPLE_NAME_AS_SUPERCLASS)</a></h3>
+
+
+ <p> This class has a simple name that is identical to that of its superclass, except
+that its superclass is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
+
+
+<h3><a name="NM_VERY_CONFUSING_INTENTIONAL">Nm: Very confusing method names (NM_VERY_CONFUSING_INTENTIONAL)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other. From the existence of other methods, it
+seems that the existence of both of these methods is intentional, but is sure is confusing.
+You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.
+</p>
+
+
+<h3><a name="NM_WRONG_PACKAGE_INTENTIONAL">Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE_INTENTIONAL)</a></h3>
+
+
+ <p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+ public int f(alpha.Foo x) { return 27; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
+
+<p>In this case, the subclass does define a method with a signature identical to the method in the superclass,
+so this is presumably understood. However, such methods are exceptionally confusing. You should strongly consider
+removing or deprecating the method with the similar but not identical signature.
+</p>
+
+
+<h3><a name="ODR_OPEN_DATABASE_RESOURCE">ODR: Method may fail to close database resource (ODR_OPEN_DATABASE_RESOURCE)</a></h3>
+
+
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.
+</p>
+
+
+<h3><a name="ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH">ODR: Method may fail to close database resource on exception (ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH)</a></h3>
+
+
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all exception paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.</p>
+
+
+<h3><a name="OS_OPEN_STREAM">OS: Method may fail to close stream (OS_OPEN_STREAM)</a></h3>
+
+
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods that might close it,
+or return it, and does not appear to close
+the stream on all paths out of the method. This may result in
+a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
+
+
+<h3><a name="OS_OPEN_STREAM_EXCEPTION_PATH">OS: Method may fail to close stream on exception (OS_OPEN_STREAM_EXCEPTION_PATH)</a></h3>
+
+
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+it on all possible exception paths out of the method.
+This may result in a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
+
+
+<h3><a name="RC_REF_COMPARISON">RC: Suspicious reference comparison (RC_REF_COMPARISON)</a></h3>
+
+
+<p> This method compares two reference values using the == or != operator,
+where the correct way to compare instances of this type is generally
+with the equals() method. Examples of classes which should generally
+not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>
+
+
+<h3><a name="RR_NOT_CHECKED">RR: Method ignores results of InputStream.read() (RR_NOT_CHECKED)</a></h3>
+
+
+ <p> This method ignores the return value of one of the variants of
+ <code>java.io.InputStream.read()</code> which can return multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were read than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ reads from input streams usually do read the full amount of data requested,
+ causing the program to fail only sporadically.</p>
+
+
+<h3><a name="SR_NOT_CHECKED">RR: Method ignores results of InputStream.skip() (SR_NOT_CHECKED)</a></h3>
+
+
+ <p> This method ignores the return value of
+ <code>java.io.InputStream.skip()</code> which can skip multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were skipped than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ skips from input streams usually do skip the full amount of data requested,
+ causing the program to fail only sporadically. With Buffered streams, however,
+ skip() will only skip data in the buffer, and will routinely fail to skip the
+ requested number of bytes.</p>
+
+
+<h3><a name="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE">RV: Method ignores return value (RV_RETURN_VALUE_IGNORED_BAD_PRACTICE)</a></h3>
+
+
+ <p> This method returns a value that is not checked. For
+example, the <code>File.delete()</code> method returns false
+if the file could not be successfully deleted (rather than
+throwing an Exception).
+If you don't check the result, you won't notice if the method invocation
+signals unexpected behavior by returning an atypical return value.
+
+
+<h3><a name="SI_INSTANCE_BEFORE_FINALS_ASSIGNED">SI: Static initializer creates instance before all static final fields assigned (SI_INSTANCE_BEFORE_FINALS_ASSIGNED)</a></h3>
+
+
+<p> The class's static initializer creates an instance of the class
+before all of the static final fields are assigned.</p>
+
+
+<h3><a name="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE">SQL: Nonconstant string passed to execute method on an SQL statement (SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE)</a></h3>
+
+
+ <p>The method invokes the execute method on an SQL statement with a String that seems
+to be dynamically generated. Consider using
+a prepared statement instead. It is more efficient and less vulnerable to
+SQL injection attacks.
+</p>
+
+
+<h3><a name="SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING">SQL: A prepared statement is generated from a nonconstant String (SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING)</a></h3>
+
+
+ <p>The code creates an SQL prepared statement from a nonconstant String.
+If unchecked, tainted data from a user is used in building this String, SQL injection could
+be used to make the prepared statement do something unexpected and undesirable.
+</p>
+
+
+<h3><a name="SW_SWING_METHODS_INVOKED_IN_SWING_THREAD">SW: Certain swing methods needs to be invoked in Swing thread (SW_SWING_METHODS_INVOKED_IN_SWING_THREAD)</a></h3>
+
+
+<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods
+show(), setVisible(), and pack() will create the associated peer for the frame.
+With the creation of the peer, the system creates the event dispatch thread.
+This makes things problematic because the event dispatch thread could be notifying
+listeners while pack and validate are still processing. This situation could result in
+two threads going through the Swing component-based GUI -- it's a serious flaw that
+could result in deadlocks or other related threading issues. A pack call causes
+components to be realized. As they are being realized (that is, not necessarily
+visible), they could trigger listener notification on the event dispatch thread.</p>
+
+
+
+<h3><a name="SE_BAD_FIELD">Se: Non-transient non-serializable instance field in serializable class (SE_BAD_FIELD)</a></h3>
+
+
+<p> This Serializable class defines a non-primitive instance field which is neither transient,
+Serializable, or <code>java.lang.Object</code>, and does not appear to implement
+the <code>Externalizable</code> interface or the
+<code>readObject()</code> and <code>writeObject()</code> methods.
+Objects of this class will not be deserialized correctly if a non-Serializable
+object is stored in this field.</p>
+
+
+<h3><a name="SE_BAD_FIELD_INNER_CLASS">Se: Non-serializable class has a serializable inner class (SE_BAD_FIELD_INNER_CLASS)</a></h3>
+
+
+<p> This Serializable class is an inner class of a non-serializable class.
+Thus, attempts to serialize it will also attempt to associate instance of the outer
+class with which it is associated, leading to a runtime error.
+</p>
+<p>If possible, making the inner class a static inner class should solve the
+problem. Making the outer class serializable might also work, but that would
+mean serializing an instance of the inner class would always also serialize the instance
+of the outer class, which it often not what you really want.
+
+
+<h3><a name="SE_BAD_FIELD_STORE">Se: Non-serializable value stored into instance field of a serializable class (SE_BAD_FIELD_STORE)</a></h3>
+
+
+<p> A non-serializable value is stored into a non-transient field
+of a serializable class.</p>
+
+
+<h3><a name="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE">Se: Comparator doesn't implement Serializable (SE_COMPARATOR_SHOULD_BE_SERIALIZABLE)</a></h3>
+
+
+ <p> This class implements the <code>Comparator</code> interface. You
+should consider whether or not it should also implement the <code>Serializable</code>
+interface. If a comparator is used to construct an ordered collection
+such as a <code>TreeMap</code>, then the <code>TreeMap</code>
+will be serializable only if the comparator is also serializable.
+As most comparators have little or no state, making them serializable
+is generally easy and good defensive programming.
+</p>
+
+
+<h3><a name="SE_INNER_CLASS">Se: Serializable inner class (SE_INNER_CLASS)</a></h3>
+
+
+<p> This Serializable class is an inner class. Any attempt to serialize
+it will also serialize the associated outer instance. The outer instance is serializable,
+so this won't fail, but it might serialize a lot more data than intended.
+If possible, making the inner class a static inner class (also known as a nested class) should solve the
+problem.
+
+
+<h3><a name="SE_METHOD_MUST_BE_PRIVATE">Se: Method must be private in order for serialization to work (SE_METHOD_MUST_BE_PRIVATE)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface, and defines a method
+ for custom serialization/deserialization. But since that method isn't declared private,
+ it will be silently ignored by the serialization/deserialization API.</p>
+
+
+<h3><a name="SE_NONFINAL_SERIALVERSIONID">Se: serialVersionUID isn't final (SE_NONFINAL_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not final.
+ The field should be made final
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NONLONG_SERIALVERSIONID">Se: serialVersionUID isn't long (SE_NONLONG_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not long.
+ The field should be made long
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NONSTATIC_SERIALVERSIONID">Se: serialVersionUID isn't static (SE_NONSTATIC_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not static.
+ The field should be made static
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NO_SUITABLE_CONSTRUCTOR">Se: Class is Serializable but its superclass doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface
+ and its superclass does not. When such an object is deserialized,
+ the fields of the superclass need to be initialized by
+ invoking the void constructor of the superclass.
+ Since the superclass does not have one,
+ serialization and deserialization will fail at runtime.</p>
+
+
+<h3><a name="SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION">Se: Class is Externalizable but doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION)</a></h3>
+
+
+ <p> This class implements the <code>Externalizable</code> interface, but does
+ not define a void constructor. When Externalizable objects are deserialized,
+ they first need to be constructed by invoking the void
+ constructor. Since this class does not have one,
+ serialization and deserialization will fail at runtime.</p>
+
+
+<h3><a name="SE_READ_RESOLVE_MUST_RETURN_OBJECT">Se: The readResolve method must be declared with a return type
+of Object. (SE_READ_RESOLVE_MUST_RETURN_OBJECT)</a></h3>
+
+
+ <p> In order for the readResolve method to be recognized by the serialization
+mechanism.
+</p>
+
+
+<h3><a name="SE_TRANSIENT_FIELD_NOT_RESTORED">Se: Transient field that isn't set by deserialization. (SE_TRANSIENT_FIELD_NOT_RESTORED)</a></h3>
+
+
+ <p> This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any
+deserialized instance of the class.
+</p>
+
+
+<h3><a name="SE_NO_SERIALVERSIONID">SnVI: Class is Serializable, but doesn't define serialVersionUID (SE_NO_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface, but does
+ not define a <code>serialVersionUID</code> field.
+ A change as simple as adding a reference to a .class object
+ will add synthetic fields to the class,
+ which will unfortunately change the implicit
+ serialVersionUID (e.g., adding a reference to <code>String.class</code>
+ will generate a static field <code>class$java$lang$String</code>).
+ Also, different source code to bytecode compilers may use different
+ naming conventions for synthetic variables generated for
+ references to class objects or inner classes.
+ To ensure interoperability of Serializable across versions,
+ consider adding an explicit serialVersionUID.</p>
+
+
+<h3><a name="UI_INHERITANCE_UNSAFE_GETRESOURCE">UI: Usage of GetResource may be unsafe if class is extended (UI_INHERITANCE_UNSAFE_GETRESOURCE)</a></h3>
+
+
+<p>Calling <code>this.getClass().getResource(...)</code> could give
+results other than expected if this class is extended by a class in
+another package.</p>
+
+
+<h3><a name="BC_IMPOSSIBLE_CAST">BC: Impossible cast (BC_IMPOSSIBLE_CAST)</a></h3>
+
+
+<p>
+This cast will always throw a ClassCastException.
+</p>
+
+
+<h3><a name="BC_IMPOSSIBLE_INSTANCEOF">BC: instanceof will always return false (BC_IMPOSSIBLE_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return false. Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="BIT_AND">BIT: Incompatible bit masks (BIT_AND)</a></h3>
+
+
+<p> This method compares an expression of the form (a & C) to D,
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
+
+
+<h3><a name="BIT_AND_ZZ">BIT: Check to see if ((...) & 0) == 0 (BIT_AND_ZZ)</a></h3>
+
+
+<p> This method compares an expression of the form (a & 0) to 0,
+which will always compare equal.
+This may indicate a logic error or typo.</p>
+
+
+<h3><a name="BIT_IOR">BIT: Incompatible bit masks (BIT_IOR)</a></h3>
+
+
+<p> This method compares an expression of the form (a | C) to D.
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
+
+<p> Typically, this bug occurs because the code wants to perform
+a membership test in a bit set, but uses the bitwise OR
+operator ("|") instead of bitwise AND ("&").</p>
+
+
+<h3><a name="BIT_IOR_OF_SIGNED_BYTE">BIT: Bitwise OR of signed byte value (BIT_IOR_OF_SIGNED_BYTE)</a></h3>
+
+
+<p> Loads a value from a byte array and performs a bitwise OR with
+that value. Values loaded from a byte array are sign extended to 32 bits
+before any any bitwise operations are performed on the value.
+Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
+<code>x</code> is initially 0, then the code
+<code>((x << 8) | b[0])</code> will sign extend <code>0xff</code>
+to get <code>0xffffffff</code>, and thus give the value
+<code>0xffffffff</code> as the result.
+</p>
+
+<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
+<code>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | b[i]);
+</code>
+
+<p>The following idiom will work instead: </p>
+<code>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | (b[i] &s; 0xff));
+</code>
+
+
+
+<h3><a name="BIT_SIGNED_CHECK_HIGH_BIT">BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK_HIGH_BIT)</a></h3>
+
+
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
+
+
+<h3><a name="BOA_BADLY_OVERRIDDEN_ADAPTER">BOA: Class overrides a method implemented in super class Adapter wrongly (BOA_BADLY_OVERRIDDEN_ADAPTER)</a></h3>
+
+
+<p> This method overrides a method found in a parent class, where that class is an Adapter that implements
+a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not
+get called when the event occurs.</p>
+
+
+<h3><a name="BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR">Bx: Primitive value is unboxed and coerced for ternary operator (BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR)</a></h3>
+
+
+ <p>A wrapped primative value is unboxed and converted to another primative type as part of the
+evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The
+semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped
+numeric values, the values are unboxed and converted/coerced to their common type (e.g,
+if <code>e1</code> is of type <code>Integer</code>
+and <code>e2</code> is of type <code>Float</code>, then <code>e1</code> is unboxed,
+converted to a floating point value, and boxed. See JLS Section 15.25.
+</p>
+
+
+<h3><a name="DLS_DEAD_STORE_OF_CLASS_LITERAL">DLS: Dead store of class literal (DLS_DEAD_STORE_OF_CLASS_LITERAL)</a></h3>
+
+
+<p>
+This instruction assigns a class literal to a variable and then never uses it.
+<a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">The behavior of this differs in Java 1.4 and in Java 5.</a>
+In Java 1.4 and earlier, a reference to <code>Foo.class</code> would force the static initializer
+for <code>Foo</code> to be executed, if it has not been executed already.
+In Java 5 and later, it does not.
+</p>
+<p>See Sun's <a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">article on Java SE compatibility</a>
+for more details and examples, and suggestions on how to force class initialization in Java 5.
+</p>
+
+
+<h3><a name="DLS_OVERWRITTEN_INCREMENT">DLS: Overwritten increment (DLS_OVERWRITTEN_INCREMENT)</a></h3>
+
+
+<p>
+The code performs an increment operation (e.g., <code>i++</code>) and then
+immediately overwrites it. For example, <code>i = i++</code> immediately
+overwrites the incremented value with the original value.
+</p>
+
+
+<h3><a name="DMI_BAD_MONTH">DMI: Bad constant value for month (DMI_BAD_MONTH)</a></h3>
+
+
+<p>
+This code passes a constant month
+value outside the expected range of 0..11 to a method.
+</p>
+
+
+<h3><a name="DMI_CALLING_NEXT_FROM_HASNEXT">DMI: hasNext method invokes next (DMI_CALLING_NEXT_FROM_HASNEXT)</a></h3>
+
+
+<p>
+The hasNext() method invokes the next() method. This is almost certainly wrong,
+since the hasNext() method is not supposed to change the state of the iterator,
+and the next method is supposed to change the state of the iterator.
+</p>
+
+
+<h3><a name="DMI_INVOKING_TOSTRING_ON_ARRAY">DMI: Invocation of toString on an array (DMI_INVOKING_TOSTRING_ON_ARRAY)</a></h3>
+
+
+<p>
+The code invokes toString on an array, which will generate a fairly useless result
+such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
+String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
+</p>
+
+
+<h3><a name="DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT">DMI: Double.longBitsToDouble invoked on an int (DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT)</a></h3>
+
+
+<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed
+ as an argument. This almostly certainly is not intended and is unlikely
+ to give the intended result.
+</p>
+
+
+<h3><a name="DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION">Dm: Can't use reflection to check for presence of annotation with default retention (DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION)</a></h3>
+
+
+ <p> Unless an annotation has itself been annotated with a @Retention other than the default
+of source-only retention, the annotation isn't retained in the classfile and can't be observed using reflection
+ (e.g., by using the isAnnotationPresent method).
+ .</p>
+
+
+<h3><a name="EC_ARRAY_AND_NONARRAY">EC: equals() used to compare array and nonarray (EC_ARRAY_AND_NONARRAY)</a></h3>
+
+
+<p>
+This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem
+to be an array. If things being compared are of different types, they are guaranteed to be unequal
+and the comparison is almost certainly an error. Even if they are both arrays, the equals method
+on arrays only determines of the two arrays are the same object.
+To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
+
+
+<h3><a name="EC_BAD_ARRAY_COMPARE">EC: Invocation of equals() on an array, which is equivalent to == (EC_BAD_ARRAY_COMPARE)</a></h3>
+
+
+<p>
+This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals
+method of Object, calling equals on an array is the same as comparing their addresses. To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
+
+
+<h3><a name="EC_NULL_ARG">EC: Call to equals() with null argument (EC_NULL_ARG)</a></h3>
+
+
+<p> This method calls equals(Object), passing a null value as
+the argument. According to the contract of the equals() method,
+this call should always return <code>false</code>.</p>
+
+
+<h3><a name="EC_UNRELATED_CLASS_AND_INTERFACE">EC: Call to equals() comparing unrelated class and interface (EC_UNRELATED_CLASS_AND_INTERFACE)</a></h3>
+
+
+<p>
+This method calls equals(Object) on two references, one of which is a class
+and the other an interface, where neither the class nor any of its
+non-abstract subclasses implement the interface.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_INTERFACES">EC: Call to equals() comparing different interface types (EC_UNRELATED_INTERFACES)</a></h3>
+
+
+<p> This method calls equals(Object) on two references of unrelated
+interface types, where neither is a subtype of the other,
+and there are no known non-abstract classes which implement both interfaces.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_TYPES">EC: Call to equals() comparing different types (EC_UNRELATED_TYPES)</a></h3>
+
+
+<p> This method calls equals(Object) on two references of different
+class types with no common subclasses.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_TYPES_USING_POINTER_EQUALITY">EC: Using pointer equality to compare different types (EC_UNRELATED_TYPES_USING_POINTER_EQUALITY)</a></h3>
+
+
+<p> This method uses using pointer equality to compare two references that seem to be of
+different types. The result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EQ_DONT_DEFINE_EQUALS_FOR_ENUM">Eq: Covariant equals() method defined for enum (EQ_DONT_DEFINE_EQUALS_FOR_ENUM)</a></h3>
+
+
+ <p> This class defines an enumeration, and equality on enumerations are defined
+using object identity. Definine a covariant equals method for an enumeration
+value is exceptionally bad practice, since it would likely result
+in having two different enumeration values that compare as equals using
+the covariant enum method, and as not equal when compared normally.
+Don't do it.
+</p>
+
+
+<h3><a name="EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC">Eq: equals method overrides equals in superclass and may not be symmetric (EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC)</a></h3>
+
+
+ <p> This class defines an equals method that overrides an equals method in a superclass. Both equals methods
+methods use <code>instanceof</code> in the determination of whether two objects are equals. This is fraught with peril,
+since it is important that the equals method is symetrical (in other words, <code>a.equals(b) == b.equals(a)</code>).
+If B is a subtype of A, and A's equals method checks that the argument is an instanceof A, and B's equals method
+checks that the argument is an instanceof B, it is quite likely that the equivalence relation defined by these
+methods is not symmetric.
+
+
+<h3><a name="FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER">FE: Doomed test for equality to NaN (FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER)</a></h3>
+
+
+ <p>
+ This code checks to see if a floating point value is equal to the special
+ Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However,
+ because of the special semantics of <code>NaN</code>, no value
+ is equal to <code>Nan</code>, including <code>NaN</code>. Thus,
+ <code>x == Double.NaN</code> always evaluates to false.
+
+ To check to see if a value contained in <code>x</code>
+ is the special Not A Number value, use
+ <code>Double.isNaN(x)</code> (or <code>Float.isNaN(x)</code> if
+ <code>x</code> is floating point precision).
+ </p>
+
+
+<h3><a name="GC_UNRELATED_TYPES">GC: No relationship between generic parameter and method argument (GC_UNRELATED_TYPES)</a></h3>
+
+
+ <p> This call to a generic container's method contains an argument
+ with a different class type from that of the container's parameter.
+ Therefore, it is unlikely that the container contains any objects
+ with the same type as the method argument used here.
+ </p>
+
+
+<h3><a name="HE_USE_OF_UNHASHABLE_CLASS">HE: Use of class without a hashCode() method in a hashed data structure (HE_USE_OF_UNHASHABLE_CLASS)</a></h3>
+
+
+ <p> A class defines an equals(Object) method but not a hashCode() method,
+and thus doesn't fulfill the requirement that equal Objects have equal hashCodes.
+An instance of this class is used in a hash data structure, making the need to
+fix this problem of highest importance.
+
+
+<h3><a name="ICAST_BAD_SHIFT_AMOUNT">ICAST: Integer shift by an amount not in the range 0..31 (ICAST_BAD_SHIFT_AMOUNT)</a></h3>
+
+
+<p>
+The code performs an integer shift by a constant amount outside
+the range 0..31.
+The effect of this is to use the lower 5 bits of the integer
+value to decide how much to shift by. This probably isn't want was expected,
+and it at least confusing.
+</p>
+
+
+<h3><a name="ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL">ICAST: int value cast to double and then passed to Math.ceil (ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL)</a></h3>
+
+
+<p>
+This code converts an int value to a double precision
+floating point number and then
+passing the result to the Math.ceil() function, which rounds a double to
+the next higher integer value. This operation should always be a no-op,
+since the converting an integer to a double should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.ceil was intended to be performed using double precision
+floating point arithmetic.
+</p>
+
+
+
+<h3><a name="ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND">ICAST: int value cast to float and then passed to Math.round (ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND)</a></h3>
+
+
+<p>
+This code converts an int value to a float precision
+floating point number and then
+passing the result to the Math.round() function, which returns the int/long closest
+to the argument. This operation should always be a no-op,
+since the converting an integer to a float should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.round was intended to be performed using
+floating point arithmetic.
+</p>
+
+
+
+<h3><a name="IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD">IJU: JUnit assertion in run method will not be noticed by JUnit (IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD)</a></h3>
+
+
+<p> A JUnit assertion is performed in a run method. Failed JUnit assertions
+just result in exceptions being thrown.
+Thus, if this exception occurs in a thread other than the thread that invokes
+the test method, the exception will terminate the thread but not result
+in the test failing.
+</p>
+
+
+<h3><a name="IJU_BAD_SUITE_METHOD">IJU: TestCase declares a bad suite method (IJU_BAD_SUITE_METHOD)</a></h3>
+
+
+<p> Class is a JUnit TestCase and defines a suite() method.
+However, the suite method needs to be declared as either
+<pre>public static junit.framework.Test suite()</pre>
+or
+<pre>public static junit.framework.TestSuite suite()</pre>
+</p>
+
+
+<h3><a name="IJU_NO_TESTS">IJU: TestCase has no tests (IJU_NO_TESTS)</a></h3>
+
+
+<p> Class is a JUnit TestCase but has not implemented any test methods</p>
+
+
+<h3><a name="IJU_SETUP_NO_SUPER">IJU: TestCase implements setUp but doesn't call super.setUp() (IJU_SETUP_NO_SUPER)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call
+super.setUp(), but doesn't.</p>
+
+
+<h3><a name="IJU_SUITE_NOT_STATIC">IJU: TestCase implements a non-static suite method (IJU_SUITE_NOT_STATIC)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the suite() method.
+ The suite method should be declared as being static, but isn't.</p>
+
+
+<h3><a name="IJU_TEARDOWN_NO_SUPER">IJU: TestCase implements tearDown but doesn't call super.tearDown() (IJU_TEARDOWN_NO_SUPER)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call
+super.tearDown(), but doesn't.</p>
+
+
+<h3><a name="IL_CONTAINER_ADDED_TO_ITSELF">IL: A container is added to itself (IL_CONTAINER_ADDED_TO_ITSELF)</a></h3>
+
+
+<p>A container is added to itself. As a result, computing the hashCode of this
+set will throw a StackOverflowException.
+</p>
+
+
+<h3><a name="IL_INFINITE_LOOP">IL: An apparent infinite loop (IL_INFINITE_LOOP)</a></h3>
+
+
+<p>This loop doesn't seem to have a way to terminate (other than by perhaps
+throwing an exception).</p>
+
+
+<h3><a name="IL_INFINITE_RECURSIVE_LOOP">IL: An apparent infinite recursive loop (IL_INFINITE_RECURSIVE_LOOP)</a></h3>
+
+
+<p>This method unconditionally invokes itself. This would seem to indicate
+an infinite recursive loop that will result in a stack overflow.</p>
+
+
+<h3><a name="IM_MULTIPLYING_RESULT_OF_IREM">IM: Integer multiply of result of integer remainder (IM_MULTIPLYING_RESULT_OF_IREM)</a></h3>
+
+
+<p>
+The code multiplies the result of an integer remaining by an integer constant.
+Be sure you don't have your operator precedence confused. For example
+i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000).
+</p>
+
+
+<h3><a name="INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE">INT: Bad comparison of nonnegative value with negative constant (INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE)</a></h3>
+
+
+<p> This code compares a value that is guaranteed to be non-negative with a negative constant.
+</p>
+
+
+<h3><a name="INT_BAD_COMPARISON_WITH_SIGNED_BYTE">INT: Bad comparison of signed byte (INT_BAD_COMPARISON_WITH_SIGNED_BYTE)</a></h3>
+
+
+<p> Signed bytes can only have a value in the range -128 to 127. Comparing
+a signed byte with a value outside that range is vacuous and likely to be incorrect.
+To convert a signed byte <code>b</code> to an unsigned value in the range 0..255,
+use <code>0xff & b</code>
+</p>
+
+
+<h3><a name="INT_BAD_REM_BY_1">INT: Integer remainder modulo 1 (INT_BAD_REM_BY_1)</a></h3>
+
+
+<p> Any expression (exp % 1) is guaranteed to always return zero.
+Did you mean (exp & 1) or (exp % 2) instead?
+</p>
+
+
+<h3><a name="IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN">IP: A parameter is dead upon entry to a method but overwritten (IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN)</a></h3>
+
+
+<p>
+The initial value of this parameter is ignored, and the parameter
+is overwritten here. This often indicates a mistaken belief that
+the write to the parameter will be conveyed back to
+the caller.
+</p>
+
+
+<h3><a name="JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS">JCIP: Fields of immutable classes should be final (JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS)</a></h3>
+
+
+ <p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require
+that all fields are final.
+ .</p>
+
+
+<h3><a name="MF_CLASS_MASKS_FIELD">MF: Class defines field that masks a superclass field (MF_CLASS_MASKS_FIELD)</a></h3>
+
+
+<p> This class defines a field with the same name as a visible
+instance field in a superclass. This is confusing, and
+may indicate an error if methods update or access one of
+the fields when they wanted the other.</p>
+
+
+<h3><a name="MF_METHOD_MASKS_FIELD">MF: Method defines a variable that obscures a field (MF_METHOD_MASKS_FIELD)</a></h3>
+
+
+<p> This method defines a local variable with the same name as a field
+in this class or a superclass. This may cause the method to
+read an uninitialized value from the field, leave the field uninitialized,
+or both.</p>
+
+
+<h3><a name="NP_ALWAYS_NULL">NP: Null pointer dereference (NP_ALWAYS_NULL)</a></h3>
+
+
+<p> A null pointer is dereferenced here. This will lead to a
+<code>NullPointerException</code> when the code is executed.</p>
+
+
+<h3><a name="NP_ALWAYS_NULL_EXCEPTION">NP: Null pointer dereference in method on exception path (NP_ALWAYS_NULL_EXCEPTION)</a></h3>
+
+
+<p> A pointer which is null on an exception path is dereferenced here.
+This will lead to a <code>NullPointerException</code> when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
+
+
+<h3><a name="NP_ARGUMENT_MIGHT_BE_NULL">NP: Method does not check for null argument (NP_ARGUMENT_MIGHT_BE_NULL)</a></h3>
+
+
+ <p>
+ A parameter to this method has been identified as a value that should
+ always be checked to see whether or not it is null, but it is being dereferenced
+ without a preceding null check.
+ </p>
+
+
+<h3><a name="NP_GUARANTEED_DEREF">NP: Null value is guaranteed to be dereferenced (NP_GUARANTEED_DEREF)</a></h3>
+
+
+ <p>
+ There is a statement or branch that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
+
+
+<h3><a name="NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH">NP: Value is null and guaranteed to be dereferenced on exception path (NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH)</a></h3>
+
+
+ <p>
+ There is a statement or branch on an exception path
+ that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
+
+
+<h3><a name="NP_NONNULL_PARAM_VIOLATION">NP: Method call passes null to a nonnull parameter (NP_NONNULL_PARAM_VIOLATION)</a></h3>
+
+
+ <p>
+ This method passes a null value as the parameter of a method which
+ must be nonnull. Either this parameter has been explicitly marked
+ as @Nonnull, or analysis has determined that this parameter is
+ always dereferenced.
+ </p>
+
+
+<h3><a name="NP_NONNULL_RETURN_VIOLATION">NP: Method may return null, but is declared @NonNull (NP_NONNULL_RETURN_VIOLATION)</a></h3>
+
+
+ <p>
+ This method may return a null value, but the method (or a superclass method
+ which it overrides) is declared to return @NonNull.
+ </p>
+
+
+<h3><a name="NP_NULL_INSTANCEOF">NP: A known null value is checked to see if it is an instance of a type (NP_NULL_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return false, since the value being checked is guaranteed to be null.
+Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH">NP: Possible null pointer dereference (NP_NULL_ON_SOME_PATH)</a></h3>
+
+
+<p> A reference value dereferenced here might be null at runtime.
+This may lead to a <code>NullPointerException</code> when the code is executed.</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH_EXCEPTION">NP: Possible null pointer dereference in method on exception path (NP_NULL_ON_SOME_PATH_EXCEPTION)</a></h3>
+
+
+<p> A reference value which is null on some exception control path is
+dereferenced here. This may lead to a <code>NullPointerException</code>
+when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF">NP: Method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF)</a></h3>
+
+
+ <p>
+ This method call passes a null value to a method which might
+ dereference it unconditionally.
+ </p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS">NP: Method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS)</a></h3>
+
+
+ <p>
+ A possibly-null value is passed at a call site where all known
+ target methods will unconditionally dereference it.
+ This is very likely to result in a null pointer exception.
+ </p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF_NONVIRTUAL">NP: Non-virtual method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF_NONVIRTUAL)</a></h3>
+
+
+ <p>
+ A possibly-null value is passed to a method which unconditionally
+ dereferences it. This will almost certainly result in a null pointer exception.
+ </p>
+
+
+<h3><a name="NP_STORE_INTO_NONNULL_FIELD">NP: Store of null value into field annotated NonNull (NP_STORE_INTO_NONNULL_FIELD)</a></h3>
+
+
+<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>
+
+
+<h3><a name="NP_UNWRITTEN_FIELD">NP: Read of unwritten field (NP_UNWRITTEN_FIELD)</a></h3>
+
+
+ <p> The program is dereferencing a field that does not seem to ever have a non-null value written to it.
+Dereferencing this value will generate a null pointer exception.
+</p>
+
+
+<h3><a name="NM_BAD_EQUAL">Nm: Class defines equal(); should it be equals()? (NM_BAD_EQUAL)</a></h3>
+
+
+<p> This class defines a method <code>equal(Object)</code>. This method does
+not override the <code>equals(Object)</code> method in <code>java.lang.Object</code>,
+which is probably what was intended.</p>
+
+
+<h3><a name="NM_LCASE_HASHCODE">Nm: Class defines hashcode(); should it be hashCode()? (NM_LCASE_HASHCODE)</a></h3>
+
+
+ <p> This class defines a method called <code>hashcode()</code>. This method
+ does not override the <code>hashCode()</code> method in <code>java.lang.Object</code>,
+ which is probably what was intended.</p>
+
+
+<h3><a name="NM_LCASE_TOSTRING">Nm: Class defines tostring(); should it be toString()? (NM_LCASE_TOSTRING)</a></h3>
+
+
+ <p> This class defines a method called <code>tostring()</code>. This method
+ does not override the <code>toString()</code> method in <code>java.lang.Object</code>,
+ which is probably what was intended.</p>
+
+
+<h3><a name="NM_METHOD_CONSTRUCTOR_CONFUSION">Nm: Apparent method/constructor confusion (NM_METHOD_CONSTRUCTOR_CONFUSION)</a></h3>
+
+
+ <p> This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor.
+ If it was intended to be a constructor, remove the declaration of a void return value.
+ If you had accidently defined this method, realized the mistake, defined a proper constructor
+ but can't get rid of this method due to backwards compatibility, deprecate the method.
+</p>
+
+
+<h3><a name="NM_VERY_CONFUSING">Nm: Very confusing method names (NM_VERY_CONFUSING)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other.
+</p>
+
+
+<h3><a name="NM_WRONG_PACKAGE">Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE)</a></h3>
+
+
+ <p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
+
+
+<h3><a name="QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT">QBA: Method assigns boolean literal in boolean expression (QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT)</a></h3>
+
+
+ <p>
+ This method assigns a literal boolean value (true or false) to a boolean variable inside
+ an if or while expression. Most probably this was supposed to be a boolean comparison using
+ ==, not an assignment using =.
+ </p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE">RCN: Nullcheck of value previously dereferenced (RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE)</a></h3>
+
+
+<p> A value is checked here to see whether it is null, but this value can't
+be null because it was previously dereferenced and if it were null a null pointer
+exception would have occurred at the earlier dereference.
+Essentially, this code and the previous dereference
+disagree as to whether this value is allowed to be null. Either the check is redundant
+or the previous dereference is erroneous.</p>
+
+
+<h3><a name="RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION">RE: Invalid syntax for regular expression (RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION)</a></h3>
+
+
+<p>
+The code here uses a regular expression that is invalid according to the syntax
+for regular expressions. This statement will throw a PatternSyntaxException when
+executed.
+</p>
+
+
+<h3><a name="RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION">RE: File.separator used for regular expression (RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION)</a></h3>
+
+
+<p>
+The code here uses <code>File.separator</code>
+where a regular expression is required. This will fail on Windows
+platforms, where the <code>File.separator</code> is a backslash, which is interpreted in a
+regular expression as an escape character. Amoung other options, you can just use
+<code>File.separatorChar=='\\' & "\\\\" : File.separator</code> instead of
+<code>File.separator</code>
+
+</p>
+
+
+<h3><a name="RE_POSSIBLE_UNINTENDED_PATTERN">RE: "." used for regular expression (RE_POSSIBLE_UNINTENDED_PATTERN)</a></h3>
+
+
+<p>
+A String function is being invoked and "." is being passed
+to a parameter that takes a regular expression as an argument. Is this what you intended?
+For example
+s.replaceAll(".", "/") will return a String in which <em>every</em>
+character has been replaced by a / character.
+</p>
+
+
+<h3><a name="RV_01_TO_INT">RV: Random value from 0 to 1 is coerced to the integer 0 (RV_01_TO_INT)</a></h3>
+
+
+ <p>A random value from 0 to 1 is being coerced to the integer value 0. You probably
+want to multiple the random value by something else before coercing it to an integer, or use the Random.nextInt(n) method.
+</p>
+
+
+<h3><a name="RV_ABSOLUTE_VALUE_OF_HASHCODE">RV: Bad attempt to compute absolute value of signed 32-bit hashcode (RV_ABSOLUTE_VALUE_OF_HASHCODE)</a></h3>
+
+
+<p> This code generates a hashcode and then computes
+the absolute value of that hashcode. If the hashcode
+is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
+
+
+<h3><a name="RV_ABSOLUTE_VALUE_OF_RANDOM_INT">RV: Bad attempt to compute absolute value of signed 32-bit random integer (RV_ABSOLUTE_VALUE_OF_RANDOM_INT)</a></h3>
+
+
+<p> This code generates a random signed integer and then computes
+the absolute value of that random integer. If the number returned by the random number
+generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
+
+
+<h3><a name="RV_DONT_JUST_NULL_CHECK_READLINE">RV: Method discards result of readLine after checking if it is nonnull (RV_DONT_JUST_NULL_CHECK_READLINE)</a></h3>
+
+
+ <p> The value returned by readLine is discarded after checking to see if the return
+value is non-null. In almost all situations, if the result is non-null, you will want
+to use that non-null value. Calling readLine again will give you a different line.</p>
+
+
+<h3><a name="RV_EXCEPTION_NOT_THROWN">RV: Exception created and dropped rather than thrown (RV_EXCEPTION_NOT_THROWN)</a></h3>
+
+
+ <p> This code creates an exception (or error) object, but doesn't do anything with it. For example,
+something like </p>
+<blockquote>
+<pre>
+if (x < 0)
+ new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
+<p>It was probably the intent of the programmer to throw the created exception:</p>
+<blockquote>
+<pre>
+if (x < 0)
+ throw new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
+
+
+<h3><a name="RV_RETURN_VALUE_IGNORED">RV: Method ignores return value (RV_RETURN_VALUE_IGNORED)</a></h3>
+
+
+ <p> The return value of this method should be checked. One common
+cause of this warning is to invoke a method on an immutable object,
+thinking that it updates the object. For example, in the following code
+fragment,</p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString.trim();
+</pre>
+</blockquote>
+<p>the programmer seems to be thinking that the trim() method will update
+the String referenced by dateString. But since Strings are immutable, the trim()
+function returns a new String value, which is being ignored here. The code
+should be corrected to: </p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString = dateString.trim();
+</pre>
+</blockquote>
+
+
+<h3><a name="SA_FIELD_DOUBLE_ASSIGNMENT">SA: Double assignment of field (SA_FIELD_DOUBLE_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a double assignment of a field; e.g.
+</p>
+<pre>
+ int x,y;
+ public void foo() {
+ x = x = 17;
+ }
+</pre>
+<p>Assigning to a field twice is useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_FIELD_SELF_ASSIGNMENT">SA: Self assignment of field (SA_FIELD_SELF_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a self assignment of a field; e.g.
+</p>
+<pre>
+ int x;
+ public void foo() {
+ x = x;
+ }
+</pre>
+<p>Such assignments are useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_FIELD_SELF_COMPARISON">SA: Self comparison of field with itself (SA_FIELD_SELF_COMPARISON)</a></h3>
+
+
+<p> This method compares a field with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
+
+
+<h3><a name="SA_FIELD_SELF_COMPUTATION">SA: Nonsensical self computation involving a field (e.g., x & x) (SA_FIELD_SELF_COMPUTATION)</a></h3>
+
+
+<p> This method performs a nonsensical computation of a field with another
+reference to the same field (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
+
+
+<h3><a name="SA_LOCAL_DOUBLE_ASSIGNMENT">SA: Double assignment of local variable (SA_LOCAL_DOUBLE_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a double assignment of a local variable; e.g.
+</p>
+<pre>
+ public void foo() {
+ int x,y;
+ x = x = 17;
+ }
+</pre>
+<p>Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_LOCAL_SELF_COMPARISON">SA: Self comparison of value with itself (SA_LOCAL_SELF_COMPARISON)</a></h3>
+
+
+<p> This method compares a local variable with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
+
+
+<h3><a name="SA_LOCAL_SELF_COMPUTATION">SA: Nonsensical self computation involving a variable (e.g., x & x) (SA_LOCAL_SELF_COMPUTATION)</a></h3>
+
+
+<p> This method performs a nonsensical computation of a local variable with another
+reference to the same variable (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
+
+
+<h3><a name="SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH">SF: Dead store due to switch statement fall through (SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH)</a></h3>
+
+
+ <p> A value stored in the previous switch case is overwritten here due to a switch fall through. It is likely that
+ you forgot to put a break or return at the end of the previous case.
+</p>
+
+
+<h3><a name="SIO_SUPERFLUOUS_INSTANCEOF">SIO: Unnecessary type check done using instanceof operator (SIO_SUPERFLUOUS_INSTANCEOF)</a></h3>
+
+
+<p> Type check performed using the instanceof operator where it can be statically determined whether the object
+is of the type requested. </p>
+
+
+<h3><a name="SQL_BAD_PREPARED_STATEMENT_ACCESS">SQL: Method attempts to access a prepared statement parameter with index 0 (SQL_BAD_PREPARED_STATEMENT_ACCESS)</a></h3>
+
+
+<p> A call to a setXXX method of a prepared statement was made where the
+parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>
+
+
+<h3><a name="SQL_BAD_RESULTSET_ACCESS">SQL: Method attempts to access a result set field with index 0 (SQL_BAD_RESULTSET_ACCESS)</a></h3>
+
+
+<p> A call to getXXX or updateXXX methods of a result set was made where the
+field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
+
+
+<h3><a name="STI_INTERRUPTED_ON_CURRENTTHREAD">STI: Unneeded use of currentThread() call, to call interrupted() (STI_INTERRUPTED_ON_CURRENTTHREAD)</a></h3>
+
+
+<p>
+This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a
+static method, is more simple and clear to use Thread.interrupted().
+</p>
+
+
+<h3><a name="STI_INTERRUPTED_ON_UNKNOWNTHREAD">STI: Static Thread.interrupted() method invoked on thread instance (STI_INTERRUPTED_ON_UNKNOWNTHREAD)</a></h3>
+
+
+<p>
+This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is
+not the current thread. As the interrupted() method is static, the interrupted method will be called on a different
+object than the one the author intended.
+</p>
+
+
+<h3><a name="TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED">TQ: Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required (TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED)</a></h3>
+
+
+ <p>
+ A value specified as carrying a type qualifier annotation is
+ consumed in a location or locations requiring that the value not
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=ALWAYS
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=NEVER.
+ </p>
+
+ <p>
+ For example, say that @NonNegative is a nickname for
+ the type qualifier annotation @Negative(when=When.NEVER).
+ The following code will generate this warning because
+ the return statement requires a @NonNegative value,
+ but receives one that is marked as @Negative.
+ </p>
+ <blockquote>
+<pre>
+public @NonNegative Integer example(@Negative Integer value) {
+ return value;
+}
+</pre>
+ </blockquote>
+
+
+<h3><a name="TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK">TQ: Value that might not carry a type qualifier reaches a use requiring that type qualifier (TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK)</a></h3>
+
+
+ <p>
+ A value that might not carry a type qualifier annotation
+ reaches a use which requires that annotation.
+ </p>
+
+ <p>
+ For example, consider the following method:
+ </p>
+ <blockquote>
+<pre>
+public @Untainted Object mustReturnUntainted(Object unknown) {
+ return unknown;
+}
+</pre>
+ </blockquote>
+ <p>
+ The <code>mustReturnUntainted</code> method is required to
+ return a value carrying the @Untainted annotation,
+ but a value not known to carry that annotation is returned.
+ </p>
+
+
+<h3><a name="TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK">TQ: Unknown value reaches a use which forbids values carrying type qualifier annotation (TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK)</a></h3>
+
+
+ <p>
+ A value which might carry a type qualifier annotation reaches
+ a use which forbids values carrying that annotation.
+ </p>
+
+ <p>
+ TODO: example.
+ </p>
+
+
+<h3><a name="TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED">TQ: Value annotated as never carrying a type qualifier used where value carrying that qualifier is required (TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED)</a></h3>
+
+
+ <p>
+ A value specified as not carrying a type qualifier annotation is guaranteed
+ to be consumed in a location or locations requiring that the value does
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=NEVER
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=ALWAYS.
+ </p>
+
+ <p>
+ TODO: example
+ </p>
+
+
+<h3><a name="UCF_USELESS_CONTROL_FLOW_NEXT_LINE">UCF: Useless control flow to next line (UCF_USELESS_CONTROL_FLOW_NEXT_LINE)</a></h3>
+
+
+<p> This method contains a useless control flow statement in which control
+flow follows to the same or following line regardless of whether or not
+the branch is taken.
+Often, this is caused by inadvertently using an empty statement as the
+body of an <code>if</code> statement, e.g.:</p>
+<pre>
+ if (argv.length == 1);
+ System.out.println("Hello, " + argv[0]);
+</pre>
+
+
+<h3><a name="UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS">UMAC: Uncallable method defined in anonymous class (UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS)</a></h3>
+
+
+<p> This anonymous class defined a method that is not directly invoked and does not override
+a method in a superclass. Since methods in other classes cannot directly invoke methods
+declared in an anonymous class, it seems that this method is uncallable. The method
+might simply be dead code, but it is also possible that the method is intended to
+override a method declared in a superclass, and due to an typo or other error the method does not,
+in fact, override the method it is intended to.
+</p>
+
+
+<h3><a name="UR_UNINIT_READ">UR: Uninitialized read of field in constructor (UR_UNINIT_READ)</a></h3>
+
+
+ <p> This constructor reads a field which has not yet been assigned a value.
+ This is often caused when the programmer mistakenly uses the field instead
+ of one of the constructor's parameters.</p>
+
+
+<h3><a name="UWF_NULL_FIELD">UwF: Field only ever set to null (UWF_NULL_FIELD)</a></h3>
+
+
+ <p> All writes to this field are of the constant value null, and thus
+all reads of the field will return null.
+Check for errors, or remove it if it is useless.</p>
+
+
+<h3><a name="UWF_UNWRITTEN_FIELD">UwF: Unwritten field (UWF_UNWRITTEN_FIELD)</a></h3>
+
+
+ <p> This field is never written. All reads of it will return the default
+value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>
+
+
+<h3><a name="VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG">VA: Primitive array passed to function expecting a variable number of object arguments (VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG)</a></h3>
+
+
+<p>
+This code passes a primitive array to a function that takes a variable number of object arguments.
+This creates an array of length one to hold the primitive array and passes it to the function.
+</p>
+
+
+<h3><a name="DM_CONVERT_CASE">Dm: Consider using Locale parameterized version of invoked method (DM_CONVERT_CASE)</a></h3>
+
+
+ <p> A String is being converted to upper or lowercase, using the platform's default encoding. This may
+ result in improper conversions when used with international characters. Use the </p>
+ <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table>
+ <p>versions instead.</p>
+
+
+<h3><a name="EI_EXPOSE_REP">EI: May expose internal representation by returning reference to mutable object (EI_EXPOSE_REP)</a></h3>
+
+
+ <p> Returning a reference to a mutable object value stored in one of the object's fields
+ exposes the internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Returning a new copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="EI_EXPOSE_REP2">EI2: May expose internal representation by incorporating reference to mutable object (EI_EXPOSE_REP2)</a></h3>
+
+
+ <p> This code stores a reference to an externally mutable object into the
+ internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="FI_PUBLIC_SHOULD_BE_PROTECTED">FI: Finalizer should be protected, not public (FI_PUBLIC_SHOULD_BE_PROTECTED)</a></h3>
+
+
+ <p> A class's <code>finalize()</code> method should have protected access,
+ not public.</p>
+
+
+<h3><a name="EI_EXPOSE_STATIC_REP2">MS: May expose internal static state by storing a mutable object into a static field (EI_EXPOSE_STATIC_REP2)</a></h3>
+
+
+ <p> This code stores a reference to an externally mutable object into a static
+ field.
+ If unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="MS_CANNOT_BE_FINAL">MS: Field isn't final and can't be protected from malicious code (MS_CANNOT_BE_FINAL)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ Unfortunately, the way the field is used doesn't allow
+ any easy fix to this problem.</p>
+
+
+<h3><a name="MS_EXPOSE_REP">MS: Public static method may expose internal representation by returning array (MS_EXPOSE_REP)</a></h3>
+
+
+ <p> A public static method returns a reference to
+ an array that is part of the static state of the class.
+ Any code that calls this method can freely modify
+ the underlying array.
+ One fix is to return a copy of the array.</p>
+
+
+<h3><a name="MS_FINAL_PKGPROTECT">MS: Field should be both final and package protected (MS_FINAL_PKGPROTECT)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made package protected and/or made final
+ to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_MUTABLE_ARRAY">MS: Field is a mutable array (MS_MUTABLE_ARRAY)</a></h3>
+
+
+<p> A final static field references an array
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the array.</p>
+
+
+<h3><a name="MS_MUTABLE_HASHTABLE">MS: Field is a mutable Hashtable (MS_MUTABLE_HASHTABLE)</a></h3>
+
+
+ <p>A final static field references a Hashtable
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the Hashtable.</p>
+
+
+<h3><a name="MS_OOI_PKGPROTECT">MS: Field should be moved out of an interface and made package protected (MS_OOI_PKGPROTECT)</a></h3>
+
+
+<p>
+ A final static field that is
+defined in an interface references a mutable
+ object such as an array or hashtable.
+ This mutable object could
+ be changed by malicious code or
+ by accident from another package.
+ To solve this, the field needs to be moved to a class
+ and made package protected
+ to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_PKGPROTECT">MS: Field should be package protected (MS_PKGPROTECT)</a></h3>
+
+
+ <p> A mutable static field could be changed by malicious code or
+ by accident.
+ The field could be made package protected to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_SHOULD_BE_FINAL">MS: Field isn't final but should be (MS_SHOULD_BE_FINAL)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made final to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="DC_DOUBLECHECK">DC: Possible double check of field (DC_DOUBLECHECK)</a></h3>
+
+
+ <p> This method may contain an instance of double-checked locking.
+ This idiom is not correct according to the semantics of the Java memory
+ model. For more information, see the web page
+ <a href="http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html"
+ >http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html</a>.</p>
+
+
+<h3><a name="DL_SYNCHRONIZATION_ON_SHARED_CONSTANT">DL: Synchronization on shared constant could lead to deadlock (DL_SYNCHRONIZATION_ON_SHARED_CONSTANT)</a></h3>
+
+
+ <p> The code synchronizes on a shared primative constant, such as an interned String.
+<pre>
+private static String LOCK = "LOCK";
+...
+ synchronized(LOCK) { ...}
+...
+</pre>
+</p>
+<p>Such constants an interned and shared across all other classes loaded by the JVM. Thus, this could
+is locking on something that other code might also be locking. This could result in very strange and hard to diagnose
+blocking and deadlock behavior. See <a href="http://www.javalobby.org/java/forums/t96352.html">http://www.javalobby.org/java/forums/t96352.html</a> and <a href="http://jira.codehaus.org/browse/JETTY-352">http://jira.codehaus.org/browse/JETTY-352</a>.
+</p>
+
+
+<h3><a name="DM_MONITOR_WAIT_ON_CONDITION">Dm: Monitor wait() called on Condition (DM_MONITOR_WAIT_ON_CONDITION)</a></h3>
+
+
+ <p>
+ This method calls <code>wait()</code> on a
+ <code>java.util.concurrent.locks.Condition</code> object.
+ Waiting for a <code>Condition</code> should be done using one of the <code>await()</code>
+ methods defined by the <code>Condition</code> interface.
+ </p>
+
+
+<h3><a name="DM_USELESS_THREAD">Dm: A thread was created using the default empty run method (DM_USELESS_THREAD)</a></h3>
+
+
+ <p>This method creates a thread without specifying a run method either by deriving from the Thread class, or
+ by passing a Runnable object. This thread, then, does nothing but waste time.
+</p>
+
+
+<h3><a name="ESync_EMPTY_SYNC">ESync: Empty synchronized block (ESync_EMPTY_SYNC)</a></h3>
+
+
+ <p> The code contains an empty synchronized block:</p>
+<pre>
+synchronized() {}
+</pre>
+<p>Empty synchronized blocks are far more subtle and hard to use correctly
+than most people recognize, and empty synchronized blocks
+are almost never a better solution
+than less contrived solutions.
+</p>
+
+
+<h3><a name="IS2_INCONSISTENT_SYNC">IS: Inconsistent synchronization (IS2_INCONSISTENT_SYNC)</a></h3>
+
+
+ <p> The fields of this class appear to be accessed inconsistently with respect
+ to synchronization. This bug report indicates that the bug pattern detector
+ judged that
+ </p>
+ <ol>
+ <li> The class contains a mix of locked and unlocked accesses,</li>
+ <li> At least one locked access was performed by one of the class's own methods, and</li>
+ <li> The number of unsynchronized field accesses (reads and writes) was no more than
+ one third of all accesses, with writes being weighed twice as high as reads</li>
+ </ol>
+
+ <p> A typical bug matching this bug pattern is forgetting to synchronize
+ one of the methods in a class that is intended to be thread-safe.</p>
+
+ <p> You can select the nodes labeled "Unsynchronized access" to show the
+ code locations where the detector believed that a field was accessed
+ without synchronization.</p>
+
+ <p> Note that there are various sources of inaccuracy in this detector;
+ for example, the detector cannot statically detect all situations in which
+ a lock is held. Also, even when the detector is accurate in
+ distinguishing locked vs. unlocked accesses, the code in question may still
+ be correct.</p>
+
+ <p> This description refers to the "IS2" version of the pattern detector,
+ which has more accurate ways of detecting locked vs. unlocked accesses
+ than the older "IS" detector.</p>
+
+
+<h3><a name="IS_FIELD_NOT_GUARDED">IS: Field not guarded against concurrent access (IS_FIELD_NOT_GUARDED)</a></h3>
+
+
+ <p> This field is annotated with net.jcip.annotations.GuardedBy,
+but can be accessed in a way that seems to violate the annotation.</p>
+
+
+<h3><a name="JLM_JSR166_LOCK_MONITORENTER">JLM: Synchronization performed on java.util.concurrent Lock (JLM_JSR166_LOCK_MONITORENTER)</a></h3>
+
+
+<p> This method performs synchronization on an implementation of
+<code>java.util.concurrent.locks.Lock</code>. You should use
+the <code>lock()</code> and <code>unlock()</code> methods instead.
+</p>
+
+
+<h3><a name="LI_LAZY_INIT_STATIC">LI: Incorrect lazy initialization of static field (LI_LAZY_INIT_STATIC)</a></h3>
+
+
+<p> This method contains an unsynchronized lazy initialization of a non-volatile static field.
+Because the compiler or processor may reorder instructions,
+threads are not guaranteed to see a completely initialized object,
+<em>if the method can be called by multiple threads</em>.
+You can make the field volatile to correct the problem.
+For more information, see the
+<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
+</p>
+
+
+<h3><a name="LI_LAZY_INIT_UPDATE_STATIC">LI: Incorrect lazy initialization and update of static field (LI_LAZY_INIT_UPDATE_STATIC)</a></h3>
+
+
+<p> This method contains an unsynchronized lazy initialization of a static field.
+After the field is set, the object stored into that location is further accessed.
+The setting of the field is visible to other threads as soon as it is set. If the
+futher accesses in the method that set the field serve to initialize the object, then
+you have a <em>very serious</em> multithreading bug, unless something else prevents
+any other thread from accessing the stored object until it is fully initialized.
+</p>
+
+
+<h3><a name="ML_SYNC_ON_UPDATED_FIELD">ML: Method synchronizes on an updated field (ML_SYNC_ON_UPDATED_FIELD)</a></h3>
+
+
+ <p> This method synchronizes on an object
+ references from a mutable field.
+ This is unlikely to have useful semantics, since different
+threads may be synchronizing on different objects.</p>
+
+
+<h3><a name="MWN_MISMATCHED_NOTIFY">MWN: Mismatched notify() (MWN_MISMATCHED_NOTIFY)</a></h3>
+
+
+<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock
+on the object. Calling notify() or notifyAll() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
+
+
+<h3><a name="MWN_MISMATCHED_WAIT">MWN: Mismatched wait() (MWN_MISMATCHED_WAIT)</a></h3>
+
+
+<p> This method calls Object.wait() without obviously holding a lock
+on the object. Calling wait() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
+
+
+<h3><a name="NN_NAKED_NOTIFY">NN: Naked notify (NN_NAKED_NOTIFY)</a></h3>
+
+
+ <p> A call to <code>notify()</code> or <code>notifyAll()</code>
+ was made without any (apparent) accompanying
+ modification to mutable object state. In general, calling a notify
+ method on a monitor is done because some condition another thread is
+ waiting for has become true. However, for the condition to be meaningful,
+ it must involve a heap object that is visible to both threads.</p>
+
+ <p> This bug does not necessarily indicate an error, since the change to
+ mutable object state may have taken place in a method which then called
+ the method containing the notification.</p>
+
+
+<h3><a name="NP_SYNC_AND_NULL_CHECK_FIELD">NP: Synchronize and null check on the same field. (NP_SYNC_AND_NULL_CHECK_FIELD)</a></h3>
+
+
+<p>Since field is synchronized on, it seems not likely to be null.
+If it is null and then synchronized on a NullPointerException will be
+thrown and the check would be pointless. Better to synchronize on
+another field.</p>
+
+
+
+<h3><a name="NO_NOTIFY_NOT_NOTIFYALL">No: Using notify() rather than notifyAll() (NO_NOTIFY_NOT_NOTIFYALL)</a></h3>
+
+
+ <p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>.
+ Java monitors are often used for multiple conditions. Calling <code>notify()</code>
+ only wakes up one thread, meaning that the thread woken up might not be the
+ one waiting for the condition that the caller just satisfied.</p>
+
+
+<h3><a name="RS_READOBJECT_SYNC">RS: Class's readObject() method is synchronized (RS_READOBJECT_SYNC)</a></h3>
+
+
+ <p> This serializable class defines a <code>readObject()</code> which is
+ synchronized. By definition, an object created by deserialization
+ is only reachable by one thread, and thus there is no need for
+ <code>readObject()</code> to be synchronized. If the <code>readObject()</code>
+ method itself is causing the object to become visible to another thread,
+ that is an example of very dubious coding style.</p>
+
+
+<h3><a name="RU_INVOKE_RUN">Ru: Invokes run on a thread (did you mean to start it instead?) (RU_INVOKE_RUN)</a></h3>
+
+
+ <p> This method explicitly invokes <code>run()</code> on an object.
+ In general, classes implement the <code>Runnable</code> interface because
+ they are going to have their <code>run()</code> method invoked in a new thread,
+ in which case <code>Thread.start()</code> is the right method to call.</p>
+
+
+<h3><a name="SC_START_IN_CTOR">SC: Constructor invokes Thread.start() (SC_START_IN_CTOR)</a></h3>
+
+
+ <p> The constructor starts a thread. This is likely to be wrong if
+ the class is ever extended/subclassed, since the thread will be started
+ before the subclass constructor is started.</p>
+
+
+<h3><a name="SP_SPIN_ON_FIELD">SP: Method spins on field (SP_SPIN_ON_FIELD)</a></h3>
+
+
+ <p> This method spins in a loop which reads a field. The compiler
+ may legally hoist the read out of the loop, turning the code into an
+ infinite loop. The class should be changed so it uses proper
+ synchronization (including wait and notify calls).</p>
+
+
+<h3><a name="STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE">STCAL: Call to static Calendar (STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE)</a></h3>
+
+
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+The detector has found a call to an instance of Calendar that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE">STCAL: Call to static DateFormat (STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE)</a></h3>
+
+
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+The detector has found a call to an instance of DateFormat that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_STATIC_CALENDAR_INSTANCE">STCAL: Static Calendar (STCAL_STATIC_CALENDAR_INSTANCE)</a></h3>
+
+
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see
+random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE">STCAL: Static DateFormat (STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE)</a></h3>
+
+
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application.</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="SWL_SLEEP_WITH_LOCK_HELD">SWL: Method calls Thread.sleep() with a lock held (SWL_SLEEP_WITH_LOCK_HELD)</a></h3>
+
+
+ <p>
+ This method calls Thread.sleep() with a lock held. This may result
+ in very poor performance and scalability, or a deadlock, since other threads may
+ be waiting to acquire the lock. It is a much better idea to call
+ wait() on the lock, which releases the lock and allows other threads
+ to run.
+ </p>
+
+
+<h3><a name="TLW_TWO_LOCK_WAIT">TLW: Wait with two locks held (TLW_TWO_LOCK_WAIT)</a></h3>
+
+
+ <p> Waiting on a monitor while two locks are held may cause
+ deadlock.
+
+ Performing a wait only releases the lock on the object
+ being waited on, not any other locks.
+
+This not necessarily a bug, but is worth examining
+ closely.</p>
+
+
+<h3><a name="UG_SYNC_SET_UNSYNC_GET">UG: Unsynchronized get method, synchronized set method (UG_SYNC_SET_UNSYNC_GET)</a></h3>
+
+
+ <p> This class contains similarly-named get and set
+ methods where the set method is synchronized and the get method is not.
+ This may result in incorrect behavior at runtime, as callers of the get
+ method will not necessarily see a consistent state for the object.
+ The get method should be made synchronized.</p>
+
+
+<h3><a name="UL_UNRELEASED_LOCK">UL: Method does not release lock on all paths (UL_UNRELEASED_LOCK)</a></h3>
+
+
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
+
+
+<h3><a name="UL_UNRELEASED_LOCK_EXCEPTION_PATH">UL: Method does not release lock on all exception paths (UL_UNRELEASED_LOCK_EXCEPTION_PATH)</a></h3>
+
+
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all exception paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
+
+
+<h3><a name="UW_UNCOND_WAIT">UW: Unconditional wait (UW_UNCOND_WAIT)</a></h3>
+
+
+ <p> This method contains a call to <code>java.lang.Object.wait()</code> which
+ is not guarded by conditional control flow. The code should
+ verify that condition it intends to wait for is not already satisfied
+ before calling wait; any previous notifications will be ignored.
+ </p>
+
+
+<h3><a name="VO_VOLATILE_REFERENCE_TO_ARRAY">VO: A volatile reference to an array doesn't treat the array elements as volatile (VO_VOLATILE_REFERENCE_TO_ARRAY)</a></h3>
+
+
+<p>This declares a volatile reference to an array, which might not be what
+you want. With a volatile reference to an array, reads and writes of
+the reference to the array are treated as volatile, but the array elements
+are non-volatile. To get volatile array elements, you will need to use
+one of the atomic array classes in java.util.concurrent (provided
+in Java 5.0).</p>
+
+
+<h3><a name="WS_WRITEOBJECT_SYNC">WS: Class's writeObject() method is synchronized but nothing else is (WS_WRITEOBJECT_SYNC)</a></h3>
+
+
+ <p> This class has a <code>writeObject()</code> method which is synchronized;
+ however, no other method of the class is synchronized.</p>
+
+
+<h3><a name="WA_AWAIT_NOT_IN_LOOP">Wa: Condition.await() not in loop (WA_AWAIT_NOT_IN_LOOP)</a></h3>
+
+
+ <p> This method contains a call to <code>java.util.concurrent.await()</code>
+ (or variants)
+ which is not in a loop. If the object is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
+
+
+<h3><a name="WA_NOT_IN_LOOP">Wa: Wait not in loop (WA_NOT_IN_LOOP)</a></h3>
+
+
+ <p> This method contains a call to <code>java.lang.Object.wait()</code>
+ which is not in a loop. If the monitor is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
+
+
+<h3><a name="BX_BOXING_IMMEDIATELY_UNBOXED">Bx: Primitive value is boxed and then immediately unboxed (BX_BOXING_IMMEDIATELY_UNBOXED)</a></h3>
+
+
+ <p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual
+ boxing in a place where an unboxed value is required, thus forcing the compiler
+to immediately undue the work of the boxing.
+</p>
+
+
+<h3><a name="BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION">Bx: Primitive value is boxed then unboxed to perform primative coercion (BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION)</a></h3>
+
+
+ <p>A primitive boxed value constructed and then immediately converted into a different primitive type
+(e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>
+
+
+<h3><a name="DM_BOXED_PRIMITIVE_TOSTRING">Bx: Method allocates a boxed primitive just to call toString (DM_BOXED_PRIMITIVE_TOSTRING)</a></h3>
+
+
+ <p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static
+ form of toString which takes the primitive value. So,</p>
+ <table>
+ <tr><th>Replace...</th><th>With this...</th></tr>
+ <tr><td>new Integer(1).toString()</td><td>Integer.toString(1)</td></tr>
+ <tr><td>new Long(1).toString()</td><td>Long.toString(1)</td></tr>
+ <tr><td>new Float(1.0).toString()</td><td>Float.toString(1.0)</td></tr>
+ <tr><td>new Double(1.0).toString()</td><td>Double.toString(1.0)</td></tr>
+ <tr><td>new Byte(1).toString()</td><td>Byte.toString(1)</td></tr>
+ <tr><td>new Short(1).toString()</td><td>Short.toString(1)</td></tr>
+ <tr><td>new Boolean(true).toString()</td><td>Boolean.toString(true)</td></tr>
+ </table>
+
+
+<h3><a name="DM_FP_NUMBER_CTOR">Bx: Method invokes inefficient floating-point Number constructor; use static valueOf instead (DM_FP_NUMBER_CTOR)</a></h3>
+
+
+ <p>
+ Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas
+ <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of <code>Double</code> and <code>Float</code>.
+ </p>
+
+
+<h3><a name="DM_NUMBER_CTOR">Bx: Method invokes inefficient Number constructor; use static valueOf instead (DM_NUMBER_CTOR)</a></h3>
+
+
+ <p>
+ Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas
+ <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Values between -128 and 127 are guaranteed to have corresponding cached instances
+ and using <code>valueOf</code> is approximately 3.5 times faster than using constructor.
+ For values outside the constant range the performance of both styles is the same.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of
+ <code>Long</code>, <code>Integer</code>, <code>Short</code>, <code>Character</code>, and <code>Byte</code>.
+ </p>
+
+
+<h3><a name="DMI_BLOCKING_METHODS_ON_URL">Dm: The equals and hashCode methods of URL are blocking (DMI_BLOCKING_METHODS_ON_URL)</a></h3>
+
+
+ <p> The equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
+
+
+<h3><a name="DMI_COLLECTION_OF_URLS">Dm: Maps and sets of URLs can be performance hogs (DMI_COLLECTION_OF_URLS)</a></h3>
+
+
+ <p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
+
+
+<h3><a name="DM_BOOLEAN_CTOR">Dm: Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead (DM_BOOLEAN_CTOR)</a></h3>
+
+
+ <p> Creating new instances of <code>java.lang.Boolean</code> wastes
+ memory, since <code>Boolean</code> objects are immutable and there are
+ only two useful values of this type. Use the <code>Boolean.valueOf()</code>
+ method (or Java 1.5 autoboxing) to create <code>Boolean</code> objects instead.</p>
+
+
+<h3><a name="DM_GC">Dm: Explicit garbage collection; extremely dubious except in benchmarking code (DM_GC)</a></h3>
+
+
+ <p> Code explicitly invokes garbage collection.
+ Except for specific use in benchmarking, this is very dubious.</p>
+ <p>In the past, situations where people have explicitly invoked
+ the garbage collector in routines such as close or finalize methods
+ has led to huge performance black holes. Garbage collection
+ can be expensive. Any situation that forces hundreds or thousands
+ of garbage collections will bring the machine to a crawl.</p>
+
+
+<h3><a name="DM_NEW_FOR_GETCLASS">Dm: Method allocates an object, only to get the class object (DM_NEW_FOR_GETCLASS)</a></h3>
+
+
+ <p>This method allocates an object just to call getClass() on it, in order to
+ retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>
+
+
+<h3><a name="DM_NEXTINT_VIA_NEXTDOUBLE">Dm: Use the nextInt method of Random rather than nextDouble to generate a random integer (DM_NEXTINT_VIA_NEXTDOUBLE)</a></h3>
+
+
+ <p>If r is a java.util.Random, you can generate a random number from 0 to n-1
+using r.nextInt(n) Rather than using (int)(r.nextDouble() * n).
+</p>
+
+
+<h3><a name="DM_STRING_CTOR">Dm: Method invokes inefficient new String(String) constructor (DM_STRING_CTOR)</a></h3>
+
+
+ <p> Using the <code>java.lang.String(String)</code> constructor wastes memory
+ because the object so constructed will be functionally indistinguishable
+ from the <code>String</code> passed as a parameter. Just use the
+ argument <code>String</code> directly.</p>
+
+
+<h3><a name="DM_STRING_EMPTY_EQUALS">Dm: Method invokes inefficient String.equals(""); use String.length() == 0 instead (DM_STRING_EMPTY_EQUALS)</a></h3>
+
+
+ <p> An object is compared to the empty String object using the equals() method here.
+ Checking that the String object's length is zero may be faster, and removes String constants from the class file.</p>
+
+
+<h3><a name="DM_STRING_TOSTRING">Dm: Method invokes toString() method on a String (DM_STRING_TOSTRING)</a></h3>
+
+
+ <p> Calling <code>String.toString()</code> is just a redundant operation.
+ Just use the String.</p>
+
+
+<h3><a name="DM_STRING_VOID_CTOR">Dm: Method invokes inefficient new String() constructor (DM_STRING_VOID_CTOR)</a></h3>
+
+
+ <p> Creating a new <code>java.lang.String</code> object using the
+ no-argument constructor wastes memory because the object so created will
+ be functionally indistinguishable from the empty string constant
+ <code>""</code>. Java guarantees that identical string constants
+ will be represented by the same <code>String</code> object. Therefore,
+ you should just use the empty string constant directly.</p>
+
+
+<h3><a name="HSC_HUGE_SHARED_STRING_CONSTANT">HSC: Huge string constants is duplicated across multiple class files (HSC_HUGE_SHARED_STRING_CONSTANT)</a></h3>
+
+
+ <p>
+ A large String constant is duplicated across multiple class files.
+ This is likely because a final field is initialized to a String constant, and the Java language
+ mandates that all references to a final field from other classes be inlined into
+that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6447475">JDK bug 6447475</a>
+ for a description of an occurrence of this bug in the JDK and how resolving it reduced
+ the size of the JDK by 1 megabyte.
+</p>
+
+
+<h3><a name="ITA_INEFFICIENT_TO_ARRAY">ITA: Method uses toArray() with zero-length array argument (ITA_INEFFICIENT_TO_ARRAY)</a></h3>
+
+
+<p> This method uses the toArray() method of a collection derived class, and passes
+in a zero-length prototype array argument. It is more efficient to use
+<code>myCollection.toArray(new Foo[myCollection.size()])</code>
+If the array passed in is big enough to store all of the
+elements of the collection, then it is populated and returned
+directly. This avoids the need to create a second array
+(by reflection) to return as the result.</p>
+
+
+<h3><a name="SBSC_USE_STRINGBUFFER_CONCATENATION">SBSC: Method concatenates strings using + in a loop (SBSC_USE_STRINGBUFFER_CONCATENATION)</a></h3>
+
+
+<p> The method seems to be building a String using concatenation in a loop.
+In each iteration, the String is converted to a StringBuffer/StringBuilder,
+ appended to, and converted back to a String.
+ This can lead to a cost quadratic in the number of iterations,
+ as the growing string is recopied in each iteration. </p>
+
+<p>Better performance can be obtained by using
+a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p>
+
+<p> For example:</p>
+<pre>
+ // This is bad
+ String s = "";
+ for (int i = 0; i < field.length; ++i) {
+ s = s + field[i];
+ }
+
+ // This is better
+ StringBuffer buf = new StringBuffer();
+ for (int i = 0; i < field.length; ++i) {
+ buf.append(field[i]);
+ }
+ String s = buf.toString();
+</pre>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC">SIC: Should be a static inner class (SIC_INNER_SHOULD_BE_STATIC)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made static.
+</p>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC_ANON">SIC: Could be refactored into a named static inner class (SIC_INNER_SHOULD_BE_STATIC_ANON)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since anonymous inner
+classes cannot be marked as static, doing this will requiring refactoring
+the inner class so that it is a named inner class.</p>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS">SIC: Could be refactored into a static inner class (SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it except during construction of the
+inner object. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since the reference to the
+ outer object is required during construction of the inner instance,
+ the inner class will need to be refactored so as to
+ pass a reference to the outer instance to the constructor
+ for the inner class.</p>
+
+
+<h3><a name="SS_SHOULD_BE_STATIC">SS: Unread field: should this field be static? (SS_SHOULD_BE_STATIC)</a></h3>
+
+
+ <p> This class contains an instance final field that
+ is initialized to a compile-time static value.
+ Consider making the field static.</p>
+
+
+<h3><a name="UM_UNNECESSARY_MATH">UM: Method calls static Math class method on a constant value (UM_UNNECESSARY_MATH)</a></h3>
+
+
+<p> This method uses a static method from java.lang.Math on a constant value. This method's
+result in this case, can be determined statically, and is faster and sometimes more accurate to
+just use the constant. Methods detected are:
+</p>
+<table>
+<tr>
+ <th>Method</th> <th>Parameter</th>
+</tr>
+<tr>
+ <td>abs</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>acos</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>asin</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan2</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cbrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>ceil</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>cos</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cosh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>exp</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>expm1</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>floor</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>log</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>log10</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>rint</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>round</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>sin</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sinh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sqrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>tan</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>tanh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>toDegrees</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>toRadians</td> <td>0.0</td>
+</tr>
+</table>
+
+
+<h3><a name="UPM_UNCALLED_PRIVATE_METHOD">UPM: Private method is never called (UPM_UNCALLED_PRIVATE_METHOD)</a></h3>
+
+
+<p> This private method is never called. Although it is
+possible that the method will be invoked through reflection,
+it is more likely that the method is never used, and should be
+removed.
+</p>
+
+
+<h3><a name="URF_UNREAD_FIELD">UrF: Unread field (URF_UNREAD_FIELD)</a></h3>
+
+
+ <p> This field is never read. Consider removing it from the class.</p>
+
+
+<h3><a name="UUF_UNUSED_FIELD">UuF: Unused field (UUF_UNUSED_FIELD)</a></h3>
+
+
+ <p> This field is never used. Consider removing it from the class.</p>
+
+
+<h3><a name="WMI_WRONG_MAP_ITERATOR">WMI: Inefficient use of keySet iterator instead of entrySet iterator (WMI_WRONG_MAP_ITERATOR)</a></h3>
+
+
+<p> This method accesses the value of a Map entry, using a key that was retrieved from
+a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the
+Map.get(key) lookup.</p>
+
+
+<h3><a name="BC_BAD_CAST_TO_ABSTRACT_COLLECTION">BC: Questionable cast to abstract collection (BC_BAD_CAST_TO_ABSTRACT_COLLECTION)</a></h3>
+
+
+<p>
+This code casts a Collection to an abstract collection
+(such as <code>List</code>, <code>Set</code>, or <code>Map</code>).
+Ensure that you are guaranteed that the object is of the type
+you are casting to. If all you need is to be able
+to iterate through a collection, you don't need to cast it to a Set or List.
+</p>
+
+
+<h3><a name="BC_BAD_CAST_TO_CONCRETE_COLLECTION">BC: Questionable cast to concrete collection (BC_BAD_CAST_TO_CONCRETE_COLLECTION)</a></h3>
+
+
+<p>
+This code casts an abstract collection (such as a Collection, List, or Set)
+to a specific concrete implementation (such as an ArrayList or HashSet).
+This might not be correct, and it may make your code fragile, since
+it makes it harder to switch to other concrete implementations at a future
+point. Unless you have a particular reason to do so, just use the abstract
+collection class.
+</p>
+
+
+<h3><a name="BC_UNCONFIRMED_CAST">BC: Unchecked/unconfirmed cast (BC_UNCONFIRMED_CAST)</a></h3>
+
+
+<p>
+This cast is unchecked, and not all instances of the type casted from can be cast to
+the type it is being cast to. Ensure that your program logic ensures that this
+cast will not fail.
+</p>
+
+
+<h3><a name="BC_VACUOUS_INSTANCEOF">BC: instanceof will always return true (BC_VACUOUS_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return true. Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="CI_CONFUSED_INHERITANCE">CI: Class is final but declares protected field (CI_CONFUSED_INHERITANCE)</a></h3>
+
+
+ <p>
+ This class is declared to be final, but declares fields to be protected. Since the class
+ is final, it can not be derived from, and the use of protected is confusing. The access
+ modifier for the field should be changed to private or public to represent the true
+ use for the field.
+ </p>
+
+
+<h3><a name="DB_DUPLICATE_BRANCHES">DB: Method uses the same code for two branches (DB_DUPLICATE_BRANCHES)</a></h3>
+
+
+ <p>
+ This method uses the same code to implement two branches of a conditional branch.
+ Check to ensure that this isn't a coding mistake.
+ </p>
+
+
+<h3><a name="DB_DUPLICATE_SWITCH_CLAUSES">DB: Method uses the same code for two switch clauses (DB_DUPLICATE_SWITCH_CLAUSES)</a></h3>
+
+
+ <p>
+ This method uses the same code to implement two clauses of a switch statement.
+ This could be a case of duplicate code, but it might also indicate
+ a coding mistake.
+ </p>
+
+
+<h3><a name="DLS_DEAD_LOCAL_STORE">DLS: Dead store to local variable (DLS_DEAD_LOCAL_STORE)</a></h3>
+
+
+<p>
+This instruction assigns a value to a local variable,
+but the value is not read by any subsequent instruction.
+Often, this indicates an error, because the value computed
+is never used.
+</p>
+<p>
+Note that Sun's javac compiler often generates dead stores for
+final local variables. Because FindBugs is a bytecode-based tool,
+there is no easy way to eliminate these false positives.
+</p>
+
+
+<h3><a name="DLS_DEAD_LOCAL_STORE_OF_NULL">DLS: Dead store of null to local variable (DLS_DEAD_LOCAL_STORE_OF_NULL)</a></h3>
+
+
+<p>The code stores null into a local variable, and stored value is not
+read. This store may have been introduced in assist the garbage collector, but
+as of Java SE 6.0, this is no longer needed or useful.
+</p>
+
+
+<h3><a name="DMI_HARDCODED_ABSOLUTE_FILENAME">DMI: Code contains a hard coded reference to an absolute pathname (DMI_HARDCODED_ABSOLUTE_FILENAME)</a></h3>
+
+
+<p>This code constructs a File object using a hard coded to an absolute pathname
+(e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code>
+</p>
+
+
+<h3><a name="DMI_NONSERIALIZABLE_OBJECT_WRITTEN">DMI: Non serializable object written to ObjectOutput (DMI_NONSERIALIZABLE_OBJECT_WRITTEN)</a></h3>
+
+
+<p>
+This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method.
+If the object is, indeed, non-serializable, an error will result.
+</p>
+
+
+<h3><a name="DMI_USELESS_SUBSTRING">DMI: Invocation of substring(0), which returns the original value (DMI_USELESS_SUBSTRING)</a></h3>
+
+
+<p>
+This code invokes substring(0) on a String, which returns the original value.
+</p>
+
+
+<h3><a name="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED">Dm: Thread passed where Runnable expected (DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED)</a></h3>
+
+
+ <p> A Thread object is passed as a parameter to a method where
+a Runnable is expected. This is rather unusual, and may indicate a logic error
+or cause unexpected behavior.
+ </p>
+
+
+<h3><a name="EQ_DOESNT_OVERRIDE_EQUALS">Eq: Class doesn't override equals in superclass (EQ_DOESNT_OVERRIDE_EQUALS)</a></h3>
+
+
+ <p> This class extends a class that defines an equals method and adds fields, but doesn't
+define an equals method itself. Thus, equality on instances of this class will
+ignore the identity of the subclass and the added fields. Be sure this is what is intended,
+and that you don't need to override the equals method. Even if you don't need to override
+the equals method, consider overriding it anyone to document the fact
+that the equals method for the subclass just return the result of
+invoking super.equals(o).
+
+
+<h3><a name="FE_FLOATING_POINT_EQUALITY">FE: Test for floating point equality (FE_FLOATING_POINT_EQUALITY)</a></h3>
+
+
+ <p>
+ This operation compares two floating point values for equality.
+ Because floating point calculations may involve rounding,
+ calculated float and double values may not be accurate.
+ For values that must be precise, such as monetary values,
+ consider using a fixed-precision type such as BigDecimal.
+ For values that need not be precise, consider comparing for equality
+ within some range, for example:
+ <code>if ( Math.abs(x - y) < .0000001 )</code>.
+ See the Java Language Specification, section 4.2.4.
+ </p>
+
+
+<h3><a name="IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD">IA: Ambiguous invocation of either an inherited or outer method (IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD)</a></h3>
+
+
+ <p> An inner class is invoking a method that could be resolved to either a inherited method or a method defined in an outer class. By the Java semantics,
+it will be resolved to invoke the inherited method, but this may not be want
+you intend. If you really intend to invoke the inherited method,
+invoke it by invoking the method on super (e.g., invoke super.foo(17)), and
+thus it will be clear to other readers of your code and to FindBugs
+that you want to invoke the inherited method, not the method in the outer class.
+</p>
+
+
+<h3><a name="IC_INIT_CIRCULARITY">IC: Initialization circularity (IC_INIT_CIRCULARITY)</a></h3>
+
+
+ <p> A circularity was detected in the static initializers of the two
+ classes referenced by the bug instance. Many kinds of unexpected
+ behavior may arise from such circularity.</p>
+
+
+<h3><a name="ICAST_IDIV_CAST_TO_DOUBLE">ICAST: int division result cast to double or float (ICAST_IDIV_CAST_TO_DOUBLE)</a></h3>
+
+
+<p>
+This code casts the result of an integer division operation to double or
+float.
+Doing division on integers truncates the result
+to the integer value closest to zero. The fact that the result
+was cast to double suggests that this precision should have been retained.
+What was probably meant was to cast one or both of the operands to
+double <em>before</em> performing the division. Here is an example:
+</p>
+<blockquote>
+<pre>
+int x = 2;
+int y = 5;
+// Wrong: yields result 0.0
+double value1 = x / y;
+
+// Right: yields result 0.4
+double value2 = x / (double) y;
+</pre>
+</blockquote>
+
+
+<h3><a name="ICAST_INTEGER_MULTIPLY_CAST_TO_LONG">ICAST: Result of integer multiplication cast to long (ICAST_INTEGER_MULTIPLY_CAST_TO_LONG)</a></h3>
+
+
+<p>
+This code performs integer multiply and then converts the result to a long,
+as in:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }
+</pre></code>
+If the multiplication is done using long arithmetic, you can avoid
+the possibility that the result will overflow. For example, you
+could fix the above code to:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; }
+</pre></code>
+or
+<code>
+<pre>
+ static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
+ long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; }
+</pre></code>
+</p>
+
+
+
+<h3><a name="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT">ICAST: Unsigned right shift cast to short/byte (ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT)</a></h3>
+
+
+<p>
+The code performs an unsigned right shift, whose result is then
+cast to a short or byte, which discards the upper bits of the result.
+Since the upper bits are discarded, there may be no difference between
+a signed and unsigned right shift (depending upon the size of the shift).
+</p>
+
+
+<h3><a name="IM_AVERAGE_COMPUTATION_COULD_OVERFLOW">IM: Computation of average could overflow (IM_AVERAGE_COMPUTATION_COULD_OVERFLOW)</a></h3>
+
+
+<p>The code computes the average of two integers using either division or signed right shift,
+and then uses the result as the index of an array.
+If the values being averaged are very large, this can overflow (resulting in the computation
+of a negative average). Assuming that the result is intended to be nonnegative, you
+can use an unsigned right shift instead. In other words, rather that using <code>(low+high)/2</code>,
+use <code>(low+high) >>> 1</code>
+</p>
+<p>This bug exists in many earlier implementations of binary search and merge sort.
+Martin Buchholz <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6412541">found and fixed it</a>
+in the JDK libraries, and Joshua Bloch
+<a href="http://googleresearch.blogspot.com/2006/06/extra-extra-read-all-about-it-nearly.html">widely
+publicized the bug pattern</a>.
+</p>
+
+
+<h3><a name="IM_BAD_CHECK_FOR_ODD">IM: Check for oddness that won't work for negative numbers (IM_BAD_CHECK_FOR_ODD)</a></h3>
+
+
+<p>
+The code uses x % 2 == 1 to check to see if a value is odd, but this won't work
+for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check
+for oddness, consider using x & 1 == 1, or x % 2 != 0.
+</p>
+
+
+<h3><a name="INT_VACUOUS_COMPARISON">INT: Vacuous comparison of integer value (INT_VACUOUS_COMPARISON)</a></h3>
+
+
+<p> There is an integer comparison that always returns
+the same value (e.g., x <= Integer.MAX_VALUE).
+</p>
+
+
+<h3><a name="MTIA_SUSPECT_SERVLET_INSTANCE_FIELD">MTIA: Class extends Servlet class and uses instance variables (MTIA_SUSPECT_SERVLET_INSTANCE_FIELD)</a></h3>
+
+
+ <p>
+ This class extends from a Servlet class, and uses a instance member variable. Since only
+ one instance of a Servlet class is created by the J2EE framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables.
+ </p>
+
+
+<h3><a name="MTIA_SUSPECT_STRUTS_INSTANCE_FIELD">MTIA: Class extends Struts Action class and uses instance variables (MTIA_SUSPECT_STRUTS_INSTANCE_FIELD)</a></h3>
+
+
+ <p>
+ This class extends from a Struts Action class, and uses a instance member variable. Since only
+ one instance of a struts Action class is created by the Struts framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables.
+ </p>
+
+
+<h3><a name="NP_IMMEDIATE_DEREFERENCE_OF_READLINE">NP: Immediate dereference of the result of readLine() (NP_IMMEDIATE_DEREFERENCE_OF_READLINE)</a></h3>
+
+
+ <p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text
+to read, readLine() will return null and dereferencing that will generate a null pointer exception.
+</p>
+
+
+<h3><a name="NP_LOAD_OF_KNOWN_NULL_VALUE">NP: Load of known null value (NP_LOAD_OF_KNOWN_NULL_VALUE)</a></h3>
+
+
+ <p> The variable referenced at this point is known to be null due to an earlier
+ check against null. Although this is valid, it might be a mistake (perhaps you
+intended to refer to a different variable, or perhaps the earlier check to see if the
+variable is null should have been a check to see if it was nonnull.
+</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE">NP: Possible null pointer dereference due to return value of called method (NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE)</a></h3>
+
+
+<p> A reference value which is null on some exception control path is
+dereferenced here. This may lead to a <code>NullPointerException</code>
+when the code is executed. The value may be null because it
+was return from a method which is known to return possibly-null values.</p>
+
+
+<h3><a name="NS_DANGEROUS_NON_SHORT_CIRCUIT">NS: Potentially dangerous use of non-short-circuit logic (NS_DANGEROUS_NON_SHORT_CIRCUIT)</a></h3>
+
+
+ <p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||). In addition,
+it seem possible that, depending on the value of the left hand side, you might not
+want to evaluate the right hand side (because it would have side effects, could cause an exception
+or could be expensive.</p>
+<p>
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+</p>
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
+
+
+<h3><a name="NS_NON_SHORT_CIRCUIT">NS: Questionable use of non-short-circuit logic (NS_NON_SHORT_CIRCUIT)</a></h3>
+
+
+ <p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||).
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
+
+
+<h3><a name="PZLA_PREFER_ZERO_LENGTH_ARRAYS">PZLA: Consider returning a zero length array rather than null (PZLA_PREFER_ZERO_LENGTH_ARRAYS)</a></h3>
+
+
+<p> It is often a better design to
+return a length zero array rather than a null reference to indicate that there
+are no results (i.e., an empty list of results).
+This way, no explicit check for null is needed by clients of the method.</p>
+
+<p>On the other hand, using null to indicate
+"there is no answer to this question", then it is probably appropriate.
+For example, <code>File.listFiles()</code> returns an empty list
+if given a directory containing no files, and returns null if the file
+is not a directory.</p>
+
+
+<h3><a name="QF_QUESTIONABLE_FOR_LOOP">QF: Complicated, subtle or wrong increment in for-loop (QF_QUESTIONABLE_FOR_LOOP)</a></h3>
+
+
+ <p>Are you sure this for loop is incrementing the correct variable?
+ It appears that another variable is being initialized and checked
+ by the for loop.
+</p>
+
+
+<h3><a name="RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE">RCN: Redundant comparison of non-null value to null (RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE)</a></h3>
+
+
+<p> This method contains a reference known to be non-null with another reference
+known to be null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES">RCN: Redundant comparison of two null values (RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES)</a></h3>
+
+
+<p> This method contains a redundant comparison of two references known to
+both be definitely null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE">RCN: Redundant nullcheck of value known to be non-null (RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE)</a></h3>
+
+
+<p> This method contains a redundant check of a known non-null value against
+the constant null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE">RCN: Redundant nullcheck of value known to be null (RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE)</a></h3>
+
+
+<p> This method contains a redundant check of a known null value against
+the constant null.</p>
+
+
+<h3><a name="REC_CATCH_EXCEPTION">REC: Exception is caught when Exception is not thrown (REC_CATCH_EXCEPTION)</a></h3>
+
+
+ <p>
+ This method uses a try-catch block that catches Exception objects, but Exception is not
+ thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to
+ say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception
+ each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well,
+ masking potential bugs.
+ </p>
+
+
+<h3><a name="RI_REDUNDANT_INTERFACES">RI: Class implements same interface as superclass (RI_REDUNDANT_INTERFACES)</a></h3>
+
+
+ <p>
+ This class declares that it implements an interface that is also implemented by a superclass.
+ This is redundant, once a superclass implements an interface, all subclasses by default also
+ implement this interface. It may point out that the inheritance hierarchy has changed since
+ this class was created, and consideration should be taken into account for the ownership of
+ the interface's implementation.
+ </p>
+
+
+<h3><a name="RV_CHECK_FOR_POSITIVE_INDEXOF">RV: Method checks to see if result of String.indexOf is positive (RV_CHECK_FOR_POSITIVE_INDEXOF)</a></h3>
+
+
+ <p> The method invokes String.indexOf and checks to see if the result is positive or non-positive.
+ It is much more typical to check to see if the result is negative or non-negative. It is
+ positive only if the substring checked for occurs at some place other than at the beginning of
+ the String.</p>
+
+
+<h3><a name="RV_REM_OF_HASHCODE">RV: Remainder of hashCode could be negative (RV_REM_OF_HASHCODE)</a></h3>
+
+
+<p> This code computes a hashCode, and then computes
+the remainder of that value modulo another value. Since the hashCode
+can be negative, the result of the remainder operation
+can also be negative. </p>
+<p> Assuming you want to ensure that the result of your computation is nonnegative,
+you may need to change your code.
+If you know the divisor is a power of 2,
+you can use a bitwise and operator instead (i.e., instead of
+using <code>x.hashCode()%n</code>, use <code>x.hashCode()&(n-1)</code>.
+This is probably faster than computing the remainder as well.
+If you don't know that the divisor is a power of 2, take the absolute
+value of the result of the remainder operation (i.e., use
+<code>Math.abs(x.hashCode()%n)</code>
+</p>
+
+
+<h3><a name="RV_REM_OF_RANDOM_INT">RV: Remainder of 32-bit signed random integer (RV_REM_OF_RANDOM_INT)</a></h3>
+
+
+<p> This code generates a random signed integer and then computes
+the remainder of that value modulo another value. Since the random
+number can be negative, the result of the remainder operation
+can also be negative. Be sure this is intended, and strongly
+consider using the Random.nextInt(int) method instead.
+</p>
+
+
+<h3><a name="SA_LOCAL_SELF_ASSIGNMENT">SA: Self assignment of local variable (SA_LOCAL_SELF_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a self assignment of a local variable; e.g.</p>
+<pre>
+ public void foo() {
+ int x = 3;
+ x = x;
+ }
+</pre>
+<p>
+Such assignments are useless, and may indicate a logic error or typo.
+</p>
+
+
+<h3><a name="SF_SWITCH_FALLTHROUGH">SF: Switch statement found where one case falls through to the next case (SF_SWITCH_FALLTHROUGH)</a></h3>
+
+
+ <p> This method contains a switch statement where one case branch will fall through to the next case.
+ Usually you need to end this case with a break or return.</p>
+
+
+<h3><a name="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD">ST: Write to static field from instance method (ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)</a></h3>
+
+
+ <p> This instance method writes to a static field. This is tricky to get
+correct if multiple instances are being manipulated,
+and generally bad practice.
+</p>
+
+
+<h3><a name="SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS">Se: Transient field of class that isn't Serializable. (SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS)</a></h3>
+
+
+ <p> The field is marked as transient, but the class isn't Serializable, so marking it as transient
+has absolutely no effect.
+This may be leftover marking from a previous version of the code in which the class was transient, or
+it may indicate a misunderstanding of how serialization works.
+</p>
+
+
+<h3><a name="UCF_USELESS_CONTROL_FLOW">UCF: Useless control flow (UCF_USELESS_CONTROL_FLOW)</a></h3>
+
+
+<p> This method contains a useless control flow statement, where
+control flow continues onto the same place regardless of whether or not
+the branch is taken. For example,
+this is caused by having an empty statement
+block fot an <code>if</code> statement:</p>
+<pre>
+ if (argv.length == 0) {
+ // TODO: handle this case
+ }
+</pre>
+
+
+<h3><a name="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR">UwF: Field not initialized in constructor (UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR)</a></h3>
+
+
+ <p> This field is never initialized within any constructor, and is therefore could be null after
+the object is constructed.
+This could be a either an error or a questionable design, since
+it means a null pointer exception will be generated if that field is dereferenced
+before being initialized.
+</p>
+
+
+<h3><a name="XFB_XML_FACTORY_BYPASS">XFB: Method directly allocates a specific implementation of xml interfaces (XFB_XML_FACTORY_BYPASS)</a></h3>
+
+
+ <p>
+ This method allocates a specific implementation of an xml interface. It is preferable to use
+ the supplied factory classes to create these objects so that the implementation can be
+ changed at runtime. See
+ </p>
+ <ul>
+ <li>javax.xml.parsers.DocumentBuilderFactory</li>
+ <li>javax.xml.parsers.SAXParserFactory</li>
+ <li>javax.xml.transform.TransformerFactory</li>
+ <li>org.w3c.dom.Document.create<i>XXXX</i></li>
+ </ul>
+ <p>for details.</p>
+
+
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+</td></tr></table>
+</body></html>
--- /dev/null
+<html><head><title>FindBugs Bug Descriptions</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css"/>
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon"/>
+</head><body>
+
+<table width="100%"><tr>
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+<td align="left" valign="top">
+<h1>FindBugs Bug Descriptions</h1>
+<p>This document lists the standard bug patterns reported by
+<a href="http://findbugs.sourceforge.net">FindBugs</a> version 1.3.0.</p>
+<h2>Summary</h2>
+<table width="100%">
+<tr bgcolor="#b9b9fe"><th>Description</th><th>Category</th></tr>
+<tr bgcolor="#eeeeee"><td><a href="#AM_CREATES_EMPTY_JAR_FILE_ENTRY">AM: Creates an empty jar file entry</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#AM_CREATES_EMPTY_ZIP_FILE_ENTRY">AM: Creates an empty zip file entry</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS">BC: Equals method should not assume anything about the type of its argument</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_RANDOM_USED_ONLY_ONCE">BC: Random object created and used only once</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_SIGNED_CHECK">BIT: Check for sign of bitwise operation</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#CN_IDIOM">CN: Class implements Cloneable but does not define or use clone method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CN_IDIOM_NO_SUPER_CALL">CN: clone method does not call super.clone()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#CO_ABSTRACT_SELF">Co: Abstract class defines covariant compareTo() method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CO_SELF_NO_OBJECT">Co: Covariant compareTo() method defined</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DE_MIGHT_DROP">DE: Method might drop exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DE_MIGHT_IGNORE">DE: Method might ignore exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED">DP: Classloaders should only be created inside doPrivileged block</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DP_DO_INSIDE_DO_PRIVILEGED">DP: Method invoked that should be only be invoked inside a doPrivileged block</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_EXIT">Dm: Method invokes System.exit(...)</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_RUN_FINALIZERS_ON_EXIT">Dm: Method invokes dangerous method runFinalizersOnExit </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ES_COMPARING_PARAMETER_STRING_WITH_EQ">ES: Comparison of String parameter using == or !=</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ES_COMPARING_STRINGS_WITH_EQ">ES: Comparison of String objects using == or !=</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_ABSTRACT_SELF">Eq: Abstract class defines covariant equals() method</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_COMPARETO_USE_OBJECT_EQUALS">Eq: Class defines compareTo(...) and uses Object.equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_SELF_NO_OBJECT">Eq: Covariant equals() method defined</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_SELF_USE_OBJECT">Eq: Covariant equals() method defined, Object.equals(Object) inherited</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_EMPTY">FI: Empty finalizer should be deleted</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_EXPLICIT_INVOCATION">FI: Explicit invocation of finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_FINALIZER_NULLS_FIELDS">FI: Finalizer nulls fields</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_FINALIZER_ONLY_NULLS_FIELDS">FI: Finalizer only nulls fields</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_MISSING_SUPER_CALL">FI: Finalizer does not call superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FI_NULLIFY_SUPER">FI: Finalizer nullifies superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_USELESS">FI: Finalizer does nothing but call superclass finalizer</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_EQUALS_NO_HASHCODE">HE: Class defines equals() but not hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#HE_EQUALS_USE_HASHCODE">HE: Class defines equals() and uses Object.hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_HASHCODE_NO_EQUALS">HE: Class defines hashCode() but not equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#HE_HASHCODE_USE_OBJECT_EQUALS">HE: Class defines hashCode() and uses Object.equals()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_INHERITS_EQUALS_USE_HASHCODE">HE: Class inherits equals() and uses Object.hashCode()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION">IC: Superclass uses subclass during initialization</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IMSE_DONT_CATCH_IMSE">IMSE: Dubious catching of IllegalMonitorStateException</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ISC_INSTANTIATE_STATIC_CLASS">ISC: Needless instantiation of class that only supplies static methods</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IT_NO_SUCH_ELEMENT">It: Iterator next() method can't throw NoSuchElement exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION">J2EE: Store of non serializable object into HttpSession</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_CLONE_COULD_RETURN_NULL">NP: Clone method may return null</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT">NP: equals() method does not check for null argument</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_TOSTRING_COULD_RETURN_NULL">NP: toString method may return null</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_CLASS_NAMING_CONVENTION">Nm: Class names should start with an upper case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_CLASS_NOT_EXCEPTION">Nm: Class is not derived from an Exception, even though it is named as such</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_CONFUSING">Nm: Confusing method names</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_FIELD_NAMING_CONVENTION">Nm: Field names should start with an lower case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_METHOD_NAMING_CONVENTION">Nm: Method names should start with an lower case letter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_SAME_SIMPLE_NAME_AS_INTERFACE">Nm: Class names shouldn't shadow simple name of implemented interface</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_SAME_SIMPLE_NAME_AS_SUPERCLASS">Nm: Class names shouldn't shadow simple name of superclass</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_VERY_CONFUSING_INTENTIONAL">Nm: Very confusing method names</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_WRONG_PACKAGE_INTENTIONAL">Nm: Method doesn't override method in superclass due to wrong package for parameter</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ODR_OPEN_DATABASE_RESOURCE">ODR: Method may fail to close database resource</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH">ODR: Method may fail to close database resource on exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#OS_OPEN_STREAM">OS: Method may fail to close stream</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#OS_OPEN_STREAM_EXCEPTION_PATH">OS: Method may fail to close stream on exception</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RC_REF_COMPARISON">RC: Suspicious reference comparison</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RR_NOT_CHECKED">RR: Method ignores results of InputStream.read()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SR_NOT_CHECKED">RR: Method ignores results of InputStream.skip()</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_RETURN_VALUE_IGNORED_BAD_PRACTICE">RV: Method ignores return value</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SI_INSTANCE_BEFORE_FINALS_ASSIGNED">SI: Static initializer creates instance before all static final fields assigned</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE">SQL: Nonconstant string passed to execute method on an SQL statement</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING">SQL: A prepared statement is generated from a nonconstant String</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SW_SWING_METHODS_INVOKED_IN_SWING_THREAD">SW: Certain swing methods needs to be invoked in Swing thread</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_BAD_FIELD">Se: Non-transient non-serializable instance field in serializable class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_BAD_FIELD_INNER_CLASS">Se: Non-serializable class has a serializable inner class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_BAD_FIELD_STORE">Se: Non-serializable value stored into instance field of a serializable class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_COMPARATOR_SHOULD_BE_SERIALIZABLE">Se: Comparator doesn't implement Serializable</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_INNER_CLASS">Se: Serializable inner class</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_METHOD_MUST_BE_PRIVATE">Se: Method must be private in order for serialization to work</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NONFINAL_SERIALVERSIONID">Se: serialVersionUID isn't final</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NONLONG_SERIALVERSIONID">Se: serialVersionUID isn't long</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NONSTATIC_SERIALVERSIONID">Se: serialVersionUID isn't static</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NO_SUITABLE_CONSTRUCTOR">Se: Class is Serializable but its superclass doesn't define a void constructor</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION">Se: Class is Externalizable but doesn't define a void constructor</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_READ_RESOLVE_MUST_RETURN_OBJECT">Se: The readResolve method must be declared with a return type
+of Object. </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_TRANSIENT_FIELD_NOT_RESTORED">Se: Transient field that isn't set by deserialization. </a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SE_NO_SERIALVERSIONID">SnVI: Class is Serializable, but doesn't define serialVersionUID</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UI_INHERITANCE_UNSAFE_GETRESOURCE">UI: Usage of GetResource may be unsafe if class is extended</a></td><td>Bad practice</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_IMPOSSIBLE_CAST">BC: Impossible cast</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_IMPOSSIBLE_INSTANCEOF">BC: instanceof will always return false</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_AND">BIT: Incompatible bit masks</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_AND_ZZ">BIT: Check to see if ((...) & 0) == 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_IOR">BIT: Incompatible bit masks</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BIT_IOR_OF_SIGNED_BYTE">BIT: Bitwise OR of signed byte value</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BIT_SIGNED_CHECK_HIGH_BIT">BIT: Check for sign of bitwise operation</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BOA_BADLY_OVERRIDDEN_ADAPTER">BOA: Class overrides a method implemented in super class Adapter wrongly</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR">Bx: Primitive value is unboxed and coerced for ternary operator</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DLS_DEAD_STORE_OF_CLASS_LITERAL">DLS: Dead store of class literal</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DLS_OVERWRITTEN_INCREMENT">DLS: Overwritten increment</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_BAD_MONTH">DMI: Bad constant value for month</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_CALLING_NEXT_FROM_HASNEXT">DMI: hasNext method invokes next</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_INVOKING_TOSTRING_ON_ARRAY">DMI: Invocation of toString on an array</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT">DMI: Double.longBitsToDouble invoked on an int</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION">Dm: Can't use reflection to check for presence of annotation with default retention</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_ARRAY_AND_NONARRAY">EC: equals() used to compare array and nonarray</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_BAD_ARRAY_COMPARE">EC: Invocation of equals() on an array, which is equivalent to ==</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_NULL_ARG">EC: Call to equals() with null argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_UNRELATED_CLASS_AND_INTERFACE">EC: Call to equals() comparing unrelated class and interface</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_UNRELATED_INTERFACES">EC: Call to equals() comparing different interface types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EC_UNRELATED_TYPES">EC: Call to equals() comparing different types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EC_UNRELATED_TYPES_USING_POINTER_EQUALITY">EC: Using pointer equality to compare different types</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EQ_DONT_DEFINE_EQUALS_FOR_ENUM">Eq: Covariant equals() method defined for enum</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC">Eq: equals method overrides equals in superclass and may not be symmetric</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER">FE: Doomed test for equality to NaN</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#GC_UNRELATED_TYPES">GC: No relationship between generic parameter and method argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HE_USE_OF_UNHASHABLE_CLASS">HE: Use of class without a hashCode() method in a hashed data structure</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_BAD_SHIFT_AMOUNT">ICAST: Integer shift by an amount not in the range 0..31</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL">ICAST: int value cast to double and then passed to Math.ceil</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND">ICAST: int value cast to float and then passed to Math.round</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD">IJU: JUnit assertion in run method will not be noticed by JUnit</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_BAD_SUITE_METHOD">IJU: TestCase declares a bad suite method </a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_NO_TESTS">IJU: TestCase has no tests</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_SETUP_NO_SUPER">IJU: TestCase implements setUp but doesn't call super.setUp()</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IJU_SUITE_NOT_STATIC">IJU: TestCase implements a non-static suite method </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IJU_TEARDOWN_NO_SUPER">IJU: TestCase implements tearDown but doesn't call super.tearDown()</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IL_CONTAINER_ADDED_TO_ITSELF">IL: A container is added to itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IL_INFINITE_LOOP">IL: An apparent infinite loop</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IL_INFINITE_RECURSIVE_LOOP">IL: An apparent infinite recursive loop</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IM_MULTIPLYING_RESULT_OF_IREM">IM: Integer multiply of result of integer remainder</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE">INT: Bad comparison of nonnegative value with negative constant</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#INT_BAD_COMPARISON_WITH_SIGNED_BYTE">INT: Bad comparison of signed byte</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_BAD_REM_BY_1">INT: Integer remainder modulo 1</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN">IP: A parameter is dead upon entry to a method but overwritten</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS">JCIP: Fields of immutable classes should be final</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MF_CLASS_MASKS_FIELD">MF: Class defines field that masks a superclass field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MF_METHOD_MASKS_FIELD">MF: Method defines a variable that obscures a field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_ALWAYS_NULL">NP: Null pointer dereference</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_ALWAYS_NULL_EXCEPTION">NP: Null pointer dereference in method on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_ARGUMENT_MIGHT_BE_NULL">NP: Method does not check for null argument</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_GUARANTEED_DEREF">NP: Null value is guaranteed to be dereferenced</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH">NP: Value is null and guaranteed to be dereferenced on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NONNULL_PARAM_VIOLATION">NP: Method call passes null to a nonnull parameter </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NONNULL_RETURN_VIOLATION">NP: Method may return null, but is declared @NonNull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_INSTANCEOF">NP: A known null value is checked to see if it is an instance of a type</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_ON_SOME_PATH">NP: Possible null pointer dereference</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_ON_SOME_PATH_EXCEPTION">NP: Possible null pointer dereference in method on exception path</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_PARAM_DEREF">NP: Method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS">NP: Method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_PARAM_DEREF_NONVIRTUAL">NP: Non-virtual method call passes null for unconditionally dereferenced parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_STORE_INTO_NONNULL_FIELD">NP: Store of null value into field annotated NonNull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_UNWRITTEN_FIELD">NP: Read of unwritten field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_BAD_EQUAL">Nm: Class defines equal(); should it be equals()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_LCASE_HASHCODE">Nm: Class defines hashcode(); should it be hashCode()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_LCASE_TOSTRING">Nm: Class defines tostring(); should it be toString()?</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_METHOD_CONSTRUCTOR_CONFUSION">Nm: Apparent method/constructor confusion</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NM_VERY_CONFUSING">Nm: Very confusing method names</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NM_WRONG_PACKAGE">Nm: Method doesn't override method in superclass due to wrong package for parameter</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT">QBA: Method assigns boolean literal in boolean expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE">RCN: Nullcheck of value previously dereferenced</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION">RE: Invalid syntax for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION">RE: File.separator used for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RE_POSSIBLE_UNINTENDED_PATTERN">RE: "." used for regular expression</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_01_TO_INT">RV: Random value from 0 to 1 is coerced to the integer 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_ABSOLUTE_VALUE_OF_HASHCODE">RV: Bad attempt to compute absolute value of signed 32-bit hashcode </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_ABSOLUTE_VALUE_OF_RANDOM_INT">RV: Bad attempt to compute absolute value of signed 32-bit random integer</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_DONT_JUST_NULL_CHECK_READLINE">RV: Method discards result of readLine after checking if it is nonnull</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_EXCEPTION_NOT_THROWN">RV: Exception created and dropped rather than thrown</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_RETURN_VALUE_IGNORED">RV: Method ignores return value</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_FIELD_DOUBLE_ASSIGNMENT">SA: Double assignment of field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_FIELD_SELF_ASSIGNMENT">SA: Self assignment of field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_FIELD_SELF_COMPARISON">SA: Self comparison of field with itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_FIELD_SELF_COMPUTATION">SA: Nonsensical self computation involving a field (e.g., x & x)</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_DOUBLE_ASSIGNMENT">SA: Double assignment of local variable </a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SA_LOCAL_SELF_COMPARISON">SA: Self comparison of value with itself</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_SELF_COMPUTATION">SA: Nonsensical self computation involving a variable (e.g., x & x)</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH">SF: Dead store due to switch statement fall through</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIO_SUPERFLUOUS_INSTANCEOF">SIO: Unnecessary type check done using instanceof operator</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SQL_BAD_PREPARED_STATEMENT_ACCESS">SQL: Method attempts to access a prepared statement parameter with index 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SQL_BAD_RESULTSET_ACCESS">SQL: Method attempts to access a result set field with index 0</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STI_INTERRUPTED_ON_CURRENTTHREAD">STI: Unneeded use of currentThread() call, to call interrupted() </a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STI_INTERRUPTED_ON_UNKNOWNTHREAD">STI: Static Thread.interrupted() method invoked on thread instance</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED">TQ: Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK">TQ: Value that might not carry a type qualifier reaches a use requiring that type qualifier</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK">TQ: Unknown value reaches a use which forbids values carrying type qualifier annotation</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED">TQ: Value annotated as never carrying a type qualifier used where value carrying that qualifier is required</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UCF_USELESS_CONTROL_FLOW_NEXT_LINE">UCF: Useless control flow to next line</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS">UMAC: Uncallable method defined in anonymous class</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UR_UNINIT_READ">UR: Uninitialized read of field in constructor</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UWF_NULL_FIELD">UwF: Field only ever set to null</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UWF_UNWRITTEN_FIELD">UwF: Unwritten field</a></td><td>Correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG">VA: Primitive array passed to function expecting a variable number of object arguments</a></td><td>Correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_CONVERT_CASE">Dm: Consider using Locale parameterized version of invoked method</a></td><td>Internationalization</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EI_EXPOSE_REP">EI: May expose internal representation by returning reference to mutable object</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EI_EXPOSE_REP2">EI2: May expose internal representation by incorporating reference to mutable object</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#FI_PUBLIC_SHOULD_BE_PROTECTED">FI: Finalizer should be protected, not public</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#EI_EXPOSE_STATIC_REP2">MS: May expose internal static state by storing a mutable object into a static field</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_CANNOT_BE_FINAL">MS: Field isn't final and can't be protected from malicious code</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_EXPOSE_REP">MS: Public static method may expose internal representation by returning array</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_FINAL_PKGPROTECT">MS: Field should be both final and package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_MUTABLE_ARRAY">MS: Field is a mutable array</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_MUTABLE_HASHTABLE">MS: Field is a mutable Hashtable</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_OOI_PKGPROTECT">MS: Field should be moved out of an interface and made package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MS_PKGPROTECT">MS: Field should be package protected</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MS_SHOULD_BE_FINAL">MS: Field isn't final but should be</a></td><td>Malicious code vulnerability</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DC_DOUBLECHECK">DC: Possible double check of field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DL_SYNCHRONIZATION_ON_SHARED_CONSTANT">DL: Synchronization on shared constant could lead to deadlock</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_MONITOR_WAIT_ON_CONDITION">Dm: Monitor wait() called on Condition</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_USELESS_THREAD">Dm: A thread was created using the default empty run method</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ESync_EMPTY_SYNC">ESync: Empty synchronized block</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IS2_INCONSISTENT_SYNC">IS: Inconsistent synchronization</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IS_FIELD_NOT_GUARDED">IS: Field not guarded against concurrent access</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#JLM_JSR166_LOCK_MONITORENTER">JLM: Synchronization performed on java.util.concurrent Lock</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#LI_LAZY_INIT_STATIC">LI: Incorrect lazy initialization of static field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#LI_LAZY_INIT_UPDATE_STATIC">LI: Incorrect lazy initialization and update of static field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ML_SYNC_ON_UPDATED_FIELD">ML: Method synchronizes on an updated field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MWN_MISMATCHED_NOTIFY">MWN: Mismatched notify()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MWN_MISMATCHED_WAIT">MWN: Mismatched wait()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NN_NAKED_NOTIFY">NN: Naked notify</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_SYNC_AND_NULL_CHECK_FIELD">NP: Synchronize and null check on the same field.</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NO_NOTIFY_NOT_NOTIFYALL">No: Using notify() rather than notifyAll()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RS_READOBJECT_SYNC">RS: Class's readObject() method is synchronized</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RU_INVOKE_RUN">Ru: Invokes run on a thread (did you mean to start it instead?)</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SC_START_IN_CTOR">SC: Constructor invokes Thread.start()</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SP_SPIN_ON_FIELD">SP: Method spins on field</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE">STCAL: Call to static Calendar</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE">STCAL: Call to static DateFormat</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#STCAL_STATIC_CALENDAR_INSTANCE">STCAL: Static Calendar</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE">STCAL: Static DateFormat</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SWL_SLEEP_WITH_LOCK_HELD">SWL: Method calls Thread.sleep() with a lock held</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#TLW_TWO_LOCK_WAIT">TLW: Wait with two locks held</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UG_SYNC_SET_UNSYNC_GET">UG: Unsynchronized get method, synchronized set method</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UL_UNRELEASED_LOCK">UL: Method does not release lock on all paths</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UL_UNRELEASED_LOCK_EXCEPTION_PATH">UL: Method does not release lock on all exception paths</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UW_UNCOND_WAIT">UW: Unconditional wait</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#VO_VOLATILE_REFERENCE_TO_ARRAY">VO: A volatile reference to an array doesn't treat the array elements as volatile</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#WS_WRITEOBJECT_SYNC">WS: Class's writeObject() method is synchronized but nothing else is</a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#WA_AWAIT_NOT_IN_LOOP">Wa: Condition.await() not in loop </a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#WA_NOT_IN_LOOP">Wa: Wait not in loop </a></td><td>Multithreaded correctness</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BX_BOXING_IMMEDIATELY_UNBOXED">Bx: Primitive value is boxed and then immediately unboxed</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION">Bx: Primitive value is boxed then unboxed to perform primative coercion</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_BOXED_PRIMITIVE_TOSTRING">Bx: Method allocates a boxed primitive just to call toString</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_FP_NUMBER_CTOR">Bx: Method invokes inefficient floating-point Number constructor; use static valueOf instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_NUMBER_CTOR">Bx: Method invokes inefficient Number constructor; use static valueOf instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_BLOCKING_METHODS_ON_URL">Dm: The equals and hashCode methods of URL are blocking</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_COLLECTION_OF_URLS">Dm: Maps and sets of URLs can be performance hogs</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_BOOLEAN_CTOR">Dm: Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_GC">Dm: Explicit garbage collection; extremely dubious except in benchmarking code</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_NEW_FOR_GETCLASS">Dm: Method allocates an object, only to get the class object</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_NEXTINT_VIA_NEXTDOUBLE">Dm: Use the nextInt method of Random rather than nextDouble to generate a random integer</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_STRING_CTOR">Dm: Method invokes inefficient new String(String) constructor</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_STRING_EMPTY_EQUALS">Dm: Method invokes inefficient String.equals(""); use String.length() == 0 instead</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DM_STRING_TOSTRING">Dm: Method invokes toString() method on a String</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DM_STRING_VOID_CTOR">Dm: Method invokes inefficient new String() constructor</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#HSC_HUGE_SHARED_STRING_CONSTANT">HSC: Huge string constants is duplicated across multiple class files</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ITA_INEFFICIENT_TO_ARRAY">ITA: Method uses toArray() with zero-length array argument</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SBSC_USE_STRINGBUFFER_CONCATENATION">SBSC: Method concatenates strings using + in a loop</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIC_INNER_SHOULD_BE_STATIC">SIC: Should be a static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SIC_INNER_SHOULD_BE_STATIC_ANON">SIC: Could be refactored into a named static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS">SIC: Could be refactored into a static inner class</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SS_SHOULD_BE_STATIC">SS: Unread field: should this field be static?</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UM_UNNECESSARY_MATH">UM: Method calls static Math class method on a constant value</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UPM_UNCALLED_PRIVATE_METHOD">UPM: Private method is never called</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#URF_UNREAD_FIELD">UrF: Unread field</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UUF_UNUSED_FIELD">UuF: Unused field</a></td><td>Performance</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#WMI_WRONG_MAP_ITERATOR">WMI: Inefficient use of keySet iterator instead of entrySet iterator</a></td><td>Performance</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_BAD_CAST_TO_ABSTRACT_COLLECTION">BC: Questionable cast to abstract collection </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_BAD_CAST_TO_CONCRETE_COLLECTION">BC: Questionable cast to concrete collection</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#BC_UNCONFIRMED_CAST">BC: Unchecked/unconfirmed cast</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#BC_VACUOUS_INSTANCEOF">BC: instanceof will always return true</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#CI_CONFUSED_INHERITANCE">CI: Class is final but declares protected field</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DB_DUPLICATE_BRANCHES">DB: Method uses the same code for two branches</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DB_DUPLICATE_SWITCH_CLAUSES">DB: Method uses the same code for two switch clauses</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DLS_DEAD_LOCAL_STORE">DLS: Dead store to local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DLS_DEAD_LOCAL_STORE_OF_NULL">DLS: Dead store of null to local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_HARDCODED_ABSOLUTE_FILENAME">DMI: Code contains a hard coded reference to an absolute pathname</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_NONSERIALIZABLE_OBJECT_WRITTEN">DMI: Non serializable object written to ObjectOutput</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#DMI_USELESS_SUBSTRING">DMI: Invocation of substring(0), which returns the original value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED">Dm: Thread passed where Runnable expected</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#EQ_DOESNT_OVERRIDE_EQUALS">Eq: Class doesn't override equals in superclass</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#FE_FLOATING_POINT_EQUALITY">FE: Test for floating point equality</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD">IA: Ambiguous invocation of either an inherited or outer method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IC_INIT_CIRCULARITY">IC: Initialization circularity</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_IDIV_CAST_TO_DOUBLE">ICAST: int division result cast to double or float</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#ICAST_INTEGER_MULTIPLY_CAST_TO_LONG">ICAST: Result of integer multiplication cast to long</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT">ICAST: Unsigned right shift cast to short/byte</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#IM_AVERAGE_COMPUTATION_COULD_OVERFLOW">IM: Computation of average could overflow</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#IM_BAD_CHECK_FOR_ODD">IM: Check for oddness that won't work for negative numbers </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#INT_VACUOUS_COMPARISON">INT: Vacuous comparison of integer value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#MTIA_SUSPECT_SERVLET_INSTANCE_FIELD">MTIA: Class extends Servlet class and uses instance variables</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#MTIA_SUSPECT_STRUTS_INSTANCE_FIELD">MTIA: Class extends Struts Action class and uses instance variables</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_IMMEDIATE_DEREFERENCE_OF_READLINE">NP: Immediate dereference of the result of readLine()</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NP_LOAD_OF_KNOWN_NULL_VALUE">NP: Load of known null value</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE">NP: Possible null pointer dereference due to return value of called method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#NS_DANGEROUS_NON_SHORT_CIRCUIT">NS: Potentially dangerous use of non-short-circuit logic</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#NS_NON_SHORT_CIRCUIT">NS: Questionable use of non-short-circuit logic</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#PZLA_PREFER_ZERO_LENGTH_ARRAYS">PZLA: Consider returning a zero length array rather than null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#QF_QUESTIONABLE_FOR_LOOP">QF: Complicated, subtle or wrong increment in for-loop </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE">RCN: Redundant comparison of non-null value to null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES">RCN: Redundant comparison of two null values</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE">RCN: Redundant nullcheck of value known to be non-null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE">RCN: Redundant nullcheck of value known to be null</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#REC_CATCH_EXCEPTION">REC: Exception is caught when Exception is not thrown</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RI_REDUNDANT_INTERFACES">RI: Class implements same interface as superclass</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_CHECK_FOR_POSITIVE_INDEXOF">RV: Method checks to see if result of String.indexOf is positive</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#RV_REM_OF_HASHCODE">RV: Remainder of hashCode could be negative</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#RV_REM_OF_RANDOM_INT">RV: Remainder of 32-bit signed random integer</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#SA_LOCAL_SELF_ASSIGNMENT">SA: Self assignment of local variable</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SF_SWITCH_FALLTHROUGH">SF: Switch statement found where one case falls through to the next case</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD">ST: Write to static field from instance method</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS">Se: Transient field of class that isn't Serializable. </a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#UCF_USELESS_CONTROL_FLOW">UCF: Useless control flow</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#eeeeee"><td><a href="#UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR">UwF: Field not initialized in constructor</a></td><td>Dodgy</td></tr>
+<tr bgcolor="#ffffff"><td><a href="#XFB_XML_FACTORY_BYPASS">XFB: Method directly allocates a specific implementation of xml interfaces</a></td><td>Dodgy</td></tr>
+</table>
+<h2>Descriptions</h2>
+<h3><a name="AM_CREATES_EMPTY_JAR_FILE_ENTRY">AM: Creates an empty jar file entry (AM_CREATES_EMPTY_JAR_FILE_ENTRY)</a></h3>
+
+
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty JarFile entry. The contents of the entry
+should be written to the JarFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
+
+
+<h3><a name="AM_CREATES_EMPTY_ZIP_FILE_ENTRY">AM: Creates an empty zip file entry (AM_CREATES_EMPTY_ZIP_FILE_ENTRY)</a></h3>
+
+
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty ZipFile entry. The contents of the entry
+should be written to the ZipFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
+
+
+<h3><a name="BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS">BC: Equals method should not assume anything about the type of its argument (BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS)</a></h3>
+
+
+<p>
+The <code>equals(Object o)</code> method shouldn't make any assumptions
+about the type of <code>o</code>. It should simply return
+false if <code>o</code> is not the same type as <code>this</code>.
+</p>
+
+
+<h3><a name="DMI_RANDOM_USED_ONLY_ONCE">BC: Random object created and used only once (DMI_RANDOM_USED_ONLY_ONCE)</a></h3>
+
+
+<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards
+the Random object. This produces mediocre quality random numbers and is inefficient.
+If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number
+is required invoke a method on the existing Random object to obtain it.
+</p>
+
+<p>If it is important that the generated Random numbers not be guessable, you <em>must</em> not create a new Random for each random
+number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead
+(and avoid allocating a new SecureRandom for each random number needed).
+</p>
+
+
+<h3><a name="BIT_SIGNED_CHECK">BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK)</a></h3>
+
+
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
+
+
+<h3><a name="CN_IDIOM">CN: Class implements Cloneable but does not define or use clone method (CN_IDIOM)</a></h3>
+
+
+<p>
+ Class implements Cloneable but does not define or
+ use the clone method.</p>
+
+
+<h3><a name="CN_IDIOM_NO_SUPER_CALL">CN: clone method does not call super.clone() (CN_IDIOM_NO_SUPER_CALL)</a></h3>
+
+
+<p> This non-final class defines a clone() method that does not call super.clone().
+If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"),
+and the subclass <i>B</i> calls super.clone(), then it is likely that
+<i>B</i>'s clone() method will return an object of type <i>A</i>,
+which violates the standard contract for clone().</p>
+
+<p> If all clone() methods call super.clone(), then they are guaranteed
+to use Object.clone(), which always returns an object of the correct type.</p>
+
+
+<h3><a name="CO_ABSTRACT_SELF">Co: Abstract class defines covariant compareTo() method (CO_ABSTRACT_SELF)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="CO_SELF_NO_OBJECT">Co: Covariant compareTo() method defined (CO_SELF_NO_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="DE_MIGHT_DROP">DE: Method might drop exception (DE_MIGHT_DROP)</a></h3>
+
+
+ <p> This method might drop an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
+
+
+<h3><a name="DE_MIGHT_IGNORE">DE: Method might ignore exception (DE_MIGHT_IGNORE)</a></h3>
+
+
+ <p> This method might ignore an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
+
+
+<h3><a name="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED">DP: Classloaders should only be created inside doPrivileged block (DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED)</a></h3>
+
+
+ <p> This code creates a classloader, which requires a security manager.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
+
+
+<h3><a name="DP_DO_INSIDE_DO_PRIVILEGED">DP: Method invoked that should be only be invoked inside a doPrivileged block (DP_DO_INSIDE_DO_PRIVILEGED)</a></h3>
+
+
+ <p> This code invokes a method that requires a security permission check.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
+
+
+<h3><a name="DM_EXIT">Dm: Method invokes System.exit(...) (DM_EXIT)</a></h3>
+
+
+ <p> Invoking System.exit shuts down the entire Java virtual machine. This
+ should only been done when it is appropriate. Such calls make it
+ hard or impossible for your code to be invoked by other code.
+ Consider throwing a RuntimeException instead.</p>
+
+
+<h3><a name="DM_RUN_FINALIZERS_ON_EXIT">Dm: Method invokes dangerous method runFinalizersOnExit (DM_RUN_FINALIZERS_ON_EXIT)</a></h3>
+
+
+ <p> <em>Never call System.runFinalizersOnExit
+or Runtime.runFinalizersOnExit for any reason: they are among the most
+dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>
+
+
+<h3><a name="ES_COMPARING_PARAMETER_STRING_WITH_EQ">ES: Comparison of String parameter using == or != (ES_COMPARING_PARAMETER_STRING_WITH_EQ)</a></h3>
+
+
+ <p>This code compares a <code>java.lang.String</code> parameter for reference
+equality using the == or != operators. Requiring callers to
+pass only String constants or interned strings to a method is unnecessarily
+fragile, and rarely leads to measurable performance gains. Consider
+using the <code>equals(Object)</code> method instead.</p>
+
+
+<h3><a name="ES_COMPARING_STRINGS_WITH_EQ">ES: Comparison of String objects using == or != (ES_COMPARING_STRINGS_WITH_EQ)</a></h3>
+
+
+ <p>This code compares <code>java.lang.String</code> objects for reference
+equality using the == or != operators.
+Unless both strings are either constants in a source file, or have been
+interned using the <code>String.intern()</code> method, the same string
+value may be represented by two different String objects. Consider
+using the <code>equals(Object)</code> method instead.</p>
+
+
+<h3><a name="EQ_ABSTRACT_SELF">Eq: Abstract class defines covariant equals() method (EQ_ABSTRACT_SELF)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="EQ_COMPARETO_USE_OBJECT_EQUALS">Eq: Class defines compareTo(...) and uses Object.equals() (EQ_COMPARETO_USE_OBJECT_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>compareTo(...)</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>.
+ Generally, the value of compareTo should return zero if and only if
+ equals returns true. If this is violated, weird and unpredictable
+ failures will occur in classes such as PriorityQueue.
+ In Java 5 the PriorityQueue.remove method uses the compareTo method,
+ while in Java 6 it uses the equals method.
+
+<p>From the JavaDoc for the compareTo method in the Comparable interface:
+<blockquote>
+It is strongly recommended, but not strictly required that <code>(x.compareTo(y)==0) == (x.equals(y))</code>.
+Generally speaking, any class that implements the Comparable interface and violates this condition
+should clearly indicate this fact. The recommended language
+is "Note: this class has a natural ordering that is inconsistent with equals."
+</blockquote>
+
+
+<h3><a name="EQ_SELF_NO_OBJECT">Eq: Covariant equals() method defined (EQ_SELF_NO_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
+
+
+<h3><a name="EQ_SELF_USE_OBJECT">Eq: Covariant equals() method defined, Object.equals(Object) inherited (EQ_SELF_USE_OBJECT)</a></h3>
+
+
+ <p> This class defines a covariant version of the <code>equals()</code>
+ method, but inherits the normal <code>equals(Object)</code> method
+ defined in the base <code>java.lang.Object</code> class.
+ The class should probably define a non-covariant version of <code>equals()</code>.
+ (I.e., a method with the signature <code>boolean equals(java.lang.Object)</code>.</p>
+
+
+<h3><a name="FI_EMPTY">FI: Empty finalizer should be deleted (FI_EMPTY)</a></h3>
+
+
+ <p> Empty <code>finalize()</code> methods are useless, so they should
+ be deleted.</p>
+
+
+<h3><a name="FI_EXPLICIT_INVOCATION">FI: Explicit invocation of finalizer (FI_EXPLICIT_INVOCATION)</a></h3>
+
+
+ <p> This method contains an explicit invocation of the <code>finalize()</code>
+ method on an object. Because finalizer methods are supposed to be
+ executed once, and only by the VM, this is a bad idea.</p>
+<p>If a connected set of objects beings finalizable, then the VM will invoke the
+finalize method on all the finalizable object, possibly at the same time in different threads.
+Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize
+on objects referenced by X, because they may already be getting finalized in a separate thread.
+
+
+<h3><a name="FI_FINALIZER_NULLS_FIELDS">FI: Finalizer nulls fields (FI_FINALIZER_NULLS_FIELDS)</a></h3>
+
+
+ <p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection,
+ and the object is going to be garbage collected anyway.
+
+
+<h3><a name="FI_FINALIZER_ONLY_NULLS_FIELDS">FI: Finalizer only nulls fields (FI_FINALIZER_ONLY_NULLS_FIELDS)</a></h3>
+
+
+ <p> This finalizer does nothing except null out fields. This is completely pointless, and requires that
+the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize
+method.
+
+
+<h3><a name="FI_MISSING_SUPER_CALL">FI: Finalizer does not call superclass finalizer (FI_MISSING_SUPER_CALL)</a></h3>
+
+
+ <p> This <code>finalize()</code> method does not make a call to its
+ superclass's <code>finalize()</code> method. So, any finalizer
+ actions defined for the superclass will not be performed.
+ Add a call to <code>super.finalize()</code>.</p>
+
+
+<h3><a name="FI_NULLIFY_SUPER">FI: Finalizer nullifies superclass finalizer (FI_NULLIFY_SUPER)</a></h3>
+
+
+ <p> This empty <code>finalize()</code> method explicitly negates the
+ effect of any finalizer defined by its superclass. Any finalizer
+ actions defined for the superclass will not be performed.
+ Unless this is intended, delete this method.</p>
+
+
+<h3><a name="FI_USELESS">FI: Finalizer does nothing but call superclass finalizer (FI_USELESS)</a></h3>
+
+
+ <p> The only thing this <code>finalize()</code> method does is call
+ the superclass's <code>finalize()</code> method, making it
+ redundant. Delete it.</p>
+
+
+<h3><a name="HE_EQUALS_NO_HASHCODE">HE: Class defines equals() but not hashCode() (HE_EQUALS_NO_HASHCODE)</a></h3>
+
+
+ <p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>. Therefore, the class may violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+
+<h3><a name="HE_EQUALS_USE_HASHCODE">HE: Class defines equals() and uses Object.hashCode() (HE_EQUALS_USE_HASHCODE)</a></h3>
+
+
+ <p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>, and inherits the implementation of
+ <code>hashCode()</code> from <code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre>
+
+
+<h3><a name="HE_HASHCODE_NO_EQUALS">HE: Class defines hashCode() but not equals() (HE_HASHCODE_NO_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>hashCode()</code> method but not an
+ <code>equals()</code> method. Therefore, the class may
+ violate the invariant that equal objects must have equal hashcodes.</p>
+
+
+<h3><a name="HE_HASHCODE_USE_OBJECT_EQUALS">HE: Class defines hashCode() and uses Object.equals() (HE_HASHCODE_USE_OBJECT_EQUALS)</a></h3>
+
+
+ <p> This class defines a <code>hashCode()</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>
+ (which defines equality by comparing object references). Although
+ this will probably satisfy the contract that equal objects must have
+ equal hashcodes, it is probably not what was intended by overriding
+ the <code>hashCode()</code> method. (Overriding <code>hashCode()</code>
+ implies that the object's identity is based on criteria more complicated
+ than simple reference equality.)</p>
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<p><pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre></p>
+
+
+<h3><a name="HE_INHERITS_EQUALS_USE_HASHCODE">HE: Class inherits equals() and uses Object.hashCode() (HE_INHERITS_EQUALS_USE_HASHCODE)</a></h3>
+
+
+ <p> This class inherits <code>equals(Object)</code> from an abstract
+ superclass, and <code>hashCode()</code> from
+<code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+ <p>If you don't want to define a hashCode method, and/or don't
+ believe the object will ever be put into a HashMap/Hashtable,
+ define the <code>hashCode()</code> method
+ to throw <code>UnsupportedOperationException</code>.</p>
+
+
+<h3><a name="IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION">IC: Superclass uses subclass during initialization (IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION)</a></h3>
+
+
+ <p> During the initialization of a class, the class makes an active use of a subclass.
+That subclass will not yet be initialized at the time of this use.
+For example, in the following code, <code>foo</code> will be null.</p>
+
+<pre>
+public class CircularClassInitialization {
+ static class InnerClassSingleton extends CircularClassInitialization {
+ static InnerClassSingleton singleton = new InnerClassSingleton();
+ }
+
+ static CircularClassInitialization foo = InnerClassSingleton.singleton;
+}
+</pre>
+
+
+
+<h3><a name="IMSE_DONT_CATCH_IMSE">IMSE: Dubious catching of IllegalMonitorStateException (IMSE_DONT_CATCH_IMSE)</a></h3>
+
+
+<p>IllegalMonitorStateException is generally only
+ thrown in case of a design flaw in your code (calling wait or
+ notify on an object you do not hold a lock on).</p>
+
+
+<h3><a name="ISC_INSTANTIATE_STATIC_CLASS">ISC: Needless instantiation of class that only supplies static methods (ISC_INSTANTIATE_STATIC_CLASS)</a></h3>
+
+
+<p> This class allocates an object that is based on a class that only supplies static methods. This object
+does not need to be created, just access the static methods directly using the class name as a qualifier.</p>
+
+
+<h3><a name="IT_NO_SUCH_ELEMENT">It: Iterator next() method can't throw NoSuchElement exception (IT_NO_SUCH_ELEMENT)</a></h3>
+
+
+ <p> This class implements the <code>java.util.Iterator</code> interface.
+ However, its <code>next()</code> method is not capable of throwing
+ <code>java.util.NoSuchElementException</code>. The <code>next()</code>
+ method should be changed so it throws <code>NoSuchElementException</code>
+ if is called when there are no more elements to return.</p>
+
+
+<h3><a name="J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION">J2EE: Store of non serializable object into HttpSession (J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION)</a></h3>
+
+
+<p>
+This code seems to be storing a non-serializable object into an HttpSession.
+If this session is passivated or migrated, an error will result.
+</p>
+
+
+<h3><a name="NP_CLONE_COULD_RETURN_NULL">NP: Clone method may return null (NP_CLONE_COULD_RETURN_NULL)</a></h3>
+
+
+ <p>
+ This clone method seems to return null in some circumstances, but clone is never
+ allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError
+ instead.
+ </p>
+
+
+<h3><a name="NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT">NP: equals() method does not check for null argument (NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT)</a></h3>
+
+
+ <p>
+ This implementation of equals(Object) violates the contract defined
+ by java.lang.Object.equals() because it does not check for null
+ being passed as the argument. All equals() methods should return
+ false if passed a null value.
+ </p>
+
+
+<h3><a name="NP_TOSTRING_COULD_RETURN_NULL">NP: toString method may return null (NP_TOSTRING_COULD_RETURN_NULL)</a></h3>
+
+
+ <p>
+ This toString method seems to return null in some circumstances. A liberal reading of the
+ spec could be interpreted as allowing this, but it is probably a bad idea and could cause
+ other code to break. Return the empty string or some other appropriate string rather than null.
+ </p>
+
+
+<h3><a name="NM_CLASS_NAMING_CONVENTION">Nm: Class names should start with an upper case letter (NM_CLASS_NAMING_CONVENTION)</a></h3>
+
+
+ <p> Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).
+</p>
+
+
+<h3><a name="NM_CLASS_NOT_EXCEPTION">Nm: Class is not derived from an Exception, even though it is named as such (NM_CLASS_NOT_EXCEPTION)</a></h3>
+
+
+<p> This class is not derived from another exception, but ends with 'Exception'. This will
+be confusing to users of this class.</p>
+
+
+<h3><a name="NM_CONFUSING">Nm: Confusing method names (NM_CONFUSING)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.</p>
+
+
+<h3><a name="NM_FIELD_NAMING_CONVENTION">Nm: Field names should start with an lower case letter (NM_FIELD_NAMING_CONVENTION)</a></h3>
+
+
+ <p>
+Names of fields that are not final should be in mixed case with a lowercase first letter and the first letters of subsequent words capitalized.
+</p>
+
+
+<h3><a name="NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER)</a></h3>
+
+
+<p>The identifier is a word that is reserversed as a keyword in later versions of Java, and your code will need to be changed
+in order to compile it in later versions of Java.</p>
+
+
+
+<h3><a name="NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER">Nm: Use of identifier that is a keyword in later versions of Java (NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER)</a></h3>
+
+
+<p>This identifier is used as a keyword in later versions of Java. This code, and
+any code that references this API,
+will need to be changed in order to compile it in later versions of Java.</p>
+
+
+
+<h3><a name="NM_METHOD_NAMING_CONVENTION">Nm: Method names should start with an lower case letter (NM_METHOD_NAMING_CONVENTION)</a></h3>
+
+
+ <p>
+Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.
+</p>
+
+
+<h3><a name="NM_SAME_SIMPLE_NAME_AS_INTERFACE">Nm: Class names shouldn't shadow simple name of implemented interface (NM_SAME_SIMPLE_NAME_AS_INTERFACE)</a></h3>
+
+
+ <p> This class/interface has a simple name that is identical to that of an implemented/extended interface, except
+that the interface is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
+
+
+<h3><a name="NM_SAME_SIMPLE_NAME_AS_SUPERCLASS">Nm: Class names shouldn't shadow simple name of superclass (NM_SAME_SIMPLE_NAME_AS_SUPERCLASS)</a></h3>
+
+
+ <p> This class has a simple name that is identical to that of its superclass, except
+that its superclass is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
+
+
+<h3><a name="NM_VERY_CONFUSING_INTENTIONAL">Nm: Very confusing method names (NM_VERY_CONFUSING_INTENTIONAL)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other. From the existence of other methods, it
+seems that the existence of both of these methods is intentional, but is sure is confusing.
+You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.
+</p>
+
+
+<h3><a name="NM_WRONG_PACKAGE_INTENTIONAL">Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE_INTENTIONAL)</a></h3>
+
+
+ <p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+ public int f(alpha.Foo x) { return 27; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
+
+<p>In this case, the subclass does define a method with a signature identical to the method in the superclass,
+so this is presumably understood. However, such methods are exceptionally confusing. You should strongly consider
+removing or deprecating the method with the similar but not identical signature.
+</p>
+
+
+<h3><a name="ODR_OPEN_DATABASE_RESOURCE">ODR: Method may fail to close database resource (ODR_OPEN_DATABASE_RESOURCE)</a></h3>
+
+
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.
+</p>
+
+
+<h3><a name="ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH">ODR: Method may fail to close database resource on exception (ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH)</a></h3>
+
+
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all exception paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.</p>
+
+
+<h3><a name="OS_OPEN_STREAM">OS: Method may fail to close stream (OS_OPEN_STREAM)</a></h3>
+
+
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods that might close it,
+or return it, and does not appear to close
+the stream on all paths out of the method. This may result in
+a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
+
+
+<h3><a name="OS_OPEN_STREAM_EXCEPTION_PATH">OS: Method may fail to close stream on exception (OS_OPEN_STREAM_EXCEPTION_PATH)</a></h3>
+
+
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+it on all possible exception paths out of the method.
+This may result in a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
+
+
+<h3><a name="RC_REF_COMPARISON">RC: Suspicious reference comparison (RC_REF_COMPARISON)</a></h3>
+
+
+<p> This method compares two reference values using the == or != operator,
+where the correct way to compare instances of this type is generally
+with the equals() method. Examples of classes which should generally
+not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>
+
+
+<h3><a name="RR_NOT_CHECKED">RR: Method ignores results of InputStream.read() (RR_NOT_CHECKED)</a></h3>
+
+
+ <p> This method ignores the return value of one of the variants of
+ <code>java.io.InputStream.read()</code> which can return multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were read than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ reads from input streams usually do read the full amount of data requested,
+ causing the program to fail only sporadically.</p>
+
+
+<h3><a name="SR_NOT_CHECKED">RR: Method ignores results of InputStream.skip() (SR_NOT_CHECKED)</a></h3>
+
+
+ <p> This method ignores the return value of
+ <code>java.io.InputStream.skip()</code> which can skip multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were skipped than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ skips from input streams usually do skip the full amount of data requested,
+ causing the program to fail only sporadically. With Buffered streams, however,
+ skip() will only skip data in the buffer, and will routinely fail to skip the
+ requested number of bytes.</p>
+
+
+<h3><a name="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE">RV: Method ignores return value (RV_RETURN_VALUE_IGNORED_BAD_PRACTICE)</a></h3>
+
+
+ <p> This method returns a value that is not checked. For
+example, the <code>File.delete()</code> method returns false
+if the file could not be successfully deleted (rather than
+throwing an Exception).
+If you don't check the result, you won't notice if the method invocation
+signals unexpected behavior by returning an atypical return value.
+
+
+<h3><a name="SI_INSTANCE_BEFORE_FINALS_ASSIGNED">SI: Static initializer creates instance before all static final fields assigned (SI_INSTANCE_BEFORE_FINALS_ASSIGNED)</a></h3>
+
+
+<p> The class's static initializer creates an instance of the class
+before all of the static final fields are assigned.</p>
+
+
+<h3><a name="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE">SQL: Nonconstant string passed to execute method on an SQL statement (SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE)</a></h3>
+
+
+ <p>The method invokes the execute method on an SQL statement with a String that seems
+to be dynamically generated. Consider using
+a prepared statement instead. It is more efficient and less vulnerable to
+SQL injection attacks.
+</p>
+
+
+<h3><a name="SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING">SQL: A prepared statement is generated from a nonconstant String (SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING)</a></h3>
+
+
+ <p>The code creates an SQL prepared statement from a nonconstant String.
+If unchecked, tainted data from a user is used in building this String, SQL injection could
+be used to make the prepared statement do something unexpected and undesirable.
+</p>
+
+
+<h3><a name="SW_SWING_METHODS_INVOKED_IN_SWING_THREAD">SW: Certain swing methods needs to be invoked in Swing thread (SW_SWING_METHODS_INVOKED_IN_SWING_THREAD)</a></h3>
+
+
+<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods
+show(), setVisible(), and pack() will create the associated peer for the frame.
+With the creation of the peer, the system creates the event dispatch thread.
+This makes things problematic because the event dispatch thread could be notifying
+listeners while pack and validate are still processing. This situation could result in
+two threads going through the Swing component-based GUI -- it's a serious flaw that
+could result in deadlocks or other related threading issues. A pack call causes
+components to be realized. As they are being realized (that is, not necessarily
+visible), they could trigger listener notification on the event dispatch thread.</p>
+
+
+
+<h3><a name="SE_BAD_FIELD">Se: Non-transient non-serializable instance field in serializable class (SE_BAD_FIELD)</a></h3>
+
+
+<p> This Serializable class defines a non-primitive instance field which is neither transient,
+Serializable, or <code>java.lang.Object</code>, and does not appear to implement
+the <code>Externalizable</code> interface or the
+<code>readObject()</code> and <code>writeObject()</code> methods.
+Objects of this class will not be deserialized correctly if a non-Serializable
+object is stored in this field.</p>
+
+
+<h3><a name="SE_BAD_FIELD_INNER_CLASS">Se: Non-serializable class has a serializable inner class (SE_BAD_FIELD_INNER_CLASS)</a></h3>
+
+
+<p> This Serializable class is an inner class of a non-serializable class.
+Thus, attempts to serialize it will also attempt to associate instance of the outer
+class with which it is associated, leading to a runtime error.
+</p>
+<p>If possible, making the inner class a static inner class should solve the
+problem. Making the outer class serializable might also work, but that would
+mean serializing an instance of the inner class would always also serialize the instance
+of the outer class, which it often not what you really want.
+
+
+<h3><a name="SE_BAD_FIELD_STORE">Se: Non-serializable value stored into instance field of a serializable class (SE_BAD_FIELD_STORE)</a></h3>
+
+
+<p> A non-serializable value is stored into a non-transient field
+of a serializable class.</p>
+
+
+<h3><a name="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE">Se: Comparator doesn't implement Serializable (SE_COMPARATOR_SHOULD_BE_SERIALIZABLE)</a></h3>
+
+
+ <p> This class implements the <code>Comparator</code> interface. You
+should consider whether or not it should also implement the <code>Serializable</code>
+interface. If a comparator is used to construct an ordered collection
+such as a <code>TreeMap</code>, then the <code>TreeMap</code>
+will be serializable only if the comparator is also serializable.
+As most comparators have little or no state, making them serializable
+is generally easy and good defensive programming.
+</p>
+
+
+<h3><a name="SE_INNER_CLASS">Se: Serializable inner class (SE_INNER_CLASS)</a></h3>
+
+
+<p> This Serializable class is an inner class. Any attempt to serialize
+it will also serialize the associated outer instance. The outer instance is serializable,
+so this won't fail, but it might serialize a lot more data than intended.
+If possible, making the inner class a static inner class (also known as a nested class) should solve the
+problem.
+
+
+<h3><a name="SE_METHOD_MUST_BE_PRIVATE">Se: Method must be private in order for serialization to work (SE_METHOD_MUST_BE_PRIVATE)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface, and defines a method
+ for custom serialization/deserialization. But since that method isn't declared private,
+ it will be silently ignored by the serialization/deserialization API.</p>
+
+
+<h3><a name="SE_NONFINAL_SERIALVERSIONID">Se: serialVersionUID isn't final (SE_NONFINAL_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not final.
+ The field should be made final
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NONLONG_SERIALVERSIONID">Se: serialVersionUID isn't long (SE_NONLONG_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not long.
+ The field should be made long
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NONSTATIC_SERIALVERSIONID">Se: serialVersionUID isn't static (SE_NONSTATIC_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class defines a <code>serialVersionUID</code> field that is not static.
+ The field should be made static
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
+
+
+<h3><a name="SE_NO_SUITABLE_CONSTRUCTOR">Se: Class is Serializable but its superclass doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface
+ and its superclass does not. When such an object is deserialized,
+ the fields of the superclass need to be initialized by
+ invoking the void constructor of the superclass.
+ Since the superclass does not have one,
+ serialization and deserialization will fail at runtime.</p>
+
+
+<h3><a name="SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION">Se: Class is Externalizable but doesn't define a void constructor (SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION)</a></h3>
+
+
+ <p> This class implements the <code>Externalizable</code> interface, but does
+ not define a void constructor. When Externalizable objects are deserialized,
+ they first need to be constructed by invoking the void
+ constructor. Since this class does not have one,
+ serialization and deserialization will fail at runtime.</p>
+
+
+<h3><a name="SE_READ_RESOLVE_MUST_RETURN_OBJECT">Se: The readResolve method must be declared with a return type
+of Object. (SE_READ_RESOLVE_MUST_RETURN_OBJECT)</a></h3>
+
+
+ <p> In order for the readResolve method to be recognized by the serialization
+mechanism.
+</p>
+
+
+<h3><a name="SE_TRANSIENT_FIELD_NOT_RESTORED">Se: Transient field that isn't set by deserialization. (SE_TRANSIENT_FIELD_NOT_RESTORED)</a></h3>
+
+
+ <p> This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any
+deserialized instance of the class.
+</p>
+
+
+<h3><a name="SE_NO_SERIALVERSIONID">SnVI: Class is Serializable, but doesn't define serialVersionUID (SE_NO_SERIALVERSIONID)</a></h3>
+
+
+ <p> This class implements the <code>Serializable</code> interface, but does
+ not define a <code>serialVersionUID</code> field.
+ A change as simple as adding a reference to a .class object
+ will add synthetic fields to the class,
+ which will unfortunately change the implicit
+ serialVersionUID (e.g., adding a reference to <code>String.class</code>
+ will generate a static field <code>class$java$lang$String</code>).
+ Also, different source code to bytecode compilers may use different
+ naming conventions for synthetic variables generated for
+ references to class objects or inner classes.
+ To ensure interoperability of Serializable across versions,
+ consider adding an explicit serialVersionUID.</p>
+
+
+<h3><a name="UI_INHERITANCE_UNSAFE_GETRESOURCE">UI: Usage of GetResource may be unsafe if class is extended (UI_INHERITANCE_UNSAFE_GETRESOURCE)</a></h3>
+
+
+<p>Calling <code>this.getClass().getResource(...)</code> could give
+results other than expected if this class is extended by a class in
+another package.</p>
+
+
+<h3><a name="BC_IMPOSSIBLE_CAST">BC: Impossible cast (BC_IMPOSSIBLE_CAST)</a></h3>
+
+
+<p>
+This cast will always throw a ClassCastException.
+</p>
+
+
+<h3><a name="BC_IMPOSSIBLE_INSTANCEOF">BC: instanceof will always return false (BC_IMPOSSIBLE_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return false. Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="BIT_AND">BIT: Incompatible bit masks (BIT_AND)</a></h3>
+
+
+<p> This method compares an expression of the form (a & C) to D,
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
+
+
+<h3><a name="BIT_AND_ZZ">BIT: Check to see if ((...) & 0) == 0 (BIT_AND_ZZ)</a></h3>
+
+
+<p> This method compares an expression of the form (a & 0) to 0,
+which will always compare equal.
+This may indicate a logic error or typo.</p>
+
+
+<h3><a name="BIT_IOR">BIT: Incompatible bit masks (BIT_IOR)</a></h3>
+
+
+<p> This method compares an expression of the form (a | C) to D.
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
+
+<p> Typically, this bug occurs because the code wants to perform
+a membership test in a bit set, but uses the bitwise OR
+operator ("|") instead of bitwise AND ("&").</p>
+
+
+<h3><a name="BIT_IOR_OF_SIGNED_BYTE">BIT: Bitwise OR of signed byte value (BIT_IOR_OF_SIGNED_BYTE)</a></h3>
+
+
+<p> Loads a value from a byte array and performs a bitwise OR with
+that value. Values loaded from a byte array are sign extended to 32 bits
+before any any bitwise operations are performed on the value.
+Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
+<code>x</code> is initially 0, then the code
+<code>((x << 8) | b[0])</code> will sign extend <code>0xff</code>
+to get <code>0xffffffff</code>, and thus give the value
+<code>0xffffffff</code> as the result.
+</p>
+
+<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
+<code>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | b[i]);
+</code>
+
+<p>The following idiom will work instead: </p>
+<code>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | (b[i] &s; 0xff));
+</code>
+
+
+
+<h3><a name="BIT_SIGNED_CHECK_HIGH_BIT">BIT: Check for sign of bitwise operation (BIT_SIGNED_CHECK_HIGH_BIT)</a></h3>
+
+
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
+
+
+<h3><a name="BOA_BADLY_OVERRIDDEN_ADAPTER">BOA: Class overrides a method implemented in super class Adapter wrongly (BOA_BADLY_OVERRIDDEN_ADAPTER)</a></h3>
+
+
+<p> This method overrides a method found in a parent class, where that class is an Adapter that implements
+a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not
+get called when the event occurs.</p>
+
+
+<h3><a name="BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR">Bx: Primitive value is unboxed and coerced for ternary operator (BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR)</a></h3>
+
+
+ <p>A wrapped primative value is unboxed and converted to another primative type as part of the
+evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The
+semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped
+numeric values, the values are unboxed and converted/coerced to their common type (e.g,
+if <code>e1</code> is of type <code>Integer</code>
+and <code>e2</code> is of type <code>Float</code>, then <code>e1</code> is unboxed,
+converted to a floating point value, and boxed. See JLS Section 15.25.
+</p>
+
+
+<h3><a name="DLS_DEAD_STORE_OF_CLASS_LITERAL">DLS: Dead store of class literal (DLS_DEAD_STORE_OF_CLASS_LITERAL)</a></h3>
+
+
+<p>
+This instruction assigns a class literal to a variable and then never uses it.
+<a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">The behavior of this differs in Java 1.4 and in Java 5.</a>
+In Java 1.4 and earlier, a reference to <code>Foo.class</code> would force the static initializer
+for <code>Foo</code> to be executed, if it has not been executed already.
+In Java 5 and later, it does not.
+</p>
+<p>See Sun's <a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">article on Java SE compatibility</a>
+for more details and examples, and suggestions on how to force class initialization in Java 5.
+</p>
+
+
+<h3><a name="DLS_OVERWRITTEN_INCREMENT">DLS: Overwritten increment (DLS_OVERWRITTEN_INCREMENT)</a></h3>
+
+
+<p>
+The code performs an increment operation (e.g., <code>i++</code>) and then
+immediately overwrites it. For example, <code>i = i++</code> immediately
+overwrites the incremented value with the original value.
+</p>
+
+
+<h3><a name="DMI_BAD_MONTH">DMI: Bad constant value for month (DMI_BAD_MONTH)</a></h3>
+
+
+<p>
+This code passes a constant month
+value outside the expected range of 0..11 to a method.
+</p>
+
+
+<h3><a name="DMI_CALLING_NEXT_FROM_HASNEXT">DMI: hasNext method invokes next (DMI_CALLING_NEXT_FROM_HASNEXT)</a></h3>
+
+
+<p>
+The hasNext() method invokes the next() method. This is almost certainly wrong,
+since the hasNext() method is not supposed to change the state of the iterator,
+and the next method is supposed to change the state of the iterator.
+</p>
+
+
+<h3><a name="DMI_INVOKING_TOSTRING_ON_ARRAY">DMI: Invocation of toString on an array (DMI_INVOKING_TOSTRING_ON_ARRAY)</a></h3>
+
+
+<p>
+The code invokes toString on an array, which will generate a fairly useless result
+such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
+String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
+</p>
+
+
+<h3><a name="DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT">DMI: Double.longBitsToDouble invoked on an int (DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT)</a></h3>
+
+
+<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed
+ as an argument. This almostly certainly is not intended and is unlikely
+ to give the intended result.
+</p>
+
+
+<h3><a name="DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION">Dm: Can't use reflection to check for presence of annotation with default retention (DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION)</a></h3>
+
+
+ <p> Unless an annotation has itself been annotated with a @Retention other than the default
+of source-only retention, the annotation isn't retained in the classfile and can't be observed using reflection
+ (e.g., by using the isAnnotationPresent method).
+ .</p>
+
+
+<h3><a name="EC_ARRAY_AND_NONARRAY">EC: equals() used to compare array and nonarray (EC_ARRAY_AND_NONARRAY)</a></h3>
+
+
+<p>
+This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem
+to be an array. If things being compared are of different types, they are guaranteed to be unequal
+and the comparison is almost certainly an error. Even if they are both arrays, the equals method
+on arrays only determines of the two arrays are the same object.
+To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
+
+
+<h3><a name="EC_BAD_ARRAY_COMPARE">EC: Invocation of equals() on an array, which is equivalent to == (EC_BAD_ARRAY_COMPARE)</a></h3>
+
+
+<p>
+This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals
+method of Object, calling equals on an array is the same as comparing their addresses. To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
+
+
+<h3><a name="EC_NULL_ARG">EC: Call to equals() with null argument (EC_NULL_ARG)</a></h3>
+
+
+<p> This method calls equals(Object), passing a null value as
+the argument. According to the contract of the equals() method,
+this call should always return <code>false</code>.</p>
+
+
+<h3><a name="EC_UNRELATED_CLASS_AND_INTERFACE">EC: Call to equals() comparing unrelated class and interface (EC_UNRELATED_CLASS_AND_INTERFACE)</a></h3>
+
+
+<p>
+This method calls equals(Object) on two references, one of which is a class
+and the other an interface, where neither the class nor any of its
+non-abstract subclasses implement the interface.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_INTERFACES">EC: Call to equals() comparing different interface types (EC_UNRELATED_INTERFACES)</a></h3>
+
+
+<p> This method calls equals(Object) on two references of unrelated
+interface types, where neither is a subtype of the other,
+and there are no known non-abstract classes which implement both interfaces.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_TYPES">EC: Call to equals() comparing different types (EC_UNRELATED_TYPES)</a></h3>
+
+
+<p> This method calls equals(Object) on two references of different
+class types with no common subclasses.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EC_UNRELATED_TYPES_USING_POINTER_EQUALITY">EC: Using pointer equality to compare different types (EC_UNRELATED_TYPES_USING_POINTER_EQUALITY)</a></h3>
+
+
+<p> This method uses using pointer equality to compare two references that seem to be of
+different types. The result of this comparison will always be false at runtime.
+</p>
+
+
+<h3><a name="EQ_DONT_DEFINE_EQUALS_FOR_ENUM">Eq: Covariant equals() method defined for enum (EQ_DONT_DEFINE_EQUALS_FOR_ENUM)</a></h3>
+
+
+ <p> This class defines an enumeration, and equality on enumerations are defined
+using object identity. Definine a covariant equals method for an enumeration
+value is exceptionally bad practice, since it would likely result
+in having two different enumeration values that compare as equals using
+the covariant enum method, and as not equal when compared normally.
+Don't do it.
+</p>
+
+
+<h3><a name="EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC">Eq: equals method overrides equals in superclass and may not be symmetric (EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC)</a></h3>
+
+
+ <p> This class defines an equals method that overrides an equals method in a superclass. Both equals methods
+methods use <code>instanceof</code> in the determination of whether two objects are equals. This is fraught with peril,
+since it is important that the equals method is symetrical (in other words, <code>a.equals(b) == b.equals(a)</code>).
+If B is a subtype of A, and A's equals method checks that the argument is an instanceof A, and B's equals method
+checks that the argument is an instanceof B, it is quite likely that the equivalence relation defined by these
+methods is not symmetric.
+
+
+<h3><a name="FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER">FE: Doomed test for equality to NaN (FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER)</a></h3>
+
+
+ <p>
+ This code checks to see if a floating point value is equal to the special
+ Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However,
+ because of the special semantics of <code>NaN</code>, no value
+ is equal to <code>Nan</code>, including <code>NaN</code>. Thus,
+ <code>x == Double.NaN</code> always evaluates to false.
+
+ To check to see if a value contained in <code>x</code>
+ is the special Not A Number value, use
+ <code>Double.isNaN(x)</code> (or <code>Float.isNaN(x)</code> if
+ <code>x</code> is floating point precision).
+ </p>
+
+
+<h3><a name="GC_UNRELATED_TYPES">GC: No relationship between generic parameter and method argument (GC_UNRELATED_TYPES)</a></h3>
+
+
+ <p> This call to a generic container's method contains an argument
+ with a different class type from that of the container's parameter.
+ Therefore, it is unlikely that the container contains any objects
+ with the same type as the method argument used here.
+ </p>
+
+
+<h3><a name="HE_USE_OF_UNHASHABLE_CLASS">HE: Use of class without a hashCode() method in a hashed data structure (HE_USE_OF_UNHASHABLE_CLASS)</a></h3>
+
+
+ <p> A class defines an equals(Object) method but not a hashCode() method,
+and thus doesn't fulfill the requirement that equal Objects have equal hashCodes.
+An instance of this class is used in a hash data structure, making the need to
+fix this problem of highest importance.
+
+
+<h3><a name="ICAST_BAD_SHIFT_AMOUNT">ICAST: Integer shift by an amount not in the range 0..31 (ICAST_BAD_SHIFT_AMOUNT)</a></h3>
+
+
+<p>
+The code performs an integer shift by a constant amount outside
+the range 0..31.
+The effect of this is to use the lower 5 bits of the integer
+value to decide how much to shift by. This probably isn't want was expected,
+and it at least confusing.
+</p>
+
+
+<h3><a name="ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL">ICAST: int value cast to double and then passed to Math.ceil (ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL)</a></h3>
+
+
+<p>
+This code converts an int value to a double precision
+floating point number and then
+passing the result to the Math.ceil() function, which rounds a double to
+the next higher integer value. This operation should always be a no-op,
+since the converting an integer to a double should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.ceil was intended to be performed using double precision
+floating point arithmetic.
+</p>
+
+
+
+<h3><a name="ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND">ICAST: int value cast to float and then passed to Math.round (ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND)</a></h3>
+
+
+<p>
+This code converts an int value to a float precision
+floating point number and then
+passing the result to the Math.round() function, which returns the int/long closest
+to the argument. This operation should always be a no-op,
+since the converting an integer to a float should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.round was intended to be performed using
+floating point arithmetic.
+</p>
+
+
+
+<h3><a name="IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD">IJU: JUnit assertion in run method will not be noticed by JUnit (IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD)</a></h3>
+
+
+<p> A JUnit assertion is performed in a run method. Failed JUnit assertions
+just result in exceptions being thrown.
+Thus, if this exception occurs in a thread other than the thread that invokes
+the test method, the exception will terminate the thread but not result
+in the test failing.
+</p>
+
+
+<h3><a name="IJU_BAD_SUITE_METHOD">IJU: TestCase declares a bad suite method (IJU_BAD_SUITE_METHOD)</a></h3>
+
+
+<p> Class is a JUnit TestCase and defines a suite() method.
+However, the suite method needs to be declared as either
+<pre>public static junit.framework.Test suite()</pre>
+or
+<pre>public static junit.framework.TestSuite suite()</pre>
+</p>
+
+
+<h3><a name="IJU_NO_TESTS">IJU: TestCase has no tests (IJU_NO_TESTS)</a></h3>
+
+
+<p> Class is a JUnit TestCase but has not implemented any test methods</p>
+
+
+<h3><a name="IJU_SETUP_NO_SUPER">IJU: TestCase implements setUp but doesn't call super.setUp() (IJU_SETUP_NO_SUPER)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call
+super.setUp(), but doesn't.</p>
+
+
+<h3><a name="IJU_SUITE_NOT_STATIC">IJU: TestCase implements a non-static suite method (IJU_SUITE_NOT_STATIC)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the suite() method.
+ The suite method should be declared as being static, but isn't.</p>
+
+
+<h3><a name="IJU_TEARDOWN_NO_SUPER">IJU: TestCase implements tearDown but doesn't call super.tearDown() (IJU_TEARDOWN_NO_SUPER)</a></h3>
+
+
+<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call
+super.tearDown(), but doesn't.</p>
+
+
+<h3><a name="IL_CONTAINER_ADDED_TO_ITSELF">IL: A container is added to itself (IL_CONTAINER_ADDED_TO_ITSELF)</a></h3>
+
+
+<p>A container is added to itself. As a result, computing the hashCode of this
+set will throw a StackOverflowException.
+</p>
+
+
+<h3><a name="IL_INFINITE_LOOP">IL: An apparent infinite loop (IL_INFINITE_LOOP)</a></h3>
+
+
+<p>This loop doesn't seem to have a way to terminate (other than by perhaps
+throwing an exception).</p>
+
+
+<h3><a name="IL_INFINITE_RECURSIVE_LOOP">IL: An apparent infinite recursive loop (IL_INFINITE_RECURSIVE_LOOP)</a></h3>
+
+
+<p>This method unconditionally invokes itself. This would seem to indicate
+an infinite recursive loop that will result in a stack overflow.</p>
+
+
+<h3><a name="IM_MULTIPLYING_RESULT_OF_IREM">IM: Integer multiply of result of integer remainder (IM_MULTIPLYING_RESULT_OF_IREM)</a></h3>
+
+
+<p>
+The code multiplies the result of an integer remaining by an integer constant.
+Be sure you don't have your operator precedence confused. For example
+i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000).
+</p>
+
+
+<h3><a name="INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE">INT: Bad comparison of nonnegative value with negative constant (INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE)</a></h3>
+
+
+<p> This code compares a value that is guaranteed to be non-negative with a negative constant.
+</p>
+
+
+<h3><a name="INT_BAD_COMPARISON_WITH_SIGNED_BYTE">INT: Bad comparison of signed byte (INT_BAD_COMPARISON_WITH_SIGNED_BYTE)</a></h3>
+
+
+<p> Signed bytes can only have a value in the range -128 to 127. Comparing
+a signed byte with a value outside that range is vacuous and likely to be incorrect.
+To convert a signed byte <code>b</code> to an unsigned value in the range 0..255,
+use <code>0xff & b</code>
+</p>
+
+
+<h3><a name="INT_BAD_REM_BY_1">INT: Integer remainder modulo 1 (INT_BAD_REM_BY_1)</a></h3>
+
+
+<p> Any expression (exp % 1) is guaranteed to always return zero.
+Did you mean (exp & 1) or (exp % 2) instead?
+</p>
+
+
+<h3><a name="IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN">IP: A parameter is dead upon entry to a method but overwritten (IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN)</a></h3>
+
+
+<p>
+The initial value of this parameter is ignored, and the parameter
+is overwritten here. This often indicates a mistaken belief that
+the write to the parameter will be conveyed back to
+the caller.
+</p>
+
+
+<h3><a name="JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS">JCIP: Fields of immutable classes should be final (JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS)</a></h3>
+
+
+ <p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require
+that all fields are final.
+ .</p>
+
+
+<h3><a name="MF_CLASS_MASKS_FIELD">MF: Class defines field that masks a superclass field (MF_CLASS_MASKS_FIELD)</a></h3>
+
+
+<p> This class defines a field with the same name as a visible
+instance field in a superclass. This is confusing, and
+may indicate an error if methods update or access one of
+the fields when they wanted the other.</p>
+
+
+<h3><a name="MF_METHOD_MASKS_FIELD">MF: Method defines a variable that obscures a field (MF_METHOD_MASKS_FIELD)</a></h3>
+
+
+<p> This method defines a local variable with the same name as a field
+in this class or a superclass. This may cause the method to
+read an uninitialized value from the field, leave the field uninitialized,
+or both.</p>
+
+
+<h3><a name="NP_ALWAYS_NULL">NP: Null pointer dereference (NP_ALWAYS_NULL)</a></h3>
+
+
+<p> A null pointer is dereferenced here. This will lead to a
+<code>NullPointerException</code> when the code is executed.</p>
+
+
+<h3><a name="NP_ALWAYS_NULL_EXCEPTION">NP: Null pointer dereference in method on exception path (NP_ALWAYS_NULL_EXCEPTION)</a></h3>
+
+
+<p> A pointer which is null on an exception path is dereferenced here.
+This will lead to a <code>NullPointerException</code> when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
+
+
+<h3><a name="NP_ARGUMENT_MIGHT_BE_NULL">NP: Method does not check for null argument (NP_ARGUMENT_MIGHT_BE_NULL)</a></h3>
+
+
+ <p>
+ A parameter to this method has been identified as a value that should
+ always be checked to see whether or not it is null, but it is being dereferenced
+ without a preceding null check.
+ </p>
+
+
+<h3><a name="NP_GUARANTEED_DEREF">NP: Null value is guaranteed to be dereferenced (NP_GUARANTEED_DEREF)</a></h3>
+
+
+ <p>
+ There is a statement or branch that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
+
+
+<h3><a name="NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH">NP: Value is null and guaranteed to be dereferenced on exception path (NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH)</a></h3>
+
+
+ <p>
+ There is a statement or branch on an exception path
+ that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
+
+
+<h3><a name="NP_NONNULL_PARAM_VIOLATION">NP: Method call passes null to a nonnull parameter (NP_NONNULL_PARAM_VIOLATION)</a></h3>
+
+
+ <p>
+ This method passes a null value as the parameter of a method which
+ must be nonnull. Either this parameter has been explicitly marked
+ as @Nonnull, or analysis has determined that this parameter is
+ always dereferenced.
+ </p>
+
+
+<h3><a name="NP_NONNULL_RETURN_VIOLATION">NP: Method may return null, but is declared @NonNull (NP_NONNULL_RETURN_VIOLATION)</a></h3>
+
+
+ <p>
+ This method may return a null value, but the method (or a superclass method
+ which it overrides) is declared to return @NonNull.
+ </p>
+
+
+<h3><a name="NP_NULL_INSTANCEOF">NP: A known null value is checked to see if it is an instance of a type (NP_NULL_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return false, since the value being checked is guaranteed to be null.
+Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH">NP: Possible null pointer dereference (NP_NULL_ON_SOME_PATH)</a></h3>
+
+
+<p> A reference value dereferenced here might be null at runtime.
+This may lead to a <code>NullPointerException</code> when the code is executed.</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH_EXCEPTION">NP: Possible null pointer dereference in method on exception path (NP_NULL_ON_SOME_PATH_EXCEPTION)</a></h3>
+
+
+<p> A reference value which is null on some exception control path is
+dereferenced here. This may lead to a <code>NullPointerException</code>
+when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF">NP: Method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF)</a></h3>
+
+
+ <p>
+ This method call passes a null value to a method which might
+ dereference it unconditionally.
+ </p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS">NP: Method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS)</a></h3>
+
+
+ <p>
+ A possibly-null value is passed at a call site where all known
+ target methods will unconditionally dereference it.
+ This is very likely to result in a null pointer exception.
+ </p>
+
+
+<h3><a name="NP_NULL_PARAM_DEREF_NONVIRTUAL">NP: Non-virtual method call passes null for unconditionally dereferenced parameter (NP_NULL_PARAM_DEREF_NONVIRTUAL)</a></h3>
+
+
+ <p>
+ A possibly-null value is passed to a method which unconditionally
+ dereferences it. This will almost certainly result in a null pointer exception.
+ </p>
+
+
+<h3><a name="NP_STORE_INTO_NONNULL_FIELD">NP: Store of null value into field annotated NonNull (NP_STORE_INTO_NONNULL_FIELD)</a></h3>
+
+
+<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>
+
+
+<h3><a name="NP_UNWRITTEN_FIELD">NP: Read of unwritten field (NP_UNWRITTEN_FIELD)</a></h3>
+
+
+ <p> The program is dereferencing a field that does not seem to ever have a non-null value written to it.
+Dereferencing this value will generate a null pointer exception.
+</p>
+
+
+<h3><a name="NM_BAD_EQUAL">Nm: Class defines equal(); should it be equals()? (NM_BAD_EQUAL)</a></h3>
+
+
+<p> This class defines a method <code>equal(Object)</code>. This method does
+not override the <code>equals(Object)</code> method in <code>java.lang.Object</code>,
+which is probably what was intended.</p>
+
+
+<h3><a name="NM_LCASE_HASHCODE">Nm: Class defines hashcode(); should it be hashCode()? (NM_LCASE_HASHCODE)</a></h3>
+
+
+ <p> This class defines a method called <code>hashcode()</code>. This method
+ does not override the <code>hashCode()</code> method in <code>java.lang.Object</code>,
+ which is probably what was intended.</p>
+
+
+<h3><a name="NM_LCASE_TOSTRING">Nm: Class defines tostring(); should it be toString()? (NM_LCASE_TOSTRING)</a></h3>
+
+
+ <p> This class defines a method called <code>tostring()</code>. This method
+ does not override the <code>toString()</code> method in <code>java.lang.Object</code>,
+ which is probably what was intended.</p>
+
+
+<h3><a name="NM_METHOD_CONSTRUCTOR_CONFUSION">Nm: Apparent method/constructor confusion (NM_METHOD_CONSTRUCTOR_CONFUSION)</a></h3>
+
+
+ <p> This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor.
+ If it was intended to be a constructor, remove the declaration of a void return value.
+ If you had accidently defined this method, realized the mistake, defined a proper constructor
+ but can't get rid of this method due to backwards compatibility, deprecate the method.
+</p>
+
+
+<h3><a name="NM_VERY_CONFUSING">Nm: Very confusing method names (NM_VERY_CONFUSING)</a></h3>
+
+
+ <p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other.
+</p>
+
+
+<h3><a name="NM_WRONG_PACKAGE">Nm: Method doesn't override method in superclass due to wrong package for parameter (NM_WRONG_PACKAGE)</a></h3>
+
+
+ <p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
+
+
+<h3><a name="QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT">QBA: Method assigns boolean literal in boolean expression (QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT)</a></h3>
+
+
+ <p>
+ This method assigns a literal boolean value (true or false) to a boolean variable inside
+ an if or while expression. Most probably this was supposed to be a boolean comparison using
+ ==, not an assignment using =.
+ </p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE">RCN: Nullcheck of value previously dereferenced (RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE)</a></h3>
+
+
+<p> A value is checked here to see whether it is null, but this value can't
+be null because it was previously dereferenced and if it were null a null pointer
+exception would have occurred at the earlier dereference.
+Essentially, this code and the previous dereference
+disagree as to whether this value is allowed to be null. Either the check is redundant
+or the previous dereference is erroneous.</p>
+
+
+<h3><a name="RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION">RE: Invalid syntax for regular expression (RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION)</a></h3>
+
+
+<p>
+The code here uses a regular expression that is invalid according to the syntax
+for regular expressions. This statement will throw a PatternSyntaxException when
+executed.
+</p>
+
+
+<h3><a name="RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION">RE: File.separator used for regular expression (RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION)</a></h3>
+
+
+<p>
+The code here uses <code>File.separator</code>
+where a regular expression is required. This will fail on Windows
+platforms, where the <code>File.separator</code> is a backslash, which is interpreted in a
+regular expression as an escape character. Amoung other options, you can just use
+<code>File.separatorChar=='\\' & "\\\\" : File.separator</code> instead of
+<code>File.separator</code>
+
+</p>
+
+
+<h3><a name="RE_POSSIBLE_UNINTENDED_PATTERN">RE: "." used for regular expression (RE_POSSIBLE_UNINTENDED_PATTERN)</a></h3>
+
+
+<p>
+A String function is being invoked and "." is being passed
+to a parameter that takes a regular expression as an argument. Is this what you intended?
+For example
+s.replaceAll(".", "/") will return a String in which <em>every</em>
+character has been replaced by a / character.
+</p>
+
+
+<h3><a name="RV_01_TO_INT">RV: Random value from 0 to 1 is coerced to the integer 0 (RV_01_TO_INT)</a></h3>
+
+
+ <p>A random value from 0 to 1 is being coerced to the integer value 0. You probably
+want to multiple the random value by something else before coercing it to an integer, or use the Random.nextInt(n) method.
+</p>
+
+
+<h3><a name="RV_ABSOLUTE_VALUE_OF_HASHCODE">RV: Bad attempt to compute absolute value of signed 32-bit hashcode (RV_ABSOLUTE_VALUE_OF_HASHCODE)</a></h3>
+
+
+<p> This code generates a hashcode and then computes
+the absolute value of that hashcode. If the hashcode
+is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
+
+
+<h3><a name="RV_ABSOLUTE_VALUE_OF_RANDOM_INT">RV: Bad attempt to compute absolute value of signed 32-bit random integer (RV_ABSOLUTE_VALUE_OF_RANDOM_INT)</a></h3>
+
+
+<p> This code generates a random signed integer and then computes
+the absolute value of that random integer. If the number returned by the random number
+generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
+
+
+<h3><a name="RV_DONT_JUST_NULL_CHECK_READLINE">RV: Method discards result of readLine after checking if it is nonnull (RV_DONT_JUST_NULL_CHECK_READLINE)</a></h3>
+
+
+ <p> The value returned by readLine is discarded after checking to see if the return
+value is non-null. In almost all situations, if the result is non-null, you will want
+to use that non-null value. Calling readLine again will give you a different line.</p>
+
+
+<h3><a name="RV_EXCEPTION_NOT_THROWN">RV: Exception created and dropped rather than thrown (RV_EXCEPTION_NOT_THROWN)</a></h3>
+
+
+ <p> This code creates an exception (or error) object, but doesn't do anything with it. For example,
+something like </p>
+<blockquote>
+<pre>
+if (x < 0)
+ new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
+<p>It was probably the intent of the programmer to throw the created exception:</p>
+<blockquote>
+<pre>
+if (x < 0)
+ throw new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
+
+
+<h3><a name="RV_RETURN_VALUE_IGNORED">RV: Method ignores return value (RV_RETURN_VALUE_IGNORED)</a></h3>
+
+
+ <p> The return value of this method should be checked. One common
+cause of this warning is to invoke a method on an immutable object,
+thinking that it updates the object. For example, in the following code
+fragment,</p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString.trim();
+</pre>
+</blockquote>
+<p>the programmer seems to be thinking that the trim() method will update
+the String referenced by dateString. But since Strings are immutable, the trim()
+function returns a new String value, which is being ignored here. The code
+should be corrected to: </p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString = dateString.trim();
+</pre>
+</blockquote>
+
+
+<h3><a name="SA_FIELD_DOUBLE_ASSIGNMENT">SA: Double assignment of field (SA_FIELD_DOUBLE_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a double assignment of a field; e.g.
+</p>
+<pre>
+ int x,y;
+ public void foo() {
+ x = x = 17;
+ }
+</pre>
+<p>Assigning to a field twice is useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_FIELD_SELF_ASSIGNMENT">SA: Self assignment of field (SA_FIELD_SELF_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a self assignment of a field; e.g.
+</p>
+<pre>
+ int x;
+ public void foo() {
+ x = x;
+ }
+</pre>
+<p>Such assignments are useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_FIELD_SELF_COMPARISON">SA: Self comparison of field with itself (SA_FIELD_SELF_COMPARISON)</a></h3>
+
+
+<p> This method compares a field with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
+
+
+<h3><a name="SA_FIELD_SELF_COMPUTATION">SA: Nonsensical self computation involving a field (e.g., x & x) (SA_FIELD_SELF_COMPUTATION)</a></h3>
+
+
+<p> This method performs a nonsensical computation of a field with another
+reference to the same field (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
+
+
+<h3><a name="SA_LOCAL_DOUBLE_ASSIGNMENT">SA: Double assignment of local variable (SA_LOCAL_DOUBLE_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a double assignment of a local variable; e.g.
+</p>
+<pre>
+ public void foo() {
+ int x,y;
+ x = x = 17;
+ }
+</pre>
+<p>Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.</p>
+
+
+<h3><a name="SA_LOCAL_SELF_COMPARISON">SA: Self comparison of value with itself (SA_LOCAL_SELF_COMPARISON)</a></h3>
+
+
+<p> This method compares a local variable with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
+
+
+<h3><a name="SA_LOCAL_SELF_COMPUTATION">SA: Nonsensical self computation involving a variable (e.g., x & x) (SA_LOCAL_SELF_COMPUTATION)</a></h3>
+
+
+<p> This method performs a nonsensical computation of a local variable with another
+reference to the same variable (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
+
+
+<h3><a name="SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH">SF: Dead store due to switch statement fall through (SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH)</a></h3>
+
+
+ <p> A value stored in the previous switch case is overwritten here due to a switch fall through. It is likely that
+ you forgot to put a break or return at the end of the previous case.
+</p>
+
+
+<h3><a name="SIO_SUPERFLUOUS_INSTANCEOF">SIO: Unnecessary type check done using instanceof operator (SIO_SUPERFLUOUS_INSTANCEOF)</a></h3>
+
+
+<p> Type check performed using the instanceof operator where it can be statically determined whether the object
+is of the type requested. </p>
+
+
+<h3><a name="SQL_BAD_PREPARED_STATEMENT_ACCESS">SQL: Method attempts to access a prepared statement parameter with index 0 (SQL_BAD_PREPARED_STATEMENT_ACCESS)</a></h3>
+
+
+<p> A call to a setXXX method of a prepared statement was made where the
+parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>
+
+
+<h3><a name="SQL_BAD_RESULTSET_ACCESS">SQL: Method attempts to access a result set field with index 0 (SQL_BAD_RESULTSET_ACCESS)</a></h3>
+
+
+<p> A call to getXXX or updateXXX methods of a result set was made where the
+field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
+
+
+<h3><a name="STI_INTERRUPTED_ON_CURRENTTHREAD">STI: Unneeded use of currentThread() call, to call interrupted() (STI_INTERRUPTED_ON_CURRENTTHREAD)</a></h3>
+
+
+<p>
+This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a
+static method, is more simple and clear to use Thread.interrupted().
+</p>
+
+
+<h3><a name="STI_INTERRUPTED_ON_UNKNOWNTHREAD">STI: Static Thread.interrupted() method invoked on thread instance (STI_INTERRUPTED_ON_UNKNOWNTHREAD)</a></h3>
+
+
+<p>
+This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is
+not the current thread. As the interrupted() method is static, the interrupted method will be called on a different
+object than the one the author intended.
+</p>
+
+
+<h3><a name="TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED">TQ: Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required (TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED)</a></h3>
+
+
+ <p>
+ A value specified as carrying a type qualifier annotation is
+ consumed in a location or locations requiring that the value not
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=ALWAYS
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=NEVER.
+ </p>
+
+ <p>
+ For example, say that @NonNegative is a nickname for
+ the type qualifier annotation @Negative(when=When.NEVER).
+ The following code will generate this warning because
+ the return statement requires a @NonNegative value,
+ but receives one that is marked as @Negative.
+ </p>
+ <blockquote>
+<pre>
+public @NonNegative Integer example(@Negative Integer value) {
+ return value;
+}
+</pre>
+ </blockquote>
+
+
+<h3><a name="TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK">TQ: Value that might not carry a type qualifier reaches a use requiring that type qualifier (TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK)</a></h3>
+
+
+ <p>
+ A value that might not carry a type qualifier annotation
+ reaches a use which requires that annotation.
+ </p>
+
+ <p>
+ For example, consider the following method:
+ </p>
+ <blockquote>
+<pre>
+public @Untainted Object mustReturnUntainted(Object unknown) {
+ return unknown;
+}
+</pre>
+ </blockquote>
+ <p>
+ The <code>mustReturnUntainted</code> method is required to
+ return a value carrying the @Untainted annotation,
+ but a value not known to carry that annotation is returned.
+ </p>
+
+
+<h3><a name="TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK">TQ: Unknown value reaches a use which forbids values carrying type qualifier annotation (TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK)</a></h3>
+
+
+ <p>
+ A value which might carry a type qualifier annotation reaches
+ a use which forbids values carrying that annotation.
+ </p>
+
+ <p>
+ TODO: example.
+ </p>
+
+
+<h3><a name="TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED">TQ: Value annotated as never carrying a type qualifier used where value carrying that qualifier is required (TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED)</a></h3>
+
+
+ <p>
+ A value specified as not carrying a type qualifier annotation is guaranteed
+ to be consumed in a location or locations requiring that the value does
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=NEVER
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=ALWAYS.
+ </p>
+
+ <p>
+ TODO: example
+ </p>
+
+
+<h3><a name="UCF_USELESS_CONTROL_FLOW_NEXT_LINE">UCF: Useless control flow to next line (UCF_USELESS_CONTROL_FLOW_NEXT_LINE)</a></h3>
+
+
+<p> This method contains a useless control flow statement in which control
+flow follows to the same or following line regardless of whether or not
+the branch is taken.
+Often, this is caused by inadvertently using an empty statement as the
+body of an <code>if</code> statement, e.g.:</p>
+<pre>
+ if (argv.length == 1);
+ System.out.println("Hello, " + argv[0]);
+</pre>
+
+
+<h3><a name="UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS">UMAC: Uncallable method defined in anonymous class (UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS)</a></h3>
+
+
+<p> This anonymous class defined a method that is not directly invoked and does not override
+a method in a superclass. Since methods in other classes cannot directly invoke methods
+declared in an anonymous class, it seems that this method is uncallable. The method
+might simply be dead code, but it is also possible that the method is intended to
+override a method declared in a superclass, and due to an typo or other error the method does not,
+in fact, override the method it is intended to.
+</p>
+
+
+<h3><a name="UR_UNINIT_READ">UR: Uninitialized read of field in constructor (UR_UNINIT_READ)</a></h3>
+
+
+ <p> This constructor reads a field which has not yet been assigned a value.
+ This is often caused when the programmer mistakenly uses the field instead
+ of one of the constructor's parameters.</p>
+
+
+<h3><a name="UWF_NULL_FIELD">UwF: Field only ever set to null (UWF_NULL_FIELD)</a></h3>
+
+
+ <p> All writes to this field are of the constant value null, and thus
+all reads of the field will return null.
+Check for errors, or remove it if it is useless.</p>
+
+
+<h3><a name="UWF_UNWRITTEN_FIELD">UwF: Unwritten field (UWF_UNWRITTEN_FIELD)</a></h3>
+
+
+ <p> This field is never written. All reads of it will return the default
+value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>
+
+
+<h3><a name="VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG">VA: Primitive array passed to function expecting a variable number of object arguments (VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG)</a></h3>
+
+
+<p>
+This code passes a primitive array to a function that takes a variable number of object arguments.
+This creates an array of length one to hold the primitive array and passes it to the function.
+</p>
+
+
+<h3><a name="DM_CONVERT_CASE">Dm: Consider using Locale parameterized version of invoked method (DM_CONVERT_CASE)</a></h3>
+
+
+ <p> A String is being converted to upper or lowercase, using the platform's default encoding. This may
+ result in improper conversions when used with international characters. Use the </p>
+ <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table>
+ <p>versions instead.</p>
+
+
+<h3><a name="EI_EXPOSE_REP">EI: May expose internal representation by returning reference to mutable object (EI_EXPOSE_REP)</a></h3>
+
+
+ <p> Returning a reference to a mutable object value stored in one of the object's fields
+ exposes the internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Returning a new copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="EI_EXPOSE_REP2">EI2: May expose internal representation by incorporating reference to mutable object (EI_EXPOSE_REP2)</a></h3>
+
+
+ <p> This code stores a reference to an externally mutable object into the
+ internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="FI_PUBLIC_SHOULD_BE_PROTECTED">FI: Finalizer should be protected, not public (FI_PUBLIC_SHOULD_BE_PROTECTED)</a></h3>
+
+
+ <p> A class's <code>finalize()</code> method should have protected access,
+ not public.</p>
+
+
+<h3><a name="EI_EXPOSE_STATIC_REP2">MS: May expose internal static state by storing a mutable object into a static field (EI_EXPOSE_STATIC_REP2)</a></h3>
+
+
+ <p> This code stores a reference to an externally mutable object into a static
+ field.
+ If unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
+
+
+<h3><a name="MS_CANNOT_BE_FINAL">MS: Field isn't final and can't be protected from malicious code (MS_CANNOT_BE_FINAL)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ Unfortunately, the way the field is used doesn't allow
+ any easy fix to this problem.</p>
+
+
+<h3><a name="MS_EXPOSE_REP">MS: Public static method may expose internal representation by returning array (MS_EXPOSE_REP)</a></h3>
+
+
+ <p> A public static method returns a reference to
+ an array that is part of the static state of the class.
+ Any code that calls this method can freely modify
+ the underlying array.
+ One fix is to return a copy of the array.</p>
+
+
+<h3><a name="MS_FINAL_PKGPROTECT">MS: Field should be both final and package protected (MS_FINAL_PKGPROTECT)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made package protected and/or made final
+ to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_MUTABLE_ARRAY">MS: Field is a mutable array (MS_MUTABLE_ARRAY)</a></h3>
+
+
+<p> A final static field references an array
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the array.</p>
+
+
+<h3><a name="MS_MUTABLE_HASHTABLE">MS: Field is a mutable Hashtable (MS_MUTABLE_HASHTABLE)</a></h3>
+
+
+ <p>A final static field references a Hashtable
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the Hashtable.</p>
+
+
+<h3><a name="MS_OOI_PKGPROTECT">MS: Field should be moved out of an interface and made package protected (MS_OOI_PKGPROTECT)</a></h3>
+
+
+<p>
+ A final static field that is
+defined in an interface references a mutable
+ object such as an array or hashtable.
+ This mutable object could
+ be changed by malicious code or
+ by accident from another package.
+ To solve this, the field needs to be moved to a class
+ and made package protected
+ to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_PKGPROTECT">MS: Field should be package protected (MS_PKGPROTECT)</a></h3>
+
+
+ <p> A mutable static field could be changed by malicious code or
+ by accident.
+ The field could be made package protected to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="MS_SHOULD_BE_FINAL">MS: Field isn't final but should be (MS_SHOULD_BE_FINAL)</a></h3>
+
+
+ <p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made final to avoid
+ this vulnerability.</p>
+
+
+<h3><a name="DC_DOUBLECHECK">DC: Possible double check of field (DC_DOUBLECHECK)</a></h3>
+
+
+ <p> This method may contain an instance of double-checked locking.
+ This idiom is not correct according to the semantics of the Java memory
+ model. For more information, see the web page
+ <a href="http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html"
+ >http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html</a>.</p>
+
+
+<h3><a name="DL_SYNCHRONIZATION_ON_SHARED_CONSTANT">DL: Synchronization on shared constant could lead to deadlock (DL_SYNCHRONIZATION_ON_SHARED_CONSTANT)</a></h3>
+
+
+ <p> The code synchronizes on a shared primative constant, such as an interned String.
+<pre>
+private static String LOCK = "LOCK";
+...
+ synchronized(LOCK) { ...}
+...
+</pre>
+</p>
+<p>Such constants an interned and shared across all other classes loaded by the JVM. Thus, this could
+is locking on something that other code might also be locking. This could result in very strange and hard to diagnose
+blocking and deadlock behavior. See <a href="http://www.javalobby.org/java/forums/t96352.html">http://www.javalobby.org/java/forums/t96352.html</a> and <a href="http://jira.codehaus.org/browse/JETTY-352">http://jira.codehaus.org/browse/JETTY-352</a>.
+</p>
+
+
+<h3><a name="DM_MONITOR_WAIT_ON_CONDITION">Dm: Monitor wait() called on Condition (DM_MONITOR_WAIT_ON_CONDITION)</a></h3>
+
+
+ <p>
+ This method calls <code>wait()</code> on a
+ <code>java.util.concurrent.locks.Condition</code> object.
+ Waiting for a <code>Condition</code> should be done using one of the <code>await()</code>
+ methods defined by the <code>Condition</code> interface.
+ </p>
+
+
+<h3><a name="DM_USELESS_THREAD">Dm: A thread was created using the default empty run method (DM_USELESS_THREAD)</a></h3>
+
+
+ <p>This method creates a thread without specifying a run method either by deriving from the Thread class, or
+ by passing a Runnable object. This thread, then, does nothing but waste time.
+</p>
+
+
+<h3><a name="ESync_EMPTY_SYNC">ESync: Empty synchronized block (ESync_EMPTY_SYNC)</a></h3>
+
+
+ <p> The code contains an empty synchronized block:</p>
+<pre>
+synchronized() {}
+</pre>
+<p>Empty synchronized blocks are far more subtle and hard to use correctly
+than most people recognize, and empty synchronized blocks
+are almost never a better solution
+than less contrived solutions.
+</p>
+
+
+<h3><a name="IS2_INCONSISTENT_SYNC">IS: Inconsistent synchronization (IS2_INCONSISTENT_SYNC)</a></h3>
+
+
+ <p> The fields of this class appear to be accessed inconsistently with respect
+ to synchronization. This bug report indicates that the bug pattern detector
+ judged that
+ </p>
+ <ol>
+ <li> The class contains a mix of locked and unlocked accesses,</li>
+ <li> At least one locked access was performed by one of the class's own methods, and</li>
+ <li> The number of unsynchronized field accesses (reads and writes) was no more than
+ one third of all accesses, with writes being weighed twice as high as reads</li>
+ </ol>
+
+ <p> A typical bug matching this bug pattern is forgetting to synchronize
+ one of the methods in a class that is intended to be thread-safe.</p>
+
+ <p> You can select the nodes labeled "Unsynchronized access" to show the
+ code locations where the detector believed that a field was accessed
+ without synchronization.</p>
+
+ <p> Note that there are various sources of inaccuracy in this detector;
+ for example, the detector cannot statically detect all situations in which
+ a lock is held. Also, even when the detector is accurate in
+ distinguishing locked vs. unlocked accesses, the code in question may still
+ be correct.</p>
+
+ <p> This description refers to the "IS2" version of the pattern detector,
+ which has more accurate ways of detecting locked vs. unlocked accesses
+ than the older "IS" detector.</p>
+
+
+<h3><a name="IS_FIELD_NOT_GUARDED">IS: Field not guarded against concurrent access (IS_FIELD_NOT_GUARDED)</a></h3>
+
+
+ <p> This field is annotated with net.jcip.annotations.GuardedBy,
+but can be accessed in a way that seems to violate the annotation.</p>
+
+
+<h3><a name="JLM_JSR166_LOCK_MONITORENTER">JLM: Synchronization performed on java.util.concurrent Lock (JLM_JSR166_LOCK_MONITORENTER)</a></h3>
+
+
+<p> This method performs synchronization on an implementation of
+<code>java.util.concurrent.locks.Lock</code>. You should use
+the <code>lock()</code> and <code>unlock()</code> methods instead.
+</p>
+
+
+<h3><a name="LI_LAZY_INIT_STATIC">LI: Incorrect lazy initialization of static field (LI_LAZY_INIT_STATIC)</a></h3>
+
+
+<p> This method contains an unsynchronized lazy initialization of a non-volatile static field.
+Because the compiler or processor may reorder instructions,
+threads are not guaranteed to see a completely initialized object,
+<em>if the method can be called by multiple threads</em>.
+You can make the field volatile to correct the problem.
+For more information, see the
+<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
+</p>
+
+
+<h3><a name="LI_LAZY_INIT_UPDATE_STATIC">LI: Incorrect lazy initialization and update of static field (LI_LAZY_INIT_UPDATE_STATIC)</a></h3>
+
+
+<p> This method contains an unsynchronized lazy initialization of a static field.
+After the field is set, the object stored into that location is further accessed.
+The setting of the field is visible to other threads as soon as it is set. If the
+futher accesses in the method that set the field serve to initialize the object, then
+you have a <em>very serious</em> multithreading bug, unless something else prevents
+any other thread from accessing the stored object until it is fully initialized.
+</p>
+
+
+<h3><a name="ML_SYNC_ON_UPDATED_FIELD">ML: Method synchronizes on an updated field (ML_SYNC_ON_UPDATED_FIELD)</a></h3>
+
+
+ <p> This method synchronizes on an object
+ references from a mutable field.
+ This is unlikely to have useful semantics, since different
+threads may be synchronizing on different objects.</p>
+
+
+<h3><a name="MWN_MISMATCHED_NOTIFY">MWN: Mismatched notify() (MWN_MISMATCHED_NOTIFY)</a></h3>
+
+
+<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock
+on the object. Calling notify() or notifyAll() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
+
+
+<h3><a name="MWN_MISMATCHED_WAIT">MWN: Mismatched wait() (MWN_MISMATCHED_WAIT)</a></h3>
+
+
+<p> This method calls Object.wait() without obviously holding a lock
+on the object. Calling wait() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
+
+
+<h3><a name="NN_NAKED_NOTIFY">NN: Naked notify (NN_NAKED_NOTIFY)</a></h3>
+
+
+ <p> A call to <code>notify()</code> or <code>notifyAll()</code>
+ was made without any (apparent) accompanying
+ modification to mutable object state. In general, calling a notify
+ method on a monitor is done because some condition another thread is
+ waiting for has become true. However, for the condition to be meaningful,
+ it must involve a heap object that is visible to both threads.</p>
+
+ <p> This bug does not necessarily indicate an error, since the change to
+ mutable object state may have taken place in a method which then called
+ the method containing the notification.</p>
+
+
+<h3><a name="NP_SYNC_AND_NULL_CHECK_FIELD">NP: Synchronize and null check on the same field. (NP_SYNC_AND_NULL_CHECK_FIELD)</a></h3>
+
+
+<p>Since field is synchronized on, it seems not likely to be null.
+If it is null and then synchronized on a NullPointerException will be
+thrown and the check would be pointless. Better to synchronize on
+another field.</p>
+
+
+
+<h3><a name="NO_NOTIFY_NOT_NOTIFYALL">No: Using notify() rather than notifyAll() (NO_NOTIFY_NOT_NOTIFYALL)</a></h3>
+
+
+ <p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>.
+ Java monitors are often used for multiple conditions. Calling <code>notify()</code>
+ only wakes up one thread, meaning that the thread woken up might not be the
+ one waiting for the condition that the caller just satisfied.</p>
+
+
+<h3><a name="RS_READOBJECT_SYNC">RS: Class's readObject() method is synchronized (RS_READOBJECT_SYNC)</a></h3>
+
+
+ <p> This serializable class defines a <code>readObject()</code> which is
+ synchronized. By definition, an object created by deserialization
+ is only reachable by one thread, and thus there is no need for
+ <code>readObject()</code> to be synchronized. If the <code>readObject()</code>
+ method itself is causing the object to become visible to another thread,
+ that is an example of very dubious coding style.</p>
+
+
+<h3><a name="RU_INVOKE_RUN">Ru: Invokes run on a thread (did you mean to start it instead?) (RU_INVOKE_RUN)</a></h3>
+
+
+ <p> This method explicitly invokes <code>run()</code> on an object.
+ In general, classes implement the <code>Runnable</code> interface because
+ they are going to have their <code>run()</code> method invoked in a new thread,
+ in which case <code>Thread.start()</code> is the right method to call.</p>
+
+
+<h3><a name="SC_START_IN_CTOR">SC: Constructor invokes Thread.start() (SC_START_IN_CTOR)</a></h3>
+
+
+ <p> The constructor starts a thread. This is likely to be wrong if
+ the class is ever extended/subclassed, since the thread will be started
+ before the subclass constructor is started.</p>
+
+
+<h3><a name="SP_SPIN_ON_FIELD">SP: Method spins on field (SP_SPIN_ON_FIELD)</a></h3>
+
+
+ <p> This method spins in a loop which reads a field. The compiler
+ may legally hoist the read out of the loop, turning the code into an
+ infinite loop. The class should be changed so it uses proper
+ synchronization (including wait and notify calls).</p>
+
+
+<h3><a name="STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE">STCAL: Call to static Calendar (STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE)</a></h3>
+
+
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+The detector has found a call to an instance of Calendar that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE">STCAL: Call to static DateFormat (STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE)</a></h3>
+
+
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+The detector has found a call to an instance of DateFormat that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_STATIC_CALENDAR_INSTANCE">STCAL: Static Calendar (STCAL_STATIC_CALENDAR_INSTANCE)</a></h3>
+
+
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see
+random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE">STCAL: Static DateFormat (STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE)</a></h3>
+
+
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application.</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
+
+
+<h3><a name="SWL_SLEEP_WITH_LOCK_HELD">SWL: Method calls Thread.sleep() with a lock held (SWL_SLEEP_WITH_LOCK_HELD)</a></h3>
+
+
+ <p>
+ This method calls Thread.sleep() with a lock held. This may result
+ in very poor performance and scalability, or a deadlock, since other threads may
+ be waiting to acquire the lock. It is a much better idea to call
+ wait() on the lock, which releases the lock and allows other threads
+ to run.
+ </p>
+
+
+<h3><a name="TLW_TWO_LOCK_WAIT">TLW: Wait with two locks held (TLW_TWO_LOCK_WAIT)</a></h3>
+
+
+ <p> Waiting on a monitor while two locks are held may cause
+ deadlock.
+
+ Performing a wait only releases the lock on the object
+ being waited on, not any other locks.
+
+This not necessarily a bug, but is worth examining
+ closely.</p>
+
+
+<h3><a name="UG_SYNC_SET_UNSYNC_GET">UG: Unsynchronized get method, synchronized set method (UG_SYNC_SET_UNSYNC_GET)</a></h3>
+
+
+ <p> This class contains similarly-named get and set
+ methods where the set method is synchronized and the get method is not.
+ This may result in incorrect behavior at runtime, as callers of the get
+ method will not necessarily see a consistent state for the object.
+ The get method should be made synchronized.</p>
+
+
+<h3><a name="UL_UNRELEASED_LOCK">UL: Method does not release lock on all paths (UL_UNRELEASED_LOCK)</a></h3>
+
+
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
+
+
+<h3><a name="UL_UNRELEASED_LOCK_EXCEPTION_PATH">UL: Method does not release lock on all exception paths (UL_UNRELEASED_LOCK_EXCEPTION_PATH)</a></h3>
+
+
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all exception paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
+
+
+<h3><a name="UW_UNCOND_WAIT">UW: Unconditional wait (UW_UNCOND_WAIT)</a></h3>
+
+
+ <p> This method contains a call to <code>java.lang.Object.wait()</code> which
+ is not guarded by conditional control flow. The code should
+ verify that condition it intends to wait for is not already satisfied
+ before calling wait; any previous notifications will be ignored.
+ </p>
+
+
+<h3><a name="VO_VOLATILE_REFERENCE_TO_ARRAY">VO: A volatile reference to an array doesn't treat the array elements as volatile (VO_VOLATILE_REFERENCE_TO_ARRAY)</a></h3>
+
+
+<p>This declares a volatile reference to an array, which might not be what
+you want. With a volatile reference to an array, reads and writes of
+the reference to the array are treated as volatile, but the array elements
+are non-volatile. To get volatile array elements, you will need to use
+one of the atomic array classes in java.util.concurrent (provided
+in Java 5.0).</p>
+
+
+<h3><a name="WS_WRITEOBJECT_SYNC">WS: Class's writeObject() method is synchronized but nothing else is (WS_WRITEOBJECT_SYNC)</a></h3>
+
+
+ <p> This class has a <code>writeObject()</code> method which is synchronized;
+ however, no other method of the class is synchronized.</p>
+
+
+<h3><a name="WA_AWAIT_NOT_IN_LOOP">Wa: Condition.await() not in loop (WA_AWAIT_NOT_IN_LOOP)</a></h3>
+
+
+ <p> This method contains a call to <code>java.util.concurrent.await()</code>
+ (or variants)
+ which is not in a loop. If the object is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
+
+
+<h3><a name="WA_NOT_IN_LOOP">Wa: Wait not in loop (WA_NOT_IN_LOOP)</a></h3>
+
+
+ <p> This method contains a call to <code>java.lang.Object.wait()</code>
+ which is not in a loop. If the monitor is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
+
+
+<h3><a name="BX_BOXING_IMMEDIATELY_UNBOXED">Bx: Primitive value is boxed and then immediately unboxed (BX_BOXING_IMMEDIATELY_UNBOXED)</a></h3>
+
+
+ <p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual
+ boxing in a place where an unboxed value is required, thus forcing the compiler
+to immediately undue the work of the boxing.
+</p>
+
+
+<h3><a name="BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION">Bx: Primitive value is boxed then unboxed to perform primative coercion (BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION)</a></h3>
+
+
+ <p>A primitive boxed value constructed and then immediately converted into a different primitive type
+(e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>
+
+
+<h3><a name="DM_BOXED_PRIMITIVE_TOSTRING">Bx: Method allocates a boxed primitive just to call toString (DM_BOXED_PRIMITIVE_TOSTRING)</a></h3>
+
+
+ <p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static
+ form of toString which takes the primitive value. So,</p>
+ <table>
+ <tr><th>Replace...</th><th>With this...</th></tr>
+ <tr><td>new Integer(1).toString()</td><td>Integer.toString(1)</td></tr>
+ <tr><td>new Long(1).toString()</td><td>Long.toString(1)</td></tr>
+ <tr><td>new Float(1.0).toString()</td><td>Float.toString(1.0)</td></tr>
+ <tr><td>new Double(1.0).toString()</td><td>Double.toString(1.0)</td></tr>
+ <tr><td>new Byte(1).toString()</td><td>Byte.toString(1)</td></tr>
+ <tr><td>new Short(1).toString()</td><td>Short.toString(1)</td></tr>
+ <tr><td>new Boolean(true).toString()</td><td>Boolean.toString(true)</td></tr>
+ </table>
+
+
+<h3><a name="DM_FP_NUMBER_CTOR">Bx: Method invokes inefficient floating-point Number constructor; use static valueOf instead (DM_FP_NUMBER_CTOR)</a></h3>
+
+
+ <p>
+ Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas
+ <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of <code>Double</code> and <code>Float</code>.
+ </p>
+
+
+<h3><a name="DM_NUMBER_CTOR">Bx: Method invokes inefficient Number constructor; use static valueOf instead (DM_NUMBER_CTOR)</a></h3>
+
+
+ <p>
+ Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas
+ <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Values between -128 and 127 are guaranteed to have corresponding cached instances
+ and using <code>valueOf</code> is approximately 3.5 times faster than using constructor.
+ For values outside the constant range the performance of both styles is the same.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of
+ <code>Long</code>, <code>Integer</code>, <code>Short</code>, <code>Character</code>, and <code>Byte</code>.
+ </p>
+
+
+<h3><a name="DMI_BLOCKING_METHODS_ON_URL">Dm: The equals and hashCode methods of URL are blocking (DMI_BLOCKING_METHODS_ON_URL)</a></h3>
+
+
+ <p> The equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
+
+
+<h3><a name="DMI_COLLECTION_OF_URLS">Dm: Maps and sets of URLs can be performance hogs (DMI_COLLECTION_OF_URLS)</a></h3>
+
+
+ <p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
+
+
+<h3><a name="DM_BOOLEAN_CTOR">Dm: Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead (DM_BOOLEAN_CTOR)</a></h3>
+
+
+ <p> Creating new instances of <code>java.lang.Boolean</code> wastes
+ memory, since <code>Boolean</code> objects are immutable and there are
+ only two useful values of this type. Use the <code>Boolean.valueOf()</code>
+ method (or Java 1.5 autoboxing) to create <code>Boolean</code> objects instead.</p>
+
+
+<h3><a name="DM_GC">Dm: Explicit garbage collection; extremely dubious except in benchmarking code (DM_GC)</a></h3>
+
+
+ <p> Code explicitly invokes garbage collection.
+ Except for specific use in benchmarking, this is very dubious.</p>
+ <p>In the past, situations where people have explicitly invoked
+ the garbage collector in routines such as close or finalize methods
+ has led to huge performance black holes. Garbage collection
+ can be expensive. Any situation that forces hundreds or thousands
+ of garbage collections will bring the machine to a crawl.</p>
+
+
+<h3><a name="DM_NEW_FOR_GETCLASS">Dm: Method allocates an object, only to get the class object (DM_NEW_FOR_GETCLASS)</a></h3>
+
+
+ <p>This method allocates an object just to call getClass() on it, in order to
+ retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>
+
+
+<h3><a name="DM_NEXTINT_VIA_NEXTDOUBLE">Dm: Use the nextInt method of Random rather than nextDouble to generate a random integer (DM_NEXTINT_VIA_NEXTDOUBLE)</a></h3>
+
+
+ <p>If r is a java.util.Random, you can generate a random number from 0 to n-1
+using r.nextInt(n) Rather than using (int)(r.nextDouble() * n).
+</p>
+
+
+<h3><a name="DM_STRING_CTOR">Dm: Method invokes inefficient new String(String) constructor (DM_STRING_CTOR)</a></h3>
+
+
+ <p> Using the <code>java.lang.String(String)</code> constructor wastes memory
+ because the object so constructed will be functionally indistinguishable
+ from the <code>String</code> passed as a parameter. Just use the
+ argument <code>String</code> directly.</p>
+
+
+<h3><a name="DM_STRING_EMPTY_EQUALS">Dm: Method invokes inefficient String.equals(""); use String.length() == 0 instead (DM_STRING_EMPTY_EQUALS)</a></h3>
+
+
+ <p> An object is compared to the empty String object using the equals() method here.
+ Checking that the String object's length is zero may be faster, and removes String constants from the class file.</p>
+
+
+<h3><a name="DM_STRING_TOSTRING">Dm: Method invokes toString() method on a String (DM_STRING_TOSTRING)</a></h3>
+
+
+ <p> Calling <code>String.toString()</code> is just a redundant operation.
+ Just use the String.</p>
+
+
+<h3><a name="DM_STRING_VOID_CTOR">Dm: Method invokes inefficient new String() constructor (DM_STRING_VOID_CTOR)</a></h3>
+
+
+ <p> Creating a new <code>java.lang.String</code> object using the
+ no-argument constructor wastes memory because the object so created will
+ be functionally indistinguishable from the empty string constant
+ <code>""</code>. Java guarantees that identical string constants
+ will be represented by the same <code>String</code> object. Therefore,
+ you should just use the empty string constant directly.</p>
+
+
+<h3><a name="HSC_HUGE_SHARED_STRING_CONSTANT">HSC: Huge string constants is duplicated across multiple class files (HSC_HUGE_SHARED_STRING_CONSTANT)</a></h3>
+
+
+ <p>
+ A large String constant is duplicated across multiple class files.
+ This is likely because a final field is initialized to a String constant, and the Java language
+ mandates that all references to a final field from other classes be inlined into
+that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6447475">JDK bug 6447475</a>
+ for a description of an occurrence of this bug in the JDK and how resolving it reduced
+ the size of the JDK by 1 megabyte.
+</p>
+
+
+<h3><a name="ITA_INEFFICIENT_TO_ARRAY">ITA: Method uses toArray() with zero-length array argument (ITA_INEFFICIENT_TO_ARRAY)</a></h3>
+
+
+<p> This method uses the toArray() method of a collection derived class, and passes
+in a zero-length prototype array argument. It is more efficient to use
+<code>myCollection.toArray(new Foo[myCollection.size()])</code>
+If the array passed in is big enough to store all of the
+elements of the collection, then it is populated and returned
+directly. This avoids the need to create a second array
+(by reflection) to return as the result.</p>
+
+
+<h3><a name="SBSC_USE_STRINGBUFFER_CONCATENATION">SBSC: Method concatenates strings using + in a loop (SBSC_USE_STRINGBUFFER_CONCATENATION)</a></h3>
+
+
+<p> The method seems to be building a String using concatenation in a loop.
+In each iteration, the String is converted to a StringBuffer/StringBuilder,
+ appended to, and converted back to a String.
+ This can lead to a cost quadratic in the number of iterations,
+ as the growing string is recopied in each iteration. </p>
+
+<p>Better performance can be obtained by using
+a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p>
+
+<p> For example:</p>
+<pre>
+ // This is bad
+ String s = "";
+ for (int i = 0; i < field.length; ++i) {
+ s = s + field[i];
+ }
+
+ // This is better
+ StringBuffer buf = new StringBuffer();
+ for (int i = 0; i < field.length; ++i) {
+ buf.append(field[i]);
+ }
+ String s = buf.toString();
+</pre>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC">SIC: Should be a static inner class (SIC_INNER_SHOULD_BE_STATIC)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made static.
+</p>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC_ANON">SIC: Could be refactored into a named static inner class (SIC_INNER_SHOULD_BE_STATIC_ANON)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since anonymous inner
+classes cannot be marked as static, doing this will requiring refactoring
+the inner class so that it is a named inner class.</p>
+
+
+<h3><a name="SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS">SIC: Could be refactored into a static inner class (SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS)</a></h3>
+
+
+ <p> This class is an inner class, but does not use its embedded reference
+ to the object which created it except during construction of the
+inner object. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since the reference to the
+ outer object is required during construction of the inner instance,
+ the inner class will need to be refactored so as to
+ pass a reference to the outer instance to the constructor
+ for the inner class.</p>
+
+
+<h3><a name="SS_SHOULD_BE_STATIC">SS: Unread field: should this field be static? (SS_SHOULD_BE_STATIC)</a></h3>
+
+
+ <p> This class contains an instance final field that
+ is initialized to a compile-time static value.
+ Consider making the field static.</p>
+
+
+<h3><a name="UM_UNNECESSARY_MATH">UM: Method calls static Math class method on a constant value (UM_UNNECESSARY_MATH)</a></h3>
+
+
+<p> This method uses a static method from java.lang.Math on a constant value. This method's
+result in this case, can be determined statically, and is faster and sometimes more accurate to
+just use the constant. Methods detected are:
+</p>
+<table>
+<tr>
+ <th>Method</th> <th>Parameter</th>
+</tr>
+<tr>
+ <td>abs</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>acos</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>asin</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan2</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cbrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>ceil</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>cos</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cosh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>exp</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>expm1</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>floor</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>log</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>log10</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>rint</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>round</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>sin</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sinh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sqrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>tan</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>tanh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>toDegrees</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>toRadians</td> <td>0.0</td>
+</tr>
+</table>
+
+
+<h3><a name="UPM_UNCALLED_PRIVATE_METHOD">UPM: Private method is never called (UPM_UNCALLED_PRIVATE_METHOD)</a></h3>
+
+
+<p> This private method is never called. Although it is
+possible that the method will be invoked through reflection,
+it is more likely that the method is never used, and should be
+removed.
+</p>
+
+
+<h3><a name="URF_UNREAD_FIELD">UrF: Unread field (URF_UNREAD_FIELD)</a></h3>
+
+
+ <p> This field is never read. Consider removing it from the class.</p>
+
+
+<h3><a name="UUF_UNUSED_FIELD">UuF: Unused field (UUF_UNUSED_FIELD)</a></h3>
+
+
+ <p> This field is never used. Consider removing it from the class.</p>
+
+
+<h3><a name="WMI_WRONG_MAP_ITERATOR">WMI: Inefficient use of keySet iterator instead of entrySet iterator (WMI_WRONG_MAP_ITERATOR)</a></h3>
+
+
+<p> This method accesses the value of a Map entry, using a key that was retrieved from
+a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the
+Map.get(key) lookup.</p>
+
+
+<h3><a name="BC_BAD_CAST_TO_ABSTRACT_COLLECTION">BC: Questionable cast to abstract collection (BC_BAD_CAST_TO_ABSTRACT_COLLECTION)</a></h3>
+
+
+<p>
+This code casts a Collection to an abstract collection
+(such as <code>List</code>, <code>Set</code>, or <code>Map</code>).
+Ensure that you are guaranteed that the object is of the type
+you are casting to. If all you need is to be able
+to iterate through a collection, you don't need to cast it to a Set or List.
+</p>
+
+
+<h3><a name="BC_BAD_CAST_TO_CONCRETE_COLLECTION">BC: Questionable cast to concrete collection (BC_BAD_CAST_TO_CONCRETE_COLLECTION)</a></h3>
+
+
+<p>
+This code casts an abstract collection (such as a Collection, List, or Set)
+to a specific concrete implementation (such as an ArrayList or HashSet).
+This might not be correct, and it may make your code fragile, since
+it makes it harder to switch to other concrete implementations at a future
+point. Unless you have a particular reason to do so, just use the abstract
+collection class.
+</p>
+
+
+<h3><a name="BC_UNCONFIRMED_CAST">BC: Unchecked/unconfirmed cast (BC_UNCONFIRMED_CAST)</a></h3>
+
+
+<p>
+This cast is unchecked, and not all instances of the type casted from can be cast to
+the type it is being cast to. Ensure that your program logic ensures that this
+cast will not fail.
+</p>
+
+
+<h3><a name="BC_VACUOUS_INSTANCEOF">BC: instanceof will always return true (BC_VACUOUS_INSTANCEOF)</a></h3>
+
+
+<p>
+This instanceof test will always return true. Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
+
+
+<h3><a name="CI_CONFUSED_INHERITANCE">CI: Class is final but declares protected field (CI_CONFUSED_INHERITANCE)</a></h3>
+
+
+ <p>
+ This class is declared to be final, but declares fields to be protected. Since the class
+ is final, it can not be derived from, and the use of protected is confusing. The access
+ modifier for the field should be changed to private or public to represent the true
+ use for the field.
+ </p>
+
+
+<h3><a name="DB_DUPLICATE_BRANCHES">DB: Method uses the same code for two branches (DB_DUPLICATE_BRANCHES)</a></h3>
+
+
+ <p>
+ This method uses the same code to implement two branches of a conditional branch.
+ Check to ensure that this isn't a coding mistake.
+ </p>
+
+
+<h3><a name="DB_DUPLICATE_SWITCH_CLAUSES">DB: Method uses the same code for two switch clauses (DB_DUPLICATE_SWITCH_CLAUSES)</a></h3>
+
+
+ <p>
+ This method uses the same code to implement two clauses of a switch statement.
+ This could be a case of duplicate code, but it might also indicate
+ a coding mistake.
+ </p>
+
+
+<h3><a name="DLS_DEAD_LOCAL_STORE">DLS: Dead store to local variable (DLS_DEAD_LOCAL_STORE)</a></h3>
+
+
+<p>
+This instruction assigns a value to a local variable,
+but the value is not read by any subsequent instruction.
+Often, this indicates an error, because the value computed
+is never used.
+</p>
+<p>
+Note that Sun's javac compiler often generates dead stores for
+final local variables. Because FindBugs is a bytecode-based tool,
+there is no easy way to eliminate these false positives.
+</p>
+
+
+<h3><a name="DLS_DEAD_LOCAL_STORE_OF_NULL">DLS: Dead store of null to local variable (DLS_DEAD_LOCAL_STORE_OF_NULL)</a></h3>
+
+
+<p>The code stores null into a local variable, and stored value is not
+read. This store may have been introduced in assist the garbage collector, but
+as of Java SE 6.0, this is no longer needed or useful.
+</p>
+
+
+<h3><a name="DMI_HARDCODED_ABSOLUTE_FILENAME">DMI: Code contains a hard coded reference to an absolute pathname (DMI_HARDCODED_ABSOLUTE_FILENAME)</a></h3>
+
+
+<p>This code constructs a File object using a hard coded to an absolute pathname
+(e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code>
+</p>
+
+
+<h3><a name="DMI_NONSERIALIZABLE_OBJECT_WRITTEN">DMI: Non serializable object written to ObjectOutput (DMI_NONSERIALIZABLE_OBJECT_WRITTEN)</a></h3>
+
+
+<p>
+This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method.
+If the object is, indeed, non-serializable, an error will result.
+</p>
+
+
+<h3><a name="DMI_USELESS_SUBSTRING">DMI: Invocation of substring(0), which returns the original value (DMI_USELESS_SUBSTRING)</a></h3>
+
+
+<p>
+This code invokes substring(0) on a String, which returns the original value.
+</p>
+
+
+<h3><a name="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED">Dm: Thread passed where Runnable expected (DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED)</a></h3>
+
+
+ <p> A Thread object is passed as a parameter to a method where
+a Runnable is expected. This is rather unusual, and may indicate a logic error
+or cause unexpected behavior.
+ </p>
+
+
+<h3><a name="EQ_DOESNT_OVERRIDE_EQUALS">Eq: Class doesn't override equals in superclass (EQ_DOESNT_OVERRIDE_EQUALS)</a></h3>
+
+
+ <p> This class extends a class that defines an equals method and adds fields, but doesn't
+define an equals method itself. Thus, equality on instances of this class will
+ignore the identity of the subclass and the added fields. Be sure this is what is intended,
+and that you don't need to override the equals method. Even if you don't need to override
+the equals method, consider overriding it anyone to document the fact
+that the equals method for the subclass just return the result of
+invoking super.equals(o).
+
+
+<h3><a name="FE_FLOATING_POINT_EQUALITY">FE: Test for floating point equality (FE_FLOATING_POINT_EQUALITY)</a></h3>
+
+
+ <p>
+ This operation compares two floating point values for equality.
+ Because floating point calculations may involve rounding,
+ calculated float and double values may not be accurate.
+ For values that must be precise, such as monetary values,
+ consider using a fixed-precision type such as BigDecimal.
+ For values that need not be precise, consider comparing for equality
+ within some range, for example:
+ <code>if ( Math.abs(x - y) < .0000001 )</code>.
+ See the Java Language Specification, section 4.2.4.
+ </p>
+
+
+<h3><a name="IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD">IA: Ambiguous invocation of either an inherited or outer method (IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD)</a></h3>
+
+
+ <p> An inner class is invoking a method that could be resolved to either a inherited method or a method defined in an outer class. By the Java semantics,
+it will be resolved to invoke the inherited method, but this may not be want
+you intend. If you really intend to invoke the inherited method,
+invoke it by invoking the method on super (e.g., invoke super.foo(17)), and
+thus it will be clear to other readers of your code and to FindBugs
+that you want to invoke the inherited method, not the method in the outer class.
+</p>
+
+
+<h3><a name="IC_INIT_CIRCULARITY">IC: Initialization circularity (IC_INIT_CIRCULARITY)</a></h3>
+
+
+ <p> A circularity was detected in the static initializers of the two
+ classes referenced by the bug instance. Many kinds of unexpected
+ behavior may arise from such circularity.</p>
+
+
+<h3><a name="ICAST_IDIV_CAST_TO_DOUBLE">ICAST: int division result cast to double or float (ICAST_IDIV_CAST_TO_DOUBLE)</a></h3>
+
+
+<p>
+This code casts the result of an integer division operation to double or
+float.
+Doing division on integers truncates the result
+to the integer value closest to zero. The fact that the result
+was cast to double suggests that this precision should have been retained.
+What was probably meant was to cast one or both of the operands to
+double <em>before</em> performing the division. Here is an example:
+</p>
+<blockquote>
+<pre>
+int x = 2;
+int y = 5;
+// Wrong: yields result 0.0
+double value1 = x / y;
+
+// Right: yields result 0.4
+double value2 = x / (double) y;
+</pre>
+</blockquote>
+
+
+<h3><a name="ICAST_INTEGER_MULTIPLY_CAST_TO_LONG">ICAST: Result of integer multiplication cast to long (ICAST_INTEGER_MULTIPLY_CAST_TO_LONG)</a></h3>
+
+
+<p>
+This code performs integer multiply and then converts the result to a long,
+as in:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }
+</pre></code>
+If the multiplication is done using long arithmetic, you can avoid
+the possibility that the result will overflow. For example, you
+could fix the above code to:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; }
+</pre></code>
+or
+<code>
+<pre>
+ static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
+ long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; }
+</pre></code>
+</p>
+
+
+
+<h3><a name="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT">ICAST: Unsigned right shift cast to short/byte (ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT)</a></h3>
+
+
+<p>
+The code performs an unsigned right shift, whose result is then
+cast to a short or byte, which discards the upper bits of the result.
+Since the upper bits are discarded, there may be no difference between
+a signed and unsigned right shift (depending upon the size of the shift).
+</p>
+
+
+<h3><a name="IM_AVERAGE_COMPUTATION_COULD_OVERFLOW">IM: Computation of average could overflow (IM_AVERAGE_COMPUTATION_COULD_OVERFLOW)</a></h3>
+
+
+<p>The code computes the average of two integers using either division or signed right shift,
+and then uses the result as the index of an array.
+If the values being averaged are very large, this can overflow (resulting in the computation
+of a negative average). Assuming that the result is intended to be nonnegative, you
+can use an unsigned right shift instead. In other words, rather that using <code>(low+high)/2</code>,
+use <code>(low+high) >>> 1</code>
+</p>
+<p>This bug exists in many earlier implementations of binary search and merge sort.
+Martin Buchholz <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6412541">found and fixed it</a>
+in the JDK libraries, and Joshua Bloch
+<a href="http://googleresearch.blogspot.com/2006/06/extra-extra-read-all-about-it-nearly.html">widely
+publicized the bug pattern</a>.
+</p>
+
+
+<h3><a name="IM_BAD_CHECK_FOR_ODD">IM: Check for oddness that won't work for negative numbers (IM_BAD_CHECK_FOR_ODD)</a></h3>
+
+
+<p>
+The code uses x % 2 == 1 to check to see if a value is odd, but this won't work
+for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check
+for oddness, consider using x & 1 == 1, or x % 2 != 0.
+</p>
+
+
+<h3><a name="INT_VACUOUS_COMPARISON">INT: Vacuous comparison of integer value (INT_VACUOUS_COMPARISON)</a></h3>
+
+
+<p> There is an integer comparison that always returns
+the same value (e.g., x <= Integer.MAX_VALUE).
+</p>
+
+
+<h3><a name="MTIA_SUSPECT_SERVLET_INSTANCE_FIELD">MTIA: Class extends Servlet class and uses instance variables (MTIA_SUSPECT_SERVLET_INSTANCE_FIELD)</a></h3>
+
+
+ <p>
+ This class extends from a Servlet class, and uses a instance member variable. Since only
+ one instance of a Servlet class is created by the J2EE framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables.
+ </p>
+
+
+<h3><a name="MTIA_SUSPECT_STRUTS_INSTANCE_FIELD">MTIA: Class extends Struts Action class and uses instance variables (MTIA_SUSPECT_STRUTS_INSTANCE_FIELD)</a></h3>
+
+
+ <p>
+ This class extends from a Struts Action class, and uses a instance member variable. Since only
+ one instance of a struts Action class is created by the Struts framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables.
+ </p>
+
+
+<h3><a name="NP_IMMEDIATE_DEREFERENCE_OF_READLINE">NP: Immediate dereference of the result of readLine() (NP_IMMEDIATE_DEREFERENCE_OF_READLINE)</a></h3>
+
+
+ <p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text
+to read, readLine() will return null and dereferencing that will generate a null pointer exception.
+</p>
+
+
+<h3><a name="NP_LOAD_OF_KNOWN_NULL_VALUE">NP: Load of known null value (NP_LOAD_OF_KNOWN_NULL_VALUE)</a></h3>
+
+
+ <p> The variable referenced at this point is known to be null due to an earlier
+ check against null. Although this is valid, it might be a mistake (perhaps you
+intended to refer to a different variable, or perhaps the earlier check to see if the
+variable is null should have been a check to see if it was nonnull.
+</p>
+
+
+<h3><a name="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE">NP: Possible null pointer dereference due to return value of called method (NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE)</a></h3>
+
+
+<p> A reference value which is null on some exception control path is
+dereferenced here. This may lead to a <code>NullPointerException</code>
+when the code is executed. The value may be null because it
+was return from a method which is known to return possibly-null values.</p>
+
+
+<h3><a name="NS_DANGEROUS_NON_SHORT_CIRCUIT">NS: Potentially dangerous use of non-short-circuit logic (NS_DANGEROUS_NON_SHORT_CIRCUIT)</a></h3>
+
+
+ <p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||). In addition,
+it seem possible that, depending on the value of the left hand side, you might not
+want to evaluate the right hand side (because it would have side effects, could cause an exception
+or could be expensive.</p>
+<p>
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+</p>
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
+
+
+<h3><a name="NS_NON_SHORT_CIRCUIT">NS: Questionable use of non-short-circuit logic (NS_NON_SHORT_CIRCUIT)</a></h3>
+
+
+ <p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||).
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
+
+
+<h3><a name="PZLA_PREFER_ZERO_LENGTH_ARRAYS">PZLA: Consider returning a zero length array rather than null (PZLA_PREFER_ZERO_LENGTH_ARRAYS)</a></h3>
+
+
+<p> It is often a better design to
+return a length zero array rather than a null reference to indicate that there
+are no results (i.e., an empty list of results).
+This way, no explicit check for null is needed by clients of the method.</p>
+
+<p>On the other hand, using null to indicate
+"there is no answer to this question", then it is probably appropriate.
+For example, <code>File.listFiles()</code> returns an empty list
+if given a directory containing no files, and returns null if the file
+is not a directory.</p>
+
+
+<h3><a name="QF_QUESTIONABLE_FOR_LOOP">QF: Complicated, subtle or wrong increment in for-loop (QF_QUESTIONABLE_FOR_LOOP)</a></h3>
+
+
+ <p>Are you sure this for loop is incrementing the correct variable?
+ It appears that another variable is being initialized and checked
+ by the for loop.
+</p>
+
+
+<h3><a name="RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE">RCN: Redundant comparison of non-null value to null (RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE)</a></h3>
+
+
+<p> This method contains a reference known to be non-null with another reference
+known to be null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES">RCN: Redundant comparison of two null values (RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES)</a></h3>
+
+
+<p> This method contains a redundant comparison of two references known to
+both be definitely null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE">RCN: Redundant nullcheck of value known to be non-null (RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE)</a></h3>
+
+
+<p> This method contains a redundant check of a known non-null value against
+the constant null.</p>
+
+
+<h3><a name="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE">RCN: Redundant nullcheck of value known to be null (RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE)</a></h3>
+
+
+<p> This method contains a redundant check of a known null value against
+the constant null.</p>
+
+
+<h3><a name="REC_CATCH_EXCEPTION">REC: Exception is caught when Exception is not thrown (REC_CATCH_EXCEPTION)</a></h3>
+
+
+ <p>
+ This method uses a try-catch block that catches Exception objects, but Exception is not
+ thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to
+ say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception
+ each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well,
+ masking potential bugs.
+ </p>
+
+
+<h3><a name="RI_REDUNDANT_INTERFACES">RI: Class implements same interface as superclass (RI_REDUNDANT_INTERFACES)</a></h3>
+
+
+ <p>
+ This class declares that it implements an interface that is also implemented by a superclass.
+ This is redundant, once a superclass implements an interface, all subclasses by default also
+ implement this interface. It may point out that the inheritance hierarchy has changed since
+ this class was created, and consideration should be taken into account for the ownership of
+ the interface's implementation.
+ </p>
+
+
+<h3><a name="RV_CHECK_FOR_POSITIVE_INDEXOF">RV: Method checks to see if result of String.indexOf is positive (RV_CHECK_FOR_POSITIVE_INDEXOF)</a></h3>
+
+
+ <p> The method invokes String.indexOf and checks to see if the result is positive or non-positive.
+ It is much more typical to check to see if the result is negative or non-negative. It is
+ positive only if the substring checked for occurs at some place other than at the beginning of
+ the String.</p>
+
+
+<h3><a name="RV_REM_OF_HASHCODE">RV: Remainder of hashCode could be negative (RV_REM_OF_HASHCODE)</a></h3>
+
+
+<p> This code computes a hashCode, and then computes
+the remainder of that value modulo another value. Since the hashCode
+can be negative, the result of the remainder operation
+can also be negative. </p>
+<p> Assuming you want to ensure that the result of your computation is nonnegative,
+you may need to change your code.
+If you know the divisor is a power of 2,
+you can use a bitwise and operator instead (i.e., instead of
+using <code>x.hashCode()%n</code>, use <code>x.hashCode()&(n-1)</code>.
+This is probably faster than computing the remainder as well.
+If you don't know that the divisor is a power of 2, take the absolute
+value of the result of the remainder operation (i.e., use
+<code>Math.abs(x.hashCode()%n)</code>
+</p>
+
+
+<h3><a name="RV_REM_OF_RANDOM_INT">RV: Remainder of 32-bit signed random integer (RV_REM_OF_RANDOM_INT)</a></h3>
+
+
+<p> This code generates a random signed integer and then computes
+the remainder of that value modulo another value. Since the random
+number can be negative, the result of the remainder operation
+can also be negative. Be sure this is intended, and strongly
+consider using the Random.nextInt(int) method instead.
+</p>
+
+
+<h3><a name="SA_LOCAL_SELF_ASSIGNMENT">SA: Self assignment of local variable (SA_LOCAL_SELF_ASSIGNMENT)</a></h3>
+
+
+<p> This method contains a self assignment of a local variable; e.g.</p>
+<pre>
+ public void foo() {
+ int x = 3;
+ x = x;
+ }
+</pre>
+<p>
+Such assignments are useless, and may indicate a logic error or typo.
+</p>
+
+
+<h3><a name="SF_SWITCH_FALLTHROUGH">SF: Switch statement found where one case falls through to the next case (SF_SWITCH_FALLTHROUGH)</a></h3>
+
+
+ <p> This method contains a switch statement where one case branch will fall through to the next case.
+ Usually you need to end this case with a break or return.</p>
+
+
+<h3><a name="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD">ST: Write to static field from instance method (ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)</a></h3>
+
+
+ <p> This instance method writes to a static field. This is tricky to get
+correct if multiple instances are being manipulated,
+and generally bad practice.
+</p>
+
+
+<h3><a name="SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS">Se: Transient field of class that isn't Serializable. (SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS)</a></h3>
+
+
+ <p> The field is marked as transient, but the class isn't Serializable, so marking it as transient
+has absolutely no effect.
+This may be leftover marking from a previous version of the code in which the class was transient, or
+it may indicate a misunderstanding of how serialization works.
+</p>
+
+
+<h3><a name="UCF_USELESS_CONTROL_FLOW">UCF: Useless control flow (UCF_USELESS_CONTROL_FLOW)</a></h3>
+
+
+<p> This method contains a useless control flow statement, where
+control flow continues onto the same place regardless of whether or not
+the branch is taken. For example,
+this is caused by having an empty statement
+block fot an <code>if</code> statement:</p>
+<pre>
+ if (argv.length == 0) {
+ // TODO: handle this case
+ }
+</pre>
+
+
+<h3><a name="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR">UwF: Field not initialized in constructor (UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR)</a></h3>
+
+
+ <p> This field is never initialized within any constructor, and is therefore could be null after
+the object is constructed.
+This could be a either an error or a questionable design, since
+it means a null pointer exception will be generated if that field is dereferenced
+before being initialized.
+</p>
+
+
+<h3><a name="XFB_XML_FACTORY_BYPASS">XFB: Method directly allocates a specific implementation of xml interfaces (XFB_XML_FACTORY_BYPASS)</a></h3>
+
+
+ <p>
+ This method allocates a specific implementation of an xml interface. It is preferable to use
+ the supplied factory classes to create these objects so that the implementation can be
+ changed at runtime. See
+ </p>
+ <ul>
+ <li>javax.xml.parsers.DocumentBuilderFactory</li>
+ <li>javax.xml.parsers.SAXParserFactory</li>
+ <li>javax.xml.transform.TransformerFactory</li>
+ <li>org.w3c.dom.Document.create<i>XXXX</i></li>
+ </ul>
+ <p>for details.</p>
+
+
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+</td></tr></table>
+</body></html>
--- /dev/null
+<html>
+<head>
+<title>Contributing to FindBugs</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>Contributing to FindBugs</h1>
+
+<p> If you have a bug fix or feature enhancement you would like to contribute,
+we would be happy to consider it for inclusion.</p>
+
+<h2>Preparing a patch</h2>
+
+<p> The best way to
+send an enhancement is to create a patch against the latest code
+in the FindBugs Subversion repository
+at <a href="http://findbugs.googlecode.com/svn/trunk/">http://findbugs.googlecode.com/svn/trunk/</a>
+(those people who have been given commit priviledges should use
+<a href="http://findbugs.googlecode.com/svn/trunk/">http://findbugs.googlecode.com/svn/trunk/</a>).
+
+</p>
+
+<p> Please follow these guidelines when preparing your patch:</p>
+<ul>
+<li> <b>Use the same indentation style as the source file(s) you
+ are modifying</b>. In particular, please use tabs (not spaces)
+ to indent your code; one tab per indent level.
+<li> If at all possible, avoid making whitespace modifications.
+<li> Small patches are appreciated.
+<li> If you are submitting a new bug detector, please submit a small
+ standalone source file that contains an instance of the
+ kind of bug the detector looks for.
+</ul>
+
+<p> Following these guidelines makes it much easier for us
+to incorporate new code.
+
+<h2>How to submit a patch</h2>
+
+<p> Patches may be submitted through the
+<a href="http://sourceforge.net/tracker/?atid=614695&group_id=96405&func=browse">Patches</a> tracker on the
+<a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>.
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs™ 1.2 Demo and Results</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css" />
+
+</head>
+
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+<h1>
+FindBugs 1.2 demo and results
+</h1>
+
+<p>If you just want to try running FindBugs against your
+own code, you can
+<a href="http://findbugs.cs.umd.edu/demo/jnlp/findbugs.jnlp">run FindBugs</a> using Java Webstart.
+This will use our new gui under Java 1.5+ and our old gui under Java 1.4.
+The new gui provides a number of new features, but requires Java 1.5+.
+Both use exactly the same analysis engine.
+
+</p><p>This web page provides results of running FindBugs 1.2.0
+against several open source applications. We provide a summary
+of the number of bugs we found, as well as a generated HTML listing
+of the bugs and
+a <a href="http://java.sun.com/products/javawebstart/">Java
+WebStart</a> demo of the new GUI we've introduced in FindBugs version 1.1,
+displaying the warnings and the relevant source.
+
+
+</p><p>The applications and versions of them we report on
+are somewhat arbitrary. In some cases, they are release versions,
+in other cases nightly builds. We find lots of bugs in every large code
+base we examine; these applications are certainly not the worst we have seen.
+I have been allowed to confidentially examine the results of running FindBugs
+against several closed commercial code bases by well respected companies;
+the results I've seen there are not significantly different from
+what I've observed in open source code bases.
+
+
+</p><p><em>Experimental details</em>: These results are from running
+FindBugs 1.2.0 at standard effort level. Our results do not include
+any low priority warnings or any warnings about vulnerabilities to
+malicious code. Although we have (repeatedly) manually audited the results,
+we haven't manually filtered out false positives from these warnings,
+so that you can get a feeling for the quality of the warnings generated
+by FindBugs.
+</p><p>Some of the bugs contain audit comments: they are marked as to whether
+we thought the warning indicated a bug that should or must be fixed, or whether it was not, in fact, a bug.
+</p><p>In the webstart versions, we've only included the bugs for which
+we were able to identify source files. The number of lines of non-commenting source
+statements in the table below (KNCSS) is derived from the same files
+that we analyzed and in which we report bugs; we actually compute
+KNCSS from the classfiles, not the source files.
+
+</p><p><em>Vulnerability disclosure</em>: Thankfully, Java isn't C or C++. Dereferencing
+a null pointer or accessing outside the bounds of an array generates a runtime
+exception rather than a shell exploit. We do not believe that any of the
+warnings here represents a security vulnerability, although we have not audited
+them to verify that. These projects are all aware of the existence of
+FindBugs, and FindBugs is already open source and available
+for use both by developers and attackers, we don't believe that making
+these results available constitutes a reckless disclosure.
+
+
+</p><p><em>Recommendations</em>: First, review the correctness warnings.
+ We feel confident that developers
+would want to fix most of the high and medium priority correctness warnings we report.
+Once you've reviewed those,
+you might want to look at some of the other categories.
+</p><p>
+In other categories,
+such as Bad practice and Dodgy code, we accept more false positives. You
+might decide that a pattern bug pattern isn't relevant for your code
+base (e.g., you never use Serialization for persistent storage,
+so you never care about the fact that you didn't define a serializationUID),
+and even for the bug patterns relevant to your code base,
+perhaps only a minority will reflect problems serious enough to
+convince you to change your code.
+
+</p><p><em>Please be patient</em> The Web start versions not only have to download the applications,
+ they need to download about 10 megabytes of data and source files. Please
+ be patient. Sorry we don't have a progress bar for the data and source download;
+ the ability to remotely download a data and source archive is a little bit of
+ a hack. We've provided small versions of some of the data sets that include
+ only the correctness bugs and the source files containing those warnings. The small
+ datasets are about a quarter of the sizes of the full datasets.
+ </p>
+<p>
+</p><table border="2">
+<tr><th rowspan="2">Application</th><th colspan="2">Details</th><th colspan="2">Correctness bugs</th><th rowspan="2">Bad Practice</th><th rowspan="2">Dodgy</th><th rowspan="2">KNCSS
+</th></tr><tr><th>HTML</th><th>WebStart</th><th>NP bugs</th><th>Other
+</th></tr><tr><td align="right">Sun JDK 1.7.0-b12</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/small.jnlp">Small</a>
+ </td><td align="right">68</td><td align="right">180</td><td align="right">954</td><td align="right">654</td><td align="right">597
+
+</td></tr><tr><td align="right">eclipse-SDK-3.3M7-solaris-gtk</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/small.jnlp">Small</a>
+ </td><td align="right">146</td><td align="right">259</td><td align="right">1,079</td><td align="right">643</td><td align="right">1,447
+
+</td></tr><tr><td align="right">netbeans-6_0-m8</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/small.jnlp">Small</a>
+ </td><td align="right">189</td><td align="right">305</td><td align="right">3,010</td><td align="right">1,112</td><td align="right">1,022
+
+</td></tr><tr><td align="right">glassfish-v2-b43</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/small.jnlp">Small</a>
+ </td><td align="right">146</td><td align="right">154</td><td align="right">964</td><td align="right">1,222</td><td align="right">2,176
+
+</td></tr><tr><td align="right">jboss-4.0.5</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/small.jnlp">Small</a>
+ </td><td align="right">30</td><td align="right">57</td><td align="right">263</td><td align="right">214</td><td align="right">178
+
+</td></tr></table>
+<p><em>KNCSS</em> - Thousands of lines of non-commenting source statements
+
+</p><h2>Bug categories</h2>
+<dl>
+<dt>Correctness bug
+</dt><dd>Probable bug - an apparent coding mistake
+ resulting in code that was probably not what the
+ developer intended. We strive for a low false positive rate.
+</dd><dt>Bad Practice
+</dt><dd>
+Violations of recommended and essential
+ coding practice. Examples include hash code and equals
+ problems, cloneable idiom, dropped exceptions,
+ serializable problems, and misuse of finalize.
+ We strive to make this analysis accurate,
+ although some groups may
+ not care about some of the bad practices.
+</dd><dt>Dodgy
+</dt><dd>
+Code that is confusing, anomalous, or
+ written in a way that leads itself to errors.
+ Examples include dead local stores, switch fall through,
+ unconfirmed casts, and redundant null check of value
+ known to be null.
+ More false positives accepted.
+ In previous versions of FindBugs, this category was known as Style.
+</dl>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</dd></dl></td></tr></table>
+
+</body>
+</html>
+
+
+
+
--- /dev/null
+<html>
+<head>
+<title>FindBugs Downloads</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs downloads</h1>
+
+<p> This page contains links to downloads
+of Findbugs version 1.3.0,
+released on 09:39:09 EST, 08 November, 2007. Download links
+for all FindBugs versions and files
+are <a href="http://sourceforge.net/project/showfiles.php?group_id=96405">available
+on the sourceforge download page</a>.
+
+<ul>
+<li>FindBugs tool (standard version with command line, ant, and Swing interfaces)</a>
+<ul>
+<li><a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.tar.gz?download">findbugs-1.3.0.tar.gz</a>
+<li><a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.zip?download">findbugs-1.3.0.zip</a>
+
+<li><a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0-source.zip?download">findbugs-1.3.0-source.zip</a>
+</ul>
+<li>Eclipse plugin for FindBugs version 1.3.0.20071108</a>
+<ul>
+<li><a href="http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip?download">edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip</a>
+
+<li><a href="http://prdownloads.sourceforge.net/findbugs/eclipsePlugin-1.3.0-source.zip?download">eclipsePlugin-1.3.0-source.zip</a>
+</ul>
+</ul>
+
+The Eclipse plugin may also be obtained from one of the FindBugs Eclipse plugin update sites:
+<ul>
+<li><a href="http://findbugs.cs.umd.edu/eclipse">http://findbugs.cs.umd.edu/eclipse</a> update site for official releases</li>
+<li><a href="http://findbugs.cs.umd.edu/eclipse-candidate">http://findbugs.cs.umd.edu/eclipse-candidate</a> update site for candidate releases and official releases</li>
+<li><a href="http://findbugs.cs.umd.edu/eclipse-daily">http://findbugs.cs.umd.edu/eclipse-daily</a> update site for all releases, including developmental ones</li>
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs™ Fact Sheet</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs™ Fact Sheet</h1>
+
+<p> FindBugs looks for bugs in Java programs. It is based
+on the concept of <i>bug patterns</i>. A bug pattern is a code
+idiom that is often an error. Bug patterns arise for a variety
+of reasons:
+</p>
+
+<ul>
+<li> Difficult language features
+<li> Misunderstood API methods
+<li> Misunderstood invariants when code is modified during maintenance
+<li> Garden variety mistakes: typos, use of the wrong boolean operator
+</ul>
+
+<p> FindBugs uses <i>static analysis</i> to inspect Java bytecode
+for occurrences of bug patterns.
+Static analysis means that FindBugs can find bugs by simply inspecting
+a program's code: executing the program is not necessary.
+This makes FindBugs very easy to use: in general, you should be
+able to use it to look for bugs in your code within a few minutes of downloading it.
+FindBugs works by analyzing Java bytecode (compiled class files),
+so you don't even need the program's source code to use it.
+Because its analysis is
+sometimes imprecise, FindBugs can report <i>false warnings</i>,
+which are warnings that do not indicate real errors.
+In practice, the rate of false warnings reported by FindBugs
+is less than 50%.
+</p>
+
+<p>
+FindBugs supports a plugin architecture allowing anyone to add new
+bug detectors. The <a href="publications.html">publications page</a>
+contains links to articles describing how to write a new detector
+for FindBugs. If you are familiar with Java bytecode
+you can write a new FindBugs detector in as little as a few minutes.
+</p>
+
+<p> FindBugs is free software, available under the terms of the
+<a href="http://www.gnu.org/copyleft/lesser.html">Lesser GNU Public License</a>.
+It is written in Java, and can be run with any virtual machine compatible
+with Sun's JDK 1.4. It can analyze programs written for any version
+of Java. FindBugs was originally developed by Bill Pugh and David Hovemeyer.
+It is maintained by Bill Pugh, and
+a <a href="team.html">team of volunteers</a>.
+</p>
+
+<p> FindBugs uses <a href="http://jakarta.apache.org/bcel/">BCEL</a> to
+analyze Java bytecode.
+As of version 1.1, FindBugs also supports bug detectors written using
+the <a href="http://asm.objectweb.org/">ASM</a> bytecode framework.
+FindBugs uses <a href="http://dom4j.org/">dom4j</a>
+for XML manipulation.
+</p>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+BODY {
+ background: white;
+}
+
+A.plain {
+ text-decoration: none;
+}
+
+A.sidebar {
+ text-decoration: none;
+}
+
+A.sidebar:hover, A.sidebar:active {
+ text-decoration: underline;
+}
--- /dev/null
+<html>
+ <head>
+ <title>FindBugs™ - Find Bugs in Java Programs</title>
+ <link rel="stylesheet" type="text/css" href="findbugs.css" />
+
+ </head>
+
+ <body>
+
+ <table width="100%">
+ <tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+ <td align="left" valign="top">
+
+ <p>
+ <table><tr>
+ <td valign="center">
+ <a href="http://findbugs.sourceforge.net/"><img src="buggy-sm.png"
+ alt="FindBugs logo" border="0" /> </a>
+ <td valign="center"> <a href="http://www.umd.edu/"><img src="informal.png"
+ alt="UMD logo" border="0" /> </a>
+ <td valign="center"> <a
+ href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs"><img
+ src="Fortify.png" alt="Fortify logo" border="0" align="right" />
+ </a>
+ <td valign="center"><a
+ href="http://www.surelogic.com/"><img
+ src="surelogic.png" alt="SureLogic logo" border="0" align="right" />
+ </a>
+ </td></tr></table>
+ </p>
+
+ <h1>
+ FindBugs™ - Find Bugs in Java Programs
+ </h1>
+
+ <p>
+ This is the web page for FindBugs, a program which uses static analysis
+ to look for bugs
+ in Java code. It is free software, distributed under the
+ terms of the
+ <a href="http://www.gnu.org/licenses/lgpl.html">Lesser GNU
+ Public License</a>. The name FindBugs™ and the
+ <a href="buggy-sm.png">FindBugs logo</a> are trademarked by
+ <a href="http://www.umd.edu">The University of Maryland</a>.
+ FindBugs is <a href="#sponsored">sponsored</a> by <a
+ href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs">Fortify Software</a>
+ and <a
+ href="http://www.surelogic.com/">SureLogic</a>.
+ As of May 8th, 2007, FindBugs has been downloaded more than 368,911 times.
+ </p>
+
+
+ <p>
+ FindBugs requires JRE (or JDK) 1.4.0 or later to run.
+ However, it can analyze programs compiled for any version of Java.
+ The current version of FindBugs is 1.3.0, released on
+ 09:39:09 EST, 08 November, 2007.
+ <a href="reportingBugs.html">We are very interested in getting feedback on how to improve
+ FindBugs</a>.
+ </p>
+ <p>
+ <a href="#moreSoftware">More</a> |
+<a href="#sample">Output</a> |
+<a href="#try">Try</a> |
+<a href="#changes">Changes</a> |
+<a href="#talks">Talks</a> |
+<a href="#papers">Papers </a> |
+<a href="#sponsors">Sponsors</a> |
+<a href="#support">Support</a>
+
+ <h1><a name="moreSoftware">Additional open source projects</a></h1>
+ <p>The following software is being made available by the University of Maryland and the FindBugs project.
+ The software is still preliminary, and needs volunteers to help mature it.
+ <ul>
+ <li><a href="http://code.google.com/p/multithreadedtc/">Multithreaded test case</a>, a framework designed to make it
+ easy to create test cases for concurrent software in which multiple threads must coordindate their activity to perform a test
+ (e.g., testing a concurrent blocking queue, with one thread that blocks when it trys to add to a full queue, and another thread that
+ unblocks the first by removing an element).
+ </li>
+ <li><a href="http://code.google.com/p/checked-uncontended-lock/">Checked uncontended lock</a>, an implementation of the Java 5 Lock
+ and ReadWriteLock interfaces that throw exceptions if they detect lock contention. These locks are designed to be used for debugging,
+ and can be used in places where you don't believe you need to use a lock but want to verify that at runtime.
+ </li>
+ </ul>
+
+
+
+ <h1>
+ <a name="sample">Sample output</a>
+ </h1>
+
+ <p>
+ As an example of the kind of issues FindBugs can identify,
+ <a href="demo.html">we provide our results</a> on the Sun's JDK
+ 7, Eclipse, Netbeans, Glassfish and JBoss. We present
+ these results as a table showing the number of warnings we
+ generate, an html report generated by FindBugs, and using a Java
+ Webstart demo of FindBugs that loads the results of our analysis
+ and the relevant source, so that you can view the source
+ corresponding to each of our warnings and judge for yourself the
+ accuracy of Findbugs.
+ </p>
+
+ <p>
+ Briefly, this table gives the number of warnings we found in
+ various applications we use as benchmarks:
+ </p>
+
+ <table border="2">
+<tr><th rowspan="2">Application</th><th colspan="2">Details</th><th colspan="2">Correctness bugs</th><th rowspan="2">Bad Practice</th><th rowspan="2">Dodgy</th><th rowspan="2">KNCSS
+</th></tr><tr><th>HTML</th><th>WebStart</th><th>NP bugs</th><th>Other
+</th></tr><tr><td align="right">Sun JDK 1.7.0-b12</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/jdk7/small.jnlp">Small</a>
+ </td><td align="right">68</td><td align="right">180</td><td align="right">954</td><td align="right">654</td><td align="right">597
+
+</td></tr><tr><td align="right">eclipse-SDK-3.3M7-solaris-gtk</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/eclipse/small.jnlp">Small</a>
+ </td><td align="right">146</td><td align="right">259</td><td align="right">1,079</td><td align="right">643</td><td align="right">1,447
+
+</td></tr><tr><td align="right">netbeans-6_0-m8</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/netbeans/small.jnlp">Small</a>
+ </td><td align="right">189</td><td align="right">305</td><td align="right">3,010</td><td align="right">1,112</td><td align="right">1,022
+
+</td></tr><tr><td align="right">glassfish-v2-b43</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/glassfish/small.jnlp">Small</a>
+ </td><td align="right">146</td><td align="right">154</td><td align="right">964</td><td align="right">1,222</td><td align="right">2,176
+
+</td></tr><tr><td align="right">jboss-4.0.5</td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/index.html">All</a>
+ </td><td align="right">
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/index.jnlp">All</a>
+ <a href="http://findbugs.cs.umd.edu/demo/jboss/small.jnlp">Small</a>
+ </td><td align="right">30</td><td align="right">57</td><td align="right">263</td><td align="right">214</td><td align="right">178
+
+</td></tr></table>
+ <p>
+ <em>KNCSS</em> - Thousands of lines of non-commenting source
+ statements
+
+ </p>
+ <h1>
+ <a name="try">Try FindBugs now on your project!</a>
+ </h1>
+ <p>
+ Using Java Web Start you can try the GUI version of FindBugs now
+ on your project. As long as you have a 1.4 or better JRE
+ installed, you can
+ <a href="http://findbugs.cs.umd.edu/demo/jnlp/findbugs.jnlp">run
+ FindBugs now</a>. If you are using Java 1.5 or later, you will see
+ the new GUI that we wrote over the summer.
+ </p>
+
+ <h1>
+ <a name="changes">Change history</a>
+ </h1>
+ <p> The current version of FindBugs is s 1.3.0. Changes since version 1.2.1:</p>
+ <ul>
+ <li>New Detectors</li>
+ <ul>
+ <li>edu.umd.cs.findbugs.detect.NoteDirectlyRelevantTypeQualifiers</li>
+ <li>edu.umd.cs.findbugs.detect.ReflectiveClasses</li>
+ <li>edu.umd.cs.findbugs.detect.SynchronizationOnSharedBuiltinConstant</li>
+ <ul>
+ <li>DL_SYNCHRONIZATION_ON_SHARED_CONSTANT
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.OverridingEqualsNotSymmetrical</li>
+ <ul>
+ <li>EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.CheckTypeQualifiers</li>
+ <ul>
+ <li>TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED</li>
+ <li>TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED</li>
+ <li>TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK</li>
+ <li>TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK</li>
+ </ul>
+ </ul>
+ <li>New Reports (existing detectors)</li>
+ <ul>
+ <li>edu.umd.cs.findbugs.detect.FindHEmismatch</li>
+ <ul>
+ <li>EQ_DOESNT_OVERRIDE_EQUALS </li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.Naming
+ <ul>
+ <li>NM_WRONG_PACKAGE</li>
+ <li>NM_WRONG_PACKAGE_INTENTIONAL</li>
+ <li>NM_SAME_SIMPLE_NAME_AS_SUPERCLASS</li>
+ <li>NM_SAME_SIMPLE_NAME_AS_INTERFACE</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.FindRefComparison</li>
+ <ul>
+ <li>EC_UNRELATED_TYPES_USING_POINTER_EQUALITY</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.IncompatMask</li>
+ <ul>
+ <li>BIT_SIGNED_CHECK</li>
+ <li>BIT_SIGNED_CHECK_HIGH_BIT</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.LazyInit</li>
+ <ul>
+ <li>LI_LAZY_INIT_UPDATE_STATIC</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.FindDeadLocalStores</li>
+ <ul>
+ <li>DLS_DEAD_STORE_OF_CLASS_LITERAL</li>
+ </ul>
+ <li>edu.umd.cs.findbugs.detect.MethodReturnCheck</li>
+ <ul>
+ <li>RV_RETURN_VALUE_IGNORED_BAD_PRACTICE</li>
+ <li>RV_EXCEPTION_NOT_THROWN</li>
+ </ul>
+ </ul>
+ <li>Changes to Existing Reports</li>
+ <ul>
+ <li>NS_NON_SHORT_CIRCUIT: BAD_PRACTICE -> STYLE</li>
+ <li>NS_DANGEROUS_NON_SHORT_CIRCUIT: CORRECTNESS -> STYLE</li>
+ <li>RC_REF_COMPARISON: CORRECTNESS -> BAD_PRACTICE</li>
+ </ul>
+ <li>GUI Changes</li>
+ <ul>
+ <li>Added importing and exporting of bug filters</li>
+ <li>Better handling of failed analysis runs</li>
+ <li>Added "-look" parameter for selecting look-and-feel</li>
+ <li>Fixed incorrect package filtering</li>
+ <li>Fixed issue where "synchronized" was not syntax-highlighted</li>
+ </ul>
+ <li>Ant-task Changes</li>
+ <ul>
+ <li>Refactored common ant-task code to AbstractFindBugsTask</li>
+ <li>Added tasks for computeBugHistory, convertXmlToText, filterBugs, mineBugHistory, setBugDatabaseInfo</li>
+ </ul>
+ <li>Manual</li>
+ <ul>
+ <li>Updates to GUI section, including new screenshots</li>
+ <li>Added description of rejarForAnalysis</li>
+ <li>Revamp of data-mining section</li>
+ </ul>
+ <li>Other Major</li>
+ <ul>
+ <li>Internal restructuring for lower memory overhead</li>
+ </ul>
+ <li>Other Minor</li>
+ <ul>
+ <li>Fixed typo: was STCAL_STATIC_SIMPLE_DATA_FORMAT_INSTANCE now STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE</li>
+ <li>-outputFile parameter became -output</li>
+ <li>More sensitivity and specificity inLazyInit detector</li>
+ <li>More sensitivity and specificity in Naming detector</li>
+ <li>More sensitivity and specificity in UnreadFields detector</li>
+ <li>More sensitivity in FindNullDeref detector</li>
+ <li>More sensitivity in FindBadCast2 detector</li>
+ <li>More specificity in FindReturnRef detector</li>
+ <li>Many other tweaks and bugfixes</li>
+ </ul>
+ </ul>
+
+ <p>
+ <a href="Changes.html">Older versions...</a>
+ </p>
+
+ <h1>
+ <a name="talks">Talks about FindBugs</a>
+ </h1>
+ <ul>
+ <li>
+ <a href="http://findbugs.cs.umd.edu/talks/findbugs.mov">Quicktime
+ movie</a> showing of demo of our new GUI to view some of the null
+ pointer bugs in Eclipse (Big file warning: 23 Megabytes)
+
+ </li>
+ <li><a href="http://findbugs.cs.umd.edu/talks/JavaOne2007-TS2007.pdf">JavaOne 2007 talk on Improving Software Quality Using Static Analysis</a>
+ <li>
+ <a href="http://findbugs.cs.umd.edu/talks/fb-sdbp-2006.pdf">Talk</a>
+ Bill Pugh gave at
+ <a href="http://www.sdexpo.com/2006/sdbp/">SD Best Practices</a>,
+ Sept 14th (more of a handle on tutorial about using FindBugs)
+ </li>
+ <li>
+ <a href="http://findbugs.cs.umd.edu/talks/fb-Sept1213-2006.pdf">Talk</a>
+ Bill Pugh gave at
+ <a href="http://itasoftware.com/">ITA Software</a> and
+ <a href="http://www.csail.mit.edu/">MIT</a>, Sept 12th and 13th
+ (more of a research focus)
+ </li>
+ <li>
+ <a
+ href="http://video.google.com/videoplay?docid=-8150751070230264609">Video
+ of talk</a> Bill Pugh gave at
+ <a href="http://www.google.com">Google</a>, July 6th, 2006
+ </li>
+ <li>
+ <a href="http://javaposse.com/index.php?post_id=95780">Java
+ Posse podcast interview with Bill Pugh and Brian Goetz</a>
+ </li>
+ </ul>
+ <h1><a name="papers">Papers about FindBugs</a></h1>
+ <ul>
+ <li><a href="http://findbugs.cs.umd.edu/papers/MoreNullPointerBugs07.pdf">Finding More Null Pointer Bugs,
+ But Not Too Many</a>, by
+ <a href="http://faculty.ycp.edu/~dhovemey/">David Hovemeyer</a>, York College of Pennsylvania
+ and <a href="http://www.cs.umd.edu/~pugh/">William Pugh</a>, Univ. of Maryland,
+ <a href="http://paste07.cs.washington.edu/">7th ACM SIGPLAN-SIGSOFT Workshop on Program Analysis for Software Tools and Engineering</a>,
+ June, 2007
+
+ <li><a href="http://findbugs.cs.umd.edu/papers/FindBugsExperiences07.pdf">Evaluating Static Analysis
+ Defect Warnings On Production Software,</a>
+ <a href="http://www.cs.umd.edu/~nat/">Nathaniel Ayewah and <a href="http://www.cs.umd.edu/~pugh/">William Pugh</a>, Univ. of Maryland, and
+ J. David Morgenthaler, John Penix and YuQian Zhou, Google, Inc.,
+ <a href="http://paste07.cs.washington.edu/">7th ACM SIGPLAN-SIGSOFT Workshop on Program Analysis for Software Tools and Engineering</a>,
+ June, 2007
+ </ul>
+
+
+ <h1>
+ <a name="sponsors">Sponsors</a>
+ </h1>
+ <p>
+ Financial support for the open source FindBugs project is provided by our sponsors,
+ <a
+ href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs">Fortify
+ Software</a>, amd <a
+ href="http://www.surelogic.com/">SureLogic</a>,
+ <p>
+ <a
+ href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs">Fortify Software</a> sells security tools,
+ including Fortify Source Code Analysis, which which uses static
+ analysis to search for security vulnerabilities (much as FindBugs
+ uses static analysis to look for general code quality problems.
+ FindBugs is integrated into Fortify's tools, providing an
+ integrated tool set to look for and audit both security and
+ quality problems (<a href="pressRelease.pdf">press release</a>).
+ </p>
+
+ <p>
+ <a
+ href="http://www.surelogic.com/">SureLogic</a> provides a suite of static and dynamic tools designed
+ to find concurrency errors, such as data races and design errors. Starting Fall 2007, SureLogic will provide
+ training, consulting and support for FindBugs on a commercial basis, and will be contributing to the FindBugs open source effort.
+ </p>
+ <p>
+ Fortify Software now provides
+ <a href="http://opensource.fortifysoftware.com/">Java Open
+ Review, a free analysis and on-line reviewing service</a> to selected
+ open source projects. This provides analysis for both correctness
+ issues identified by FindBugs and security issues (such as SQL
+ injection and Cross-site scripting identified by Fortify's
+ <a
+ href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs">Source
+ Code Analysis</a>, and provides a on-line auditing and commenting
+ facility for contributors of each project. Defect warnings are not
+ visible to the general public, only to contributors of each
+ project. There is a place on the web page where you can request
+ that your project be included in the set of projects reviewed.
+ </p>
+ <h1><a name="support">Additional Support</a></h1>
+ <p>
+ YourKit is kindly supporting open source projects with its full-featured Java Profiler.
+ YourKit, LLC is creator of innovative and intelligent tools for profiling
+ Java and .NET applications. Take a look at YourKit's leading software products:
+ <a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a> and
+ <a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>.
+ </p>
+ <p>
+ Additional financial support for the FindBugs project has been provided by
+ <a href="http://www.google.com">Google</a>,
+ <a href="http://www.sun.com">Sun Microsystems</a>,
+ <a href="http://www.nsf.gov">National Science Foundation</a>
+ grants ASC9720199 and CCR-0098162, and by a 2004
+ <a
+ href="http://www-306.ibm.com/software/info/university/products/eclipse/eig-2004.html">IBM
+ Eclipse Innovation award</a>.
+ </p>
+ <p>
+ Any opinions, findings and conclusions or recommendations
+ expressed in this material are those of the author(s) and do not
+ necessarily reflect the views of the National Science Foundation
+ (NSF).
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+ </p>
+ </td>
+ </tr>
+ </table>
+
+ </body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs Links</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs Links</h1>
+
+<p> This page contains links to related projects,
+including tools that are similar to FindBugs.
+
+<h2>FindBugs Add-Ons</h2>
+
+<ul>
+<li> <a href="http://fb-contrib.sourceforge.net/">fb-contrib</a>: additional bug detectors for use with
+ FindBugs. The lead FindBugs team does not vouch for the relevance, accuracy or wisdom of the warnings
+ generated by any third-party plugin.
+<li> <a href="http://www.tobject.de/development/findbugs.html">FindBugs Eclipse plugin</a>.
+ This is now included as part of FindBugs.
+<li> <a href="http://maven-plugins.sourceforge.net/maven-findbugs-plugin/index.html">Maven FindBugs plugin</a>.
+ Maven is a Java project management and project comprehension tool.
+ The Maven FindBugs plugin allows FindBugs reports to be generated
+ from within Maven.
+<li> <a href="http://qalab.sourceforge.net/">QALab</a> records and aggregates
+ the results of static analysis (including FindBugs results)
+ over time. Features include charts of warnings over time
+ and summary reports showing hot spots in the source code.</li>
+</ul>
+
+<h2>Similar Tools</h2>
+
+<h3>Open source tools</h3>
+
+<ul>
+<li> <a href="http://artho.com/jlint/index.shtml">JLint</a>. A static analysis tool
+ to find race conditions, locking errors, null pointer uses,
+ and a number of other problems in Java programs.
+<li> <a href="http://pmd.sourceforge.net/">PMD</a>. PMD scans Java
+ source code for potential problems.
+<li> <a href="http://checkstyle.sourceforge.net/">Checkstyle</a>.
+ Checkstyle is a style checker for Java.
+</ul>
+
+<h3>Commercial tools and services</h3>
+
+<ul>
+<li> <a href="http://www.jutils.com">lint4j</a>: lint tool for Java programs
+<li> <a href="http://www.parasoft.com/">JTest</a>: automatically generates
+ <a href="http://junit.org/">JUnit</a> tests for Java classes.
+ Also checks for many kinds of coding errors.
+<li> <a href="http://www.sureshotsoftware.com/javalint/">JiveLint</a>. Another
+ lint utility for Java programs. Finds hashcode/equals problems,
+ string reference comparisions, and more. Free 15 day demo.
+<li> <a href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs">Fortify Software</a>:
+ provides static analysis tools that check applications
+ for security vunerabilities.
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs Mailing Lists</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs Mailing Lists</h1>
+
+<p> There are two mailing lists for FindBugs.
+<ul>
+<li> <a href="http://www.cs.umd.edu/mailman/listinfo/findbugs-announce">Findbugs-announce</a>
+is a low volume (moderated) list for announcements of new releases.
+</li><li> <a href="http://www.cs.umd.edu/mailman/listinfo/findbugs-discuss">Findbugs-discuss</a>
+is for discussion of planned features, bugs, development issues, etc. Note
+that you must be a subscriber in order to post messages to the list.
+</li>
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "file:../etc/docbook/docbookx.dtd" [
+<!ENTITY FindBugs "<application>FindBugs</application>">
+<!ENTITY Ant "<application>Ant</application>">
+<!ENTITY Saxon "<application>Saxon</application>">
+<!ENTITY FBHome "<replaceable>$FINDBUGS_HOME</replaceable>">
+<!ENTITY nbsp " ">
+]>
+
+<book lang="en" id="findbugs-manual">
+
+<bookinfo>
+<title>&FindBugs;™ Manual</title>
+
+<authorgroup>
+ <author>
+ <firstname>David</firstname>
+ <othername>H.</othername>
+ <surname>Hovemeyer</surname>
+ </author>
+ <author>
+ <firstname>William</firstname>
+ <othername>W.</othername>
+ <surname>Pugh</surname>
+ </author>
+</authorgroup>
+
+<copyright>
+ <year>2003</year>
+ <year>2004</year>
+ <year>2005</year>
+ <year>2006</year>
+ <holder>University of Maryland</holder>
+</copyright>
+
+<legalnotice>
+<para>
+This manual is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License.
+To view a copy of this license, visit
+<ulink url="http://creativecommons.org/licenses/by-nc-sa/1.0/">http://creativecommons.org/licenses/by-nc-sa/1.0/</ulink>
+or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.
+</para>
+<para>
+The name FindBugs and the FindBugs logo is trademarked by the University of Maryland.
+</para>
+</legalnotice>
+
+<edition>1.3.0</edition>
+
+<pubdate>09:39:09 EST, 08 November, 2007</pubdate>
+
+</bookinfo>
+
+<!--
+ **************************************************************************
+ Introduction
+ **************************************************************************
+-->
+
+<chapter id="introduction">
+<title>Introduction</title>
+
+<para> &FindBugs;™ is a program to find bugs in Java programs. It looks for instances
+of "bug patterns" --- code instances that are likely to be errors.</para>
+
+<para> This document describes version 1.3.0 of &FindBugs;. This is an
+early release of the tool, so you may find problems with it. We
+are very interested in getting your feedback on &FindBugs;. Please visit
+the <ulink url="http://findbugs.sourceforge.net">&FindBugs; web page</ulink> for
+the latest information on &FindBugs;, contact information, and support resources such
+as information about the &FindBugs; mailing lists.</para>
+
+<sect1>
+<title>Requirements</title>
+<para> To use &FindBugs;, you need a runtime environment compatible with
+<ulink url="http://java.sun.com/j2se">Java 2 Standard Edition</ulink>, version 1.4.0 or later.
+&FindBugs; is platform independent, and is known to run on GNU/Linux, Windows, and
+MacOS X platforms.</para>
+
+<para>You should have at least 512 MB of memory to use &FindBugs;.
+To analyze very large projects, more memory may be needed.</para>
+</sect1>
+
+</chapter>
+
+<!--
+ **************************************************************************
+ Installing FindBugs
+ **************************************************************************
+-->
+
+<chapter id="installing">
+<title>Installing and Running &FindBugs;™</title>
+
+<para>
+This chapter explains how to install and run &FindBugs;.
+</para>
+
+<sect1>
+<title>Extracting the Distribution</title>
+
+<para>
+The easiest way to install &FindBugs; is to download a binary distribution.
+Binary distributions are available in
+<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.tar.gz?download">gzipped tar format</ulink> and
+<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.zip?download">zip format</ulink>.
+Once you have downloaded a binary distribution, extract it into a directory of your choice.
+</para>
+
+<para>
+Extracting a gzipped tar format distribution:
+<screen>
+<prompt>$ </prompt><command>gunzip -c findbugs-1.3.0.tar.gz | tar xvf -</command>
+</screen>
+</para>
+
+<para>
+Extracting a zip format distribution:
+<screen>
+<prompt>C:\Software></prompt><command>unzip findbugs-1.3.0.zip</command>
+</screen>
+</para>
+
+<para>
+Usually, extracting a binary distribution will create a directory ending in
+<filename class="directory">findbugs-1.3.0</filename>. For example, if you extracted
+the binary distribution from the <filename class="directory">C:\Software</filename>
+directory, then the &FindBugs; software will be extracted into the directory
+<filename class="directory">C:\Software\findbugs-1.3.0</filename>.
+This directory is the &FindBugs; home directory. We'll refer to it as
+&FBHome; throughout this manual.
+</para>
+</sect1>
+
+<sect1>
+<title>Configuration</title>
+
+<para>
+Once you have extracted the binary distribution, all you need to do in order
+to run &FindBugs; is to invoke the wrapper script.
+</para>
+
+<para>
+On Unix-like systems, use the following command to invoke the wrapper script:
+<screen>
+<prompt>$ </prompt><command>&FBHome;/bin/findbugs <replaceable>options...</replaceable></command>
+</screen>
+</para>
+
+<para>
+On Windows systems, the command to invoke the wrapper script is
+<screen>
+<prompt>C:\My Directory></prompt><command>&FBHome;\bin\findbugs.bat <replaceable>options...</replaceable></command>
+</screen>
+</para>
+
+<para>
+On both Unix-like and Windows systems, you can simply add the <filename><replaceable>$FINDBUGS_HOME</replaceable>/bin</filename>
+directory to your <filename>PATH</filename> environment variable and then invoke
+FindBugs using the <command>findbugs</command> command.
+</para>
+
+</sect1>
+
+<sect1 id="commandLineOptions">
+<title>Command Line Options</title>
+
+<para>
+
+There are two ways to invoke &FindBugs;. The first invokes the the Graphical User Interface (GUI):
+
+<screen>
+<prompt>$ </prompt><command>findbugs <replaceable>[standard options]</replaceable> <replaceable>[GUI options]</replaceable></command>
+</screen>
+
+The second invokes the Command Line Interface (Text UI):
+
+<screen>
+<prompt>$ </prompt><command>findbugs -textui <replaceable>[standard options]</replaceable> <replaceable>[Text UI options]</replaceable></command>
+</screen>
+</para>
+
+<sect2>
+<title>Standard options</title>
+
+<para>
+These options may be used with both the GUI and Text UI.
+
+<variablelist>
+ <varlistentry>
+ <term><command>-jvmArgs <replaceable>args</replaceable></command></term>
+ <listitem>
+ <para>
+ Specifies arguments to pass to the JVM. For example, you might want
+ to set a JVM property:
+<screen>
+<prompt>$ </prompt><command>findbugs -textui -jvmArgs "-Duser.language=ja" <replaceable>myApp.jar</replaceable></command>
+</screen>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-javahome <replaceable>directory</replaceable></command></term>
+ <listitem>
+ <para>
+ Specifies the directory containing the JRE (Java Runtime Environment) to
+ use to execute &FindBugs;.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-maxHeap <replaceable>size</replaceable></command></term>
+ <listitem>
+ <para>
+ Specifies the maximum Java heap size in megabytes. The default is 256.
+ More memory may be required to analyze very large programs or libraries.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-debug</command></term>
+ <listitem>
+ <para>
+ Prints a trace of detectors run and classes analyzed to standard output.
+ Useful for troubleshooting unexpected analysis failures.
+ </para>
+ </listitem>
+ </varlistentry>
+<!--
+ <varlistentry>
+ <term><command>-conserveSpace</command></term>
+ <listitem>
+ <para>
+ This option disables analyses that increase precision but also
+ increase memory consumption. You may want to try this option if
+ you find that &FindBugs; runs out of memory, or takes an unusually
+ long time to complete its analysis.
+ </para>
+ </listitem>
+ </varlistentry>
+-->
+ <varlistentry>
+ <term><command>-effort:min</command></term>
+ <listitem>
+ <para>
+ This option disables analyses that increase precision but also
+ increase memory consumption. You may want to try this option if
+ you find that &FindBugs; runs out of memory, or takes an unusually
+ long time to complete its analysis.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-effort:max</command></term>
+ <listitem>
+ <para>
+ Enable analyses which increase precision and find more bugs, but which
+ may require more memory and take more time to complete.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-property</command> <replaceable>name=value</replaceable></term>
+ <listitem>
+ <para>
+ This option sets a system property. &FindBugs; uses system properties
+ to configure analysis options. See <xref linkend="analysisprops"/>.
+ You can use this option multiple times in order to set multiple properties.
+ Note: In most versions of Windows, the <replaceable>name=value</replaceable>
+ string must be in quotes.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-project</command> <replaceable>project</replaceable></term>
+ <listitem>
+ <para>
+ Specify a project to be analyzed. The project file you specify should
+ be one that was created using the GUI interface. It will typically end
+ in the extension <filename>.fb</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+</variablelist>
+</para>
+
+</sect2>
+
+<sect2>
+<title>GUI Options</title>
+
+<para>
+These options are only accepted by the Graphical User Interface.
+
+<variablelist>
+ <varlistentry>
+ <term><command>-look:</command><replaceable>plastic|gtk|native</replaceable></term>
+ <listitem>
+ <para>
+ Set Swing look and feel.
+ </para>
+ </listitem>
+ </varlistentry>
+
+</variablelist>
+</para>
+</sect2>
+
+<sect2>
+<title>Text UI Options</title>
+
+<para>
+These options are only accepted by the Text User Interface.
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term><command>-sortByClass</command></term>
+ <listitem>
+ <para>
+ Sort reported bug instances by class name.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command >-include</command> <replaceable>filterFile.xml</replaceable></term>
+ <listitem>
+ <para>
+ Only report bug instances that match the filter specified by <replaceable>filterFile.xml</replaceable>.
+ See <xref linkend="filter" />.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command >-exclude</command> <replaceable>filterFile.xml</replaceable></term>
+ <listitem>
+ <para>
+ Report all bug instances except those matching the filter specified by <replaceable>filterFile.xml</replaceable>.
+ See <xref linkend="filter" />.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-onlyAnalyze</command> <replaceable>com.foobar.MyClass,com.foobar.mypkg.*</replaceable></term>
+ <listitem>
+ <para>
+ Restrict analysis to find bugs to given comma-separated list of
+ classes and packages.
+ Unlike filtering, this option avoids running analysis on
+ classes and packages that are not explicitly matched:
+ for large projects, this may greatly reduce the amount of time
+ needed to run the analysis. (However, some detectors may produce
+ inaccurate results if they aren't run on the entire application.)
+ Classes should be specified using their full classnames (including
+ package), and packages should be specified in the same way
+ they would in a Java <literal>import</literal> statement to
+ import all classes in the package (i.e., add <literal>.*</literal>
+ to the full name of the package).
+ Replace <literal>.*</literal> with <literal>.-</literal> to also
+ analyze all subpackages.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-low</command></term>
+ <listitem>
+ <para>
+ Report all bugs.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-medium</command></term>
+ <listitem>
+ <para>
+ Report medium and high priority bugs. This is the default setting.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-high</command></term>
+ <listitem>
+ <para>
+ Report only high priority bugs.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-relaxed</command></term>
+ <listitem>
+ <para>
+ Relaxed reporting mode. For many detectors, this option
+ suppresses the heuristics used to avoid reporting false positives.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-xml</command></term>
+ <listitem>
+ <para>
+ Produce the bug reports as XML. The XML data produced may be
+ viewed in the GUI at a later time. You may also specify this
+ option as <command>-xml:withMessages</command>; when this variant
+ of the option is used, the XML output will contain human-readable
+ messages describing the warnings contained in the file.
+ XML files generated this way are easy to transform into reports.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-html</command></term>
+ <listitem>
+ <para>
+ Generate HTML output. By default, &FindBugs; will use the <filename>default.xsl</filename>
+ <ulink url="http://www.w3.org/TR/xslt">XSLT</ulink>
+ stylesheet to generate the HTML: you can find this file in <filename>findbugs.jar</filename>,
+ or in the &FindBugs; source or binary distributions. Variants of this option include
+ <command>-html:plain.xsl</command>, <command>-html:fancy.xsl</command> and <command>-html:fancy-hist.xsl</command>.
+ The <filename>plain.xsl</filename> stylesheet does not use Javascript or DOM,
+ and may work better with older web browsers, or for printing. The <filename>fancy.xsl</filename>
+ stylesheet uses DOM and Javascript for navigation and CSS for
+ visual presentation. The <command>fancy-hist.xsl</command> an evolution of <command>fancy.xsl</command> stylesheet.
+ It makes an extensive use of DOM and Javascript for dynamically filtering the lists of bugs.
+ </para>
+
+ <para>
+ If you want to specify your own
+ XSLT stylesheet to perform the transformation to HTML, specify the option as
+ <command>-html:<replaceable>myStylesheet.xsl</replaceable></command>,
+ where <replaceable>myStylesheet.xsl</replaceable> is the filename of the
+ stylesheet you want to use.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-emacs</command></term>
+ <listitem>
+ <para>
+ Produce the bug reports in Emacs format.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-xdocs</command></term>
+ <listitem>
+ <para>
+ Produce the bug reports in xdoc XML format for use with Apache Maven.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-output</command> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Produce the output in the specified file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-outputFile</command> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ This argument is deprecated. Use <command>-output</command> instead.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-nested</command><replaceable>[:true|false]</replaceable></term>
+ <listitem>
+ <para>
+ This option enables or disables scanning of nested jar and zip files found in
+ the list of files and directories to be analyzed.
+ By default, scanning of nested jar/zip files is enabled.
+ To disable it, add <command>-nested:false</command> to the command line
+ arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>-auxclasspath</command> <replaceable>classpath</replaceable></term>
+ <listitem>
+ <para>
+ Set the auxiliary classpath for analysis. This classpath should include all
+ jar files and directories containing classes that are part of the program
+ being analyzed but you do not want to have analyzed for bugs.
+ </para>
+ </listitem>
+ </varlistentry>
+
+<!--
+ <varlistentry>
+ <term><command></command> <replaceable></replaceable></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+-->
+
+</variablelist>
+
+</sect2>
+</sect1>
+
+</chapter>
+
+<!--
+ **************************************************************************
+ Compiling FindBugs from Source
+ **************************************************************************
+-->
+
+<chapter id="building">
+<title>Building &FindBugs;™ from Source</title>
+
+<para>
+This chapter describes how to build &FindBugs; from source code. Unless you are
+interesting in modifying &FindBugs;, you will probably want to skip to the
+<link linkend="gui">next chapter</link>.
+</para>
+
+<sect1>
+<title>Prerequisites</title>
+
+<para>
+To compile &FindBugs; from source, you will need the following:
+<itemizedlist>
+ <listitem>
+ <para>
+ The <ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0-source.zip?download"
+ >&FindBugs; source distribution</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://java.sun.com/j2se/">JDK 1.5.0 beta or later</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://ant.apache.org/">Apache &Ant;</ulink>, version 1.6.3 or later
+ </para>
+ </listitem>
+</itemizedlist>
+</para>
+
+<warning>
+ <para>
+ The version of &Ant; included as <filename>/usr/bin/ant</filename> on
+ Redhat Linux systems will <emphasis>not</emphasis> work for compiling
+ &FindBugs;. We recommend you install a binary distribution of &Ant;
+ downloaded from the <ulink url="http://ant.apache.org/">&Ant; website</ulink>.
+ Make sure that when you run &Ant; your <replaceable>JAVA_HOME</replaceable>
+ environment variable points to the directory in which you installed
+ JDK 1.5 (or later).
+ </para>
+</warning>
+
+<para>
+If you want to be able to generate formatted versions of the &FindBugs; documentation,
+you will also need the following software:
+<itemizedlist>
+ <listitem>
+ <para>
+ The <ulink url="http://docbook.sourceforge.net/projects/xsl/index.html">DocBook XSL Stylesheets</ulink>.
+ These are required to convert the &FindBugs; manual into HTML and PDF formats.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The <ulink url="http://saxon.sourceforge.net/">&Saxon; XSLT Processor</ulink>.
+ The file <filename>saxon.jar</filename> should be in your <envar>CLASSPATH</envar>.
+ </para>
+ </listitem>
+<!--
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+-->
+</itemizedlist>
+</para>
+
+</sect1>
+
+<sect1>
+<title>Extracting the Source Distribution</title>
+<para>
+After you download the source distribution, you'll need to extract it into
+a working directory. A typical command to do this is:
+
+<screen>
+<prompt>$ </prompt><command>unzip findbugs-1.3.0-source.zip</command>
+</screen>
+
+</para>
+</sect1>
+
+<sect1>
+<title>Modifying <filename>build.properties</filename></title>
+<para>
+If you intend to build the FindBugs documentation,
+you will need to modify the <filename>build.properties</filename> file
+used by the <ulink url="http://ant.apache.org/">&Ant;</ulink>
+<filename>build.xml</filename> file to build &FindBugs;.
+If you do not want to build the FindBugs documentation, then you
+can ignore this file.
+</para>
+
+<para>
+The <filename>build.properties</filename> looks like this:
+<programlisting>
+<![CDATA[
+# User Configuration:
+# This section must be modified to reflect your system.
+
+local.software.home =/export/home/daveho/linux
+
+# Set this to the directory containing the DocBook Modular XSL Stylesheets
+# from http://docbook.sourceforge.net/projects/xsl/
+
+xsl.stylesheet.home =${local.software.home}/docbook/docbook-xsl-1.71.1
+
+# Set this to the directory where Saxon (http://saxon.sourceforge.net/)
+# is installed.
+
+saxon.home =${local.software.home}/java/saxon-6.5.5
+]]>
+</programlisting>
+</para>
+
+<para>
+The <varname>xsl.stylesheet.home</varname> property specifies the full
+path to the directory where you have installed the
+<ulink url="http://docbook.sourceforge.net/projects/xsl/">DocBook Modular XSL
+Stylesheets</ulink>. You only need to specify this property if you will be
+generating the &FindBugs; documentation.
+</para>
+
+<para>
+The <varname>saxon.home</varname> property is the full path to the
+directory where you installed the <ulink url="http://saxon.sourceforge.net/">&Saxon; XSLT Processor</ulink>.
+You only need to specify this property if you will be
+generating the &FindBugs; documentation.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Running &Ant;</title>
+
+<para>
+Once you have extracted the source distribution,
+made sure that &Ant; is installed,
+modified <filename>build.properties</filename> (optional),
+and configured the tools (such as &Saxon;),
+you are ready to build &FindBugs;. Invoking &Ant; is a simple matter
+of running the command
+<screen>
+<prompt>$ </prompt><command>ant <replaceable>target</replaceable></command>
+</screen>
+where <replaceable>target</replaceable> is one of the following:
+<variablelist>
+ <varlistentry>
+ <term><command>build</command></term>
+ <listitem>
+ <para>
+ This target compiles the code for &FindBugs;. It is the default target.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>docs</command></term>
+ <listitem>
+ <para>
+ This target formats the documentation. (It also compiles some of
+ the source code as a side-effect.)
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>runjunit</command></term>
+ <listitem>
+ <para>
+ This target compiles and runs the internal JUnit tests included
+ in &FindBugs;. It will print an error message if any unit
+ tests fail.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>bindist</command></term>
+ <listitem>
+ <para>
+ Builds a binary distribution of &FindBugs;.
+ The target creates both <filename>.zip</filename> and
+ <filename>.tar.gz</filename> archives.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</para>
+
+<para>
+After running an &Ant; command, you should see output similar to
+the following (after some other messages regarding the tasks that
+&Ant; is running):
+<screen>
+<computeroutput>
+BUILD SUCCESSFUL
+Total time: 17 seconds
+</computeroutput>
+</screen>
+</para>
+
+</sect1>
+
+<sect1>
+<title>Running &FindBugs;™</title>
+<para>
+The &Ant; build script for &FindBugs; is set up such that after
+building the <command>build</command> target, the working directory
+is set up just like a binary distribution. So, the information about
+installing a binary distribution of &FindBugs; in <xref linkend="installing" />
+applies to source distributions, too.
+</para>
+</sect1>
+
+</chapter>
+
+
+<!--
+ **************************************************************************
+ Using the FindBugs Graphical Interface
+ **************************************************************************
+-->
+
+<chapter id="gui">
+<title>Using the &FindBugs;™ Graphical User Interface</title>
+
+<para>
+&FindBugs; has two user interfaces: a graphical user interface (GUI) and a
+command line user interface. This chapter describes the graphical user interface.
+</para>
+
+<!--
+<sect1>
+<title>Executing the &FindBugs;™ GUI</title>
+</sect1>
+-->
+
+<sect1>
+<title>Creating a Project</title>
+<para>
+After you have started &FindBugs; using the <command>findbugs</command> command,
+choose the <menuchoice><guimenu>File</guimenu><guimenuitem>New Project</guimenuitem></menuchoice>
+menu item. You will see a dialog which looks like this:
+<mediaobject>
+<imageobject>
+<imagedata fileref="project-dialog.png" />
+</imageobject>
+</mediaobject>
+</para>
+
+<para>
+Use the "Add" button next to the "Class archives and directories to analyze" text field to select a Java archive
+file (zip, jar, ear, or war file) or directory containing java classes to analyze for bugs. You may add multiple
+archives/directories.
+</para>
+
+<para>
+You can also add the source directories which contain
+the source code for the Java archives you are analyzing. This will enable
+&FindBugs; to highlight the source code which contains a possible error.
+The source directories you add should be the roots of the Java
+package hierarchy. For example, if your application is contained in the
+<varname>org.foobar.myapp</varname> package, you should add the
+parent directory of the <filename class="directory">org</filename> directory
+to the source directory list for the project.
+</para>
+
+<para>
+Another optional step is to add additional Jar files or directories as
+"Auxiliary classpath locations" entries. You should do this if the archives and directories you are analyzing
+have references to other classes which are not included in the analyzed
+archives/directories and are not in the standard runtime classpath. Some of the bug
+pattern detectors in &FindBugs; make use of class hierarchy information,
+so you will get more accurate results if the entire class hierarchy is
+available which &FindBugs; performs its analysis.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Running the Analysis</title>
+<para>
+Once you have added all of the archives, directories, and source directories,
+click the "Finish" button to analyze the classes contained in the
+Jar files. Note that for a very large program on an older computer,
+this may take quite a while (tens of minutes). A recent computer with
+ample memory will typically be able to analyze a large program in only a
+few minutes.
+</para>
+</sect1>
+
+<sect1>
+<title>Browsing Results</title>
+
+<para>
+When the analysis completes, you will see a screen like the following:
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="example-details.png" />
+ </imageobject>
+</mediaobject>
+</para>
+
+<para>
+The upper left-hand pane of the window shows the bug tree; this is a hierarchical
+representation of all of the potential bugs detected in the analyzed
+Jar files.
+</para>
+
+<para>
+When you select a particular bug instance in the top pane, you will
+see a description of the bug in the "Details" tab of the bottom pane.
+In addition, the source code pane on the upper-right will show the
+program source code where the potential bug occurs, if source is available.
+In the above example, the bug is a stream object that is not closed. The
+source code window highlights the line where the stream object is created.
+</para>
+
+<para>
+You may add a textual annotations to bug instances. To do so, type them
+into the text box just below the hierarchical view. You can type any
+information which you would like to record. When you load and save bug
+results files, the annotations are preserved.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Saving and Opening</title>
+
+<para>
+You may use the <menuchoice><guimenu>File</guimenu><guimenuitem>Save as...</guimenuitem></menuchoice>
+menu option to save your work. To save your work, including the jar
+file lists you specified and all bug results, choose
+"FindBugs analysis results (.xml)" from the drop-down list in the
+"Save as..." dialog. There are also options for saving just the jar
+file lists ("FindBugs project file (.fbp)") or just the results
+("FindBugs analysis file (.fba)"), but these are rarely needed. A
+saved file may be loaded with the
+<menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem></menuchoice>
+menu option.
+</para>
+
+</sect1>
+
+</chapter>
+
+
+
+<!--
+ **************************************************************************
+ Using the FindBugs Command Line Interface
+ **************************************************************************
+-->
+
+<chapter id="textui">
+<title>Using the &FindBugs;™ Command Line Interface</title>
+
+<para>
+The &FindBugs; Command Line Interface (or Text UI) can be used to
+analyze an application for bugs non-interactively. Each bug instance will be
+reported on a single line. All output is written to the standard output file descriptor.
+<xref linkend="filter" /> explains how bug reports may be filtered in order
+to get only the output you're interested in.
+</para>
+
+<para>
+See <xref linkend="commandLineOptions" /> in <xref linkend="installing" /> for a description of how to invoke the
+Command Line Interface.
+</para>
+
+
+</chapter>
+
+
+<!--
+ **************************************************************************
+ Using the FindBugs Ant task
+ **************************************************************************
+-->
+
+<chapter id="anttask">
+<title>Using the &FindBugs;™ &Ant; task</title>
+
+<para>
+This chapter describes how to integrate &FindBugs; into a build script
+for <ulink url="http://ant.apache.org/">&Ant;</ulink>, which is a popular Java build
+and deployment tool. Using the &FindBugs; &Ant; task, your build script can
+automatically run &FindBugs; on your Java code.
+</para>
+
+<para>
+The &Ant; task was generously contributed by Mike Fagan.
+</para>
+
+<sect1>
+<title>Installing the &Ant; task</title>
+
+<para>
+To install the &Ant; task, simply copy <filename>&FBHome;/lib/findbugs-ant.jar</filename>
+into the <filename>lib</filename> subdirectory of your &Ant; installation.
+
+<note>
+<para>It is strongly recommended that you use the &Ant; task with the version
+of &FindBugs; it was included with. We do not guarantee that the &Ant; task Jar file
+will work with any version of &FindBugs; other than the one it was included with.</para>
+</note>
+</para>
+
+</sect1>
+
+<sect1>
+<title>Modifying build.xml</title>
+
+<para>
+To incorporate &FindBugs; into <filename>build.xml</filename> (the build script
+for &Ant;), you first need to add a task definition. This should appear as follows:
+
+<screen>
+ <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask"/>
+</screen>
+
+The task definition specifies that when a <literal>findbugs</literal> element is
+seen in <filename>build.xml</filename>, it should use the indicated class to execute the task.
+</para>
+
+<para>
+After you have added the task definition, you can define a target
+which uses the <literal>findbugs</literal> task. Here is an example
+which could be added to the <filename>build.xml</filename> for the
+Apache <ulink url="http://jakarta.apache.org/bcel/">BCEL</ulink> library.
+
+<screen>
+ <property name="findbugs.home" value="/export/home/daveho/work/findbugs" />
+
+ <target name="findbugs" depends="jar">
+ <findbugs home="${findbugs.home}"
+ output="xml"
+ outputFile="bcel-fb.xml" >
+ <auxClasspath path="${basedir}/lib/Regex.jar" />
+ <sourcePath path="${basedir}/src/java" />
+ <class location="${basedir}/bin/bcel.jar" />
+ </findbugs>
+ </target>
+</screen>
+
+The <literal>findbugs</literal> element must have the <literal>home</literal>
+attribute set to the directory in which &FindBugs; is installed; in other words,
+&FBHome;. See <xref linkend="installing" />.
+</para>
+
+<para>
+This target will execute &FindBugs; on <filename>bcel.jar</filename>, which is the
+Jar file produced by BCEL's build script. (By making it depend on the "jar"
+target, we ensure that the library is fully compiled before running &FindBugs; on it.)
+The output of &FindBugs; will be saved in XML format to a file called
+<filename>bcel-fb.xml</filename>.
+An auxiliary Jar file, <filename>Regex.jar</filename>, is added to the aux classpath,
+because it is referenced by the main BCEL library. A source path is specified
+so that the saved bug data will have accurate references to the BCEL source code.
+</para>
+</sect1>
+
+<sect1>
+<title>Executing the task</title>
+
+<para>
+Here is an example of invoking &Ant; from the command line, using the <literal>findbugs</literal>
+target defined above.
+
+<screen>
+ <prompt>[daveho@noir]$</prompt> <command>ant findbugs</command>
+ Buildfile: build.xml
+
+ init:
+
+ compile:
+
+ examples:
+
+ jar:
+
+ findbugs:
+ [findbugs] Running FindBugs...
+ [findbugs] Bugs were found
+ [findbugs] Output saved to bcel-fb.xml
+
+ BUILD SUCCESSFUL
+ Total time: 35 seconds
+</screen>
+
+In this case, because we saved the bug results in an XML file, we can
+use the &FindBugs; GUI to view the results; see <xref linkend="gui"/>.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Parameters</title>
+
+<para>This section describes the parameters that may be specified when
+using the &FindBugs; task.
+
+<variablelist>
+
+ <varlistentry>
+ <term><literal>class</literal></term>
+ <listitem>
+ <para>
+ A nested element specifying which classes to analyze. The <literal>class</literal>
+ element must specify a <literal>location</literal> attribute which names the
+ archive file (jar, zip, etc.), directory, or class file to be analyzed. Multiple <literal>class</literal>
+ elements may be specified as children of a single <literal>findbugs</literal> element.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>auxClasspath</literal></term>
+ <listitem>
+ <para>
+ An optional nested element which specifies a classpath (Jar files or directories)
+ containing classes used by the analyzed library or application, but which
+ you don't want to analyze. It is specified the same way as
+ &Ant;'s <literal>classpath</literal> element for the Java task.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>sourcePath</literal></term>
+ <listitem>
+ <para>
+ An optional nested element which specifies a source directory path
+ containing source files used to compile the Java code being analyzed.
+ By specifying a source path, any generated XML bug output will have
+ complete source information, which allows later viewing in the
+ GUI.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>home</literal></term>
+ <listitem>
+ <para>
+ A required attribute.
+ It must be set to the name of the directory where &FindBugs; is installed.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>quietErrors</literal></term>
+ <listitem>
+ <para>
+ An optional boolean attribute.
+ If true, reports of serious analysis errors and missing classes will
+ be suppressed in the &FindBugs; output. Default is false.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>reportLevel</literal></term>
+ <listitem>
+ <para>
+ An optional attribute. It specifies
+ the priority threshold for reporting bugs. If set to "low", all bugs are reported.
+ If set to "medium" (the default), medium and high priority bugs are reported.
+ If set to "high", only high priority bugs are reported.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>output</literal></term>
+ <listitem>
+ <para>
+ Optional attribute.
+ It specifies the output format. If set to "xml" (the default), output
+ is in XML format.
+ If set to "xml:withMessages", output is in XML format augmented with
+ human-readable messages. (You should use this format if you plan
+ to generate a report using an XSL stylesheet.)
+ If set to "html", output is in HTML formatted (default stylesheet is default.xsl).
+ If set to "text", output is in ad-hoc text format.
+ If set to "emacs", output is in <ulink url="http://www.gnu.org/software/emacs/">Emacs</ulink> error message format.
+ If set to "xdocs", output is xdoc XML for use with Apache Maven.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>stylesheet</literal></term>
+ <listitem>
+ <para>
+ Optional attribute.
+ It specifies the stylesheet to use to generate html output when the output is set to html.
+ Stylesheets included in the FindBugs distribution include default.xsl, fancy.xsl, fancy-hist.xsl, plain.xsl, and summary.xsl.
+ The default value, if no stylesheet attribute is provided, is default.xsl.
+
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>sort</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. If the <literal>output</literal> attribute
+ is set to "text", then the <literal>sort</literal> attribute specifies
+ whether or not reported bugs are sorted by class. Default is true.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>outputFile</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. If specified, names the output file in which the
+ &FindBugs; output will be saved. By default, the output is displayed
+ directly by &Ant;.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>debug</literal></term>
+ <listitem>
+ <para>
+ Optional boolean attribute. If set to true, &FindBugs; prints diagnostic
+ information about which classes are being analyzed, and which bug pattern
+ detectors are being run. Default is false.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>effort</literal></term>
+ <listitem>
+ <para>
+ Set the analysis effort level. The value specified should be
+ one of <literal>min</literal>, <literal>default</literal>,
+ or <literal>max</literal>. See <xref linkend="commandLineOptions"/>
+ for more information about setting the analysis level.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>conserveSpace</literal></term>
+ <listitem>
+ <para>Synonym for effort="min".</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>workHard</literal></term>
+ <listitem>
+ <para>Synonym for effort="max".</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>visitors</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies a comma-separated list of bug detectors
+ which should be run. The bug detectors are specified by their class names,
+ without any package qualification. By default, all detectors which are
+ not disabled by default are run.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>omitVisitors</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It is like the <literal>visitors</literal> attribute,
+ except it specifies detectors which will <emphasis>not</emphasis> be run.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>excludeFilter</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies the filename of a filter specifying bugs
+ to exclude from being reported. See <xref linkend="filter" />.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>includeFilter</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies the filename of a filter specifying
+ which bugs are reported. See <xref linkend="filter" />.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>projectFile</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies the name of a project file.
+ Project files are created by the &FindBugs; GUI, and specify classes,
+ aux classpath entries, and source directories. By naming a project,
+ you don't need to specify any <literal>class</literal> elements,
+ nor do you need to specify <literal>auxClasspath</literal> or
+ <literal>sourcePath</literal> attributes.
+ See <xref linkend="gui"/> for how to create a project.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>jvmargs</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies any arguments that should be passed
+ to the Java virtual machine used to run &FindBugs;. You may need to
+ use this attribute to specify flags to increase the amount of memory
+ the JVM may use if you are analyzing a very large program.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>systemProperty</literal></term>
+ <listitem>
+ <para>
+ Optional nested element. If specified, defines a system property.
+ The <literal>name</literal> attribute specifies the name of the
+ system property, and the <literal>value</literal> attribute specifies
+ the value of the system property.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>timeout</literal></term>
+ <listitem>
+ <para>
+ Optional attribute. It specifies the amount of time, in milliseconds,
+ that the Java process executing &FindBugs; may run before it is
+ assumed to be hung and is terminated. The default is 600,000
+ milliseconds, which is ten minutes. Note that for very large
+ programs, &FindBugs; may require more than ten minutes to complete its
+ analysis.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>failOnError</literal></term>
+ <listitem>
+ <para>
+ Optional boolean attribute. Whether to abort the build process if there is an
+ error running &FindBugs;. Defaults to "false"
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>errorProperty</literal></term>
+ <listitem>
+ <para>
+ Optional attribute which specifies the name of a property that
+ will be set to "true" if an error occurs while running &FindBugs;.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>warningsProperty</literal></term>
+ <listitem>
+ <para>
+ Optional attribute which specifies the name of a property
+ that will be set to "true" if any warnings are reported by
+ &FindBugs; on the analyzed program.
+ </para>
+ </listitem>
+ </varlistentry>
+
+</variablelist>
+
+
+</para>
+
+<!--
+
+-->
+
+</sect1>
+
+</chapter>
+
+<!--
+ **************************************************************************
+ Using the FindBugs Eclipse plugin
+ **************************************************************************
+-->
+
+<chapter id="eclipse">
+<title>Using the &FindBugs;™ Eclipse plugin</title>
+
+<para>
+The FindBugs Eclipse plugin allows &FindBugs; to be used within
+the <ulink url="http://www.eclipse.org/">Eclipse</ulink> IDE.
+The FindBugs Eclipse plugin was generously contributed by Peter Friese.
+Phil Crosby and Andrei Loskutov contributed major improvements
+to the plugin.
+</para>
+
+<sect1>
+<title>Requirements</title>
+
+<para>
+To use the &FindBugs; Plugin for Eclipse, you need Eclipse 3.0.1 or later,
+and JRE/JDK 1.4.0 or later.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Installation</title>
+
+<para>
+ We provide update sites that allow you to automatically install FindBugs into Eclipse and also query and install updates.
+ There are three different update sites</para>
+
+ <variablelist><title>FindBugs Eclipse update sites</title>
+ <varlistentry><term><ulink url="http://findbugs.cs.umd.edu/eclipse/">http://findbugs.cs.umd.edu/eclipse/</ulink></term>
+
+ <listitem>
+ <para>
+ Only provides official releases of FindBugs.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term><ulink url="http://findbugs.cs.umd.edu/eclipse-candidate/">http://findbugs.cs.umd.edu/eclips-candidate/</ulink></term>
+
+ <listitem>
+ <para>
+ Provides official releases and release candidates of FindBugs.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term><ulink url="http://findbugs.cs.umd.edu/eclipse-daily/">http://findbugs.cs.umd.edu/eclipse-daily/</ulink></term>
+
+ <listitem>
+ <para>
+ Provides the daily build of FindBugs. No testing other than that it compiles.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+<para>You can also manually
+download the plugin from the following link:
+<ulink url="http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip?download"
+>http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip?download</ulink>.
+Extract it in Eclipse's "plugins" subdirectory.
+(So <eclipse_install_dir>/plugins/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108/findbugs.png
+should be the path to the &FindBugs; logo.)
+
+</para>
+
+<para>
+Once the plugin is extracted, start Eclipse and choose
+<menuchoice>
+ <guimenu>Help</guimenu>
+ <guimenuitem>About Eclipse Platform</guimenuitem>
+ <guimenuitem>Plug-in Details</guimenuitem>
+</menuchoice>.
+You should find a plugin called "FindBugs Plug-in" provided by "FindBugs Project".
+</para>
+</sect1>
+
+<sect1>
+<title>Using the Plugin</title>
+
+<para>
+To get started, right click on a Java project,
+and select the option labeled "Find Bugs".
+&FindBugs; will run, and problem markers (displayed in source
+windows, and also in the Eclipse Problems view) will point to
+locations in your code which have been identified as potential instances
+of bug patterns.
+</para>
+
+<para>
+You may customize how &FindBugs; runs by opening the Properties
+dialog for a Java project, and choosing the "Findbugs" property page.
+Options you may choose include:
+</para>
+
+<itemizedlist>
+ <listitem>
+ <para>
+ Enable or disable the "Run FindBugs Automatically" checkbox.
+ When enabled, FindBugs will run every time you modify a Java class
+ within the project.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Choose minimum warning priority and enabled bug categories.
+ These options will choose which warnings are shown.
+ For example, if you select the "Medium" warning priority,
+ only Medium and High priority warnings will be shown.
+ Similarly, if you uncheck the "Style" checkbox, no warnings
+ in the Style category will be displayed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Select detectors. The table allows you to select which detectors
+ you want to enable for your project.
+ </para>
+ </listitem>
+</itemizedlist>
+
+</sect1>
+
+<sect1>
+<title>Troubleshooting</title>
+
+<para>
+The &FindBugs; Eclipse plugin is still experimental. This section
+lists common problems with the plugin and (if known) how to resolve them.
+</para>
+
+<itemizedlist>
+ <listitem>
+ <para>
+ If you do not see any &FindBugs; problem markers (in your source
+ windows or in the Problems View), you may need to change your
+ Problems View filter settings. See
+ <ulink url="http://findbugs.sourceforge.net/FAQ.html#q7">http://findbugs.sourceforge.net/FAQ.html#q7</ulink> for more information.
+ </para>
+ </listitem>
+
+</itemizedlist>
+
+</sect1>
+
+
+</chapter>
+
+
+<!--
+ **************************************************************************
+ Filter files
+ **************************************************************************
+-->
+
+<chapter id="filter">
+<title>Filter Files</title>
+
+<para>
+Filter files may be used to include or exclude bug reports for particular classes
+and methods. This chapter explains how to use filter files.
+
+<note>
+<title>Planned Features</title>
+<para>
+ Filters are currently only supported by the Command Line interface.
+ Eventually, filter support will be added to the GUI.
+</para>
+</note>
+</para>
+
+
+<sect1>
+<title>Introduction to Filter Files</title>
+
+<para>
+Conceptually, a filter matches bug instances against a set of criteria.
+By defining a filter, you can select bug instances for special treatment;
+for example, to exclude or include them in a report.
+</para>
+
+<para>
+A filter file is an <ulink url="http://www.w3.org/XML/">XML</ulink> document with a top-level <literal>FindBugsFilter</literal> element
+which has some number of <literal>Match</literal> elements as children. Each <literal>Match</literal>
+element represents a predicate which is applied to generated bug instances.
+Usually, a filter will be used to exclude bug instances. For example:
+
+<screen>
+<prompt>$ </prompt><command>findbugs -textui -exclude <replaceable>myExcludeFilter.xml</replaceable> <replaceable>myApp.jar</replaceable></command>
+</screen>
+
+However, a filter could also be used to select bug instances to specifically
+report:
+
+<screen>
+<prompt>$ </prompt><command>findbugs -textui -include <replaceable>myIncludeFilter.xml</replaceable> <replaceable>myApp.jar</replaceable></command>
+</screen>
+</para>
+
+<para>
+<literal>Match</literal> elements contain children, which are conjuncts of the predicate.
+In other words, each of the children must be true for the predicate to be true.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Types of Match clauses</title>
+
+<variablelist>
+ <varlistentry>
+ <term><literal><Bug></literal></term>
+ <listitem><para>
+ This element specifies a particular bug pattern or patterns to match.
+ The <literal>pattern</literal> attribute is a comma-separated list of
+ bug pattern types. You can find the bug pattern types for particular
+ warnings by looking at the output produced by the <command>-xml</command>
+ output option (the <literal>type</literal> attribute of <literal>BugInstance</literal>
+ elements), or from the <ulink url="../bugDescriptions.html">bug
+ descriptions document</ulink>.
+ </para><para>
+ For more coarse-grained matching, use <literal>code</literal> attribute. It takes
+ a comma-separated list of bug abbreviations. For most-coarse grained matching use
+ <literal>category</literal> attriute, that takes a comma separated list of bug category names:
+ <literal>CORRECTNESS</literal>, <literal>MT_CORRECTNESS</literal>,
+ <literal>BAD_PRACTICICE</literal>, <literal>PERFORMANCE</literal>, <literal>STYLE</literal>.
+ </para><para>
+ If more than one of the attributes mentioned above are specified on the same
+ <literal><Bug></literal> element, all bug patterns that match either one of specified
+ pattern names, or abreviations, or categories will be matched.
+ </para><para>
+ As a backwards compatibility measure, <literal><BugPattern></literal> and
+ <literal><BugCode></literal> elements may be used instead of
+ <literal><Bug></literal> element. Each of these uses a
+ <literal>name</literal> attribute for specifying accepted values list. Support for these
+ elements may be removed in a future release.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Priority></literal></term>
+ <listitem>
+ <para>
+ This element matches warnings with a particular priority.
+ The <literal>value</literal> attribute should be an integer value:
+ 1 to match high-priority warnings, 2 to match medium-priority warnings,
+ or 3 to match low-priority warnings.
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term><literal><Package></literal></term>
+ <listitem>
+ <para>
+ This element matches warnings associated with classes within the package specified
+ using <literal>name</literal> attribute. Nested packages are not included (along the
+ lines of Java import statement). However matching multiple packages can be achieved
+ easily using regex name match.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Class></literal></term>
+ <listitem>
+ <para>
+ This element matches warnings associated with a particular class. The
+ <literal>name</literal> attribute is used to specify the exact or regex match pattern
+ for the class name.
+ </para>
+
+ <para>
+ As a backward compatibility measure, instead of element of this type, you can use
+ <literal>class</literal> attribute on a <literal>Match</literal> element to specify
+ exact an class name or <literal>classregex</literal> attribute to specify a regular
+ expression to match the class name against.
+ </para>
+
+ <para>
+ If the <literal>Match</literal> element contains neither a <literal>Class</literal> element,
+ nor a <literal>class</literal> / <literal>classregex</literal> attribute, the predicate will apply
+ to all classes. Such predicate is likely to match more bug instances than you want, unless it is
+ refined further down with apropriate method or field predicates.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Method></literal></term>
+
+ <listitem><para>This element specifies a method. The <literal>name</literal> is used to specify
+ the exact or regex match pattern for the method name.
+ The <literal>params</literal> attribute is a comma-separated list
+ of the types of the method's parameters. The <literal>returns</literal> attribute is
+ the method's return type. In <literal>params</literal> and <literal>returns</literal>, class names
+ must be fully qualified. (E.g., "java.lang.String" instead of just
+ "String".) If one of the latter attributes is specified the other is required for creating a method signature.
+ Note that you can provide either <literal>name</literal> attribute or <literal>params</literal>
+ and <literal>returns</literal> attributes or all three of them. This way you can provide various kinds of
+ name and signature based matches.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Field></literal></term>
+
+ <listitem><para>This element specifies a field. The <literal>name</literal> attribute is is used to specify
+ the exact or regex match pattern for the field name. You can also filter fields according to their signature -
+ use <literal>type</literal> attribute to specify fully qualified type of the field. You can specify eiter or both
+ of these attributes in order to perform name / signature based matches.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Local></literal></term>
+
+ <listitem><para>This element specifies a local variable. The <literal>name</literal> attribute is is used to specify
+ the exact or regex match pattern for the local variable name. Local variables are variables defined within a method.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal><Or></literal></term>
+ <listitem><para>
+ This element combines <literal>Match</literal> clauses as disjuncts. I.e., you can put two
+ <literal>Method</literal> elements in an <literal>Or</literal> clause in order match either method.
+ </para></listitem>
+ </varlistentry>
+</variablelist>
+
+</sect1>
+
+<sect1>
+<title>Java element name matching</title>
+
+<para>
+If the <literal>name</literal> attribute or <literal>Class</literal>, <literal>Method</literal> or
+<literal>Field</literal> starts with the ~ character the rest of attribute content is interpreted as
+a Java regular expression that is matched against the names of the Java element in question.
+</para>
+
+<para>
+Note that the pattern is matched against whole element name and therefore .* clauses need to be used
+at pattern beginning and/or end to perform substring matching.
+</para>
+
+<para>
+See <ulink url="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html"><literal>java.util.regex.Pattern</literal></ulink>
+documentation for pattern syntax.
+</para>
+</sect1>
+
+<sect1>
+<title>Caveats</title>
+
+<para>
+<literal>Match</literal> clauses can only match information that is actually contained in the
+bug instances. Every bug instance has a class, so in general, excluding
+bugs by class will work.
+</para>
+
+<para>
+Some bug instances have two (or more) classes. For example, the DE (dropped exception)
+bugs report both the class containing the method where the dropped exception
+happens, and the class which represents the type of the dropped exception.
+Only the <emphasis>first</emphasis> (primary) class is matched against <literal>Match</literal> clauses.
+So, for example, if you want to suppress IC (initialization circularity)
+reports for classes "com.foobar.A" and "com.foobar.B", you would use
+two <literal>Match</literal> clauses:
+
+<programlisting>
+ <Match>
+ <Class name="com.foobar.A" />
+ <Bug code="IC" />
+ </Match>
+
+ <Match>
+ <Class name="com.foobar.B" />
+ <Bug code="IC" />
+ </Match>
+</programlisting>
+
+By explicitly matching both classes, you ensure that the IC bug instance will be
+matched regardless of which class involved in the circularity happens to be
+listed first in the bug instance. (Of course, this approach might accidentally
+supress circularities involving "com.foobar.A" or "com.foobar.B" and a third
+class.)
+</para>
+
+<para>
+Many kinds of bugs report what method they occur in. For those bug instances,
+you can put <literal>Method</literal> clauses in the <literal>Match</literal> element and they should work
+as expected.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Examples</title>
+
+<para>
+ 1. Match all bug reports for a class.
+
+<programlisting>
+<![CDATA[
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ </Match>
+]]>
+</programlisting>
+
+</para>
+
+<para>
+ 2. Match certain tests from a class by specifying their abbreviations.
+<programlisting>
+<![CDATA[
+ <Match>
+ <Class name="com.foobar.MyClass"/ >
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 3. Match certain tests from all classes by specifying their abbreviations.
+
+<programlisting>
+<![CDATA[
+ <Match>
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 4. Match certain tests from all classes by specifying their category.
+
+<programlisting>
+<![CDATA[
+ <Match>
+ <Bug category="PERFORMANCE" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 5. Match bug types from specified methods of a class by their abbreviations.
+
+<programlisting>
+<![CDATA[
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Or>
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <Bug code="DC" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 6. Match a particular bug pattern in a particular method.
+
+<programlisting>
+<![CDATA[
+ <!-- A method with an open stream false positive. -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="writeDataToFile" />
+ <Bug pattern="OS_OPEN_STREAM" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 7. Match a particular bug pattern with a given priority in a particular method.
+
+<programlisting>
+<![CDATA[
+ <!-- A method with a dead local store false positive (medium priority). -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="someMethod" />
+ <Bug pattern="DLS_DEAD_LOCAL_STORE" />
+ <Priority value="2" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 8. Match minor bugs introduced by AspectJ compiler (you are probably not interested in these unless
+ you are an AspectJ developer).
+
+<programlisting>
+<![CDATA[
+ <Match>
+ <Class name="~.*\$AjcClosure\d+" />
+ <Bug pattern="DLS_DEAD_LOCAL_STORE" />
+ <Method name="run" />
+ </Match>
+ <Match>
+ <Bug pattern="UUF_UNUSED_FIELD" />
+ <Field name="~ajc\$.*" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 9. Match bugs in specific parts of the code base
+
+<programlisting>
+<![CDATA[
+ <!-- match unused fields warnings in Messages classes in all packages -->
+ <Match>
+ <Class name="~.*\.Messages" />
+ <Bug code="UUF" />
+ </Match>
+ <!-- match mutable statics warnings in all internal packages -->
+ <Match>
+ <Package name="~.*\.internal" />
+ <Bug code="MS" />
+ </Match>
+ <!-- match anonymoous inner classes warnings in ui package hierarchy -->
+ <Match>
+ <Package name="~com\.foobar\.fooproject\.ui.*" />
+ <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON" />
+ </Match>
+]]>
+</programlisting>
+</para>
+
+<para>
+ 10. Match bugs on fieds or methods with specific signatures
+<programlisting>
+<![CDATA[
+ <!-- match System.exit(...) usage warnings in void main(String[]) methods in all classes -->
+ <Match>
+ <Method returns="void" name="main" params="java.lang.String[]" />
+ <Method pattern="DM_EXIT" />
+ </Match>
+ <!-- match UuF warnings on fields of type com.foobar.DebugInfo on all classes -->
+ <Match>
+ <Field type="com.foobar.DebugInfo" />
+ <Bug code="UuF" />
+ </Match>
+]]>
+</programlisting>
+
+</para>
+
+</sect1>
+
+<sect1>
+<title>Complete Example</title>
+
+<programlisting>
+<![CDATA[
+<FindBugsFilter>
+ <Match>
+ <Class name="com.foobar.ClassNotToBeAnalyzed" />
+ </Match>
+
+ <Match>
+ <Class name="com.foobar.ClassWithSomeBugsMatched" />
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+
+ <!-- Match all XYZ violations. -->
+ <Match>
+ <Bug code="XYZ" />
+ </Match>
+
+ <!-- Match all doublecheck violations in these methods of "AnotherClass". -->
+ <Match>
+ <Class name="com.foobar.AnotherClass" />
+ <Or>
+ <Method name="nonOverloadedMethod" />
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <Bug code="DC" />
+ </Match>
+
+ <!-- A method with a dead local store false positive (medium priority). -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="someMethod" />
+ <Bug code="DLS_DEAD_LOCAL_STORE" />
+ <Priority value="2" />
+ </Match>
+</FindBugsFilter>
+]]>
+</programlisting>
+
+</sect1>
+
+
+</chapter>
+
+
+<!--
+ **************************************************************************
+ Analysis properties
+ **************************************************************************
+-->
+
+<chapter id="analysisprops">
+<title>Analysis Properties</title>
+
+<para>
+&FindBugs; allows several aspects of the analyses it performs to be
+customized. System properties are used to configure these options.
+This chapter describes the configurable analysis options.
+</para>
+
+<para>
+The analysis options have two main purposes. First, they allow you
+to inform &FindBugs; about the meaning of methods in your application,
+so that it can produce more accurate results, or produce fewer
+false warnings. Second, they allow you to configure the precision
+of the analysis performed. Reducing analysis precision can save
+memory and analysis time, at the expense of missing some real bugs,
+or producing more false warnings.
+</para>
+
+<para>
+The analysis options are set using the <command>-property</command>
+command line option. For example:
+<screen>
+<prompt>$ </prompt><command>findbugs -textui -property "cfg.noprune=true" <replaceable>myApp.jar</replaceable></command>
+</screen>
+</para>
+
+<para>
+The list of configurable analysis properties is shown in
+<xref linkend="analysisproptable"/>.
+</para>
+
+<table id="analysisproptable">
+<title>Configurable Analysis Properties</title>
+<tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Property Name</entry>
+ <entry>Value</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+<!--
+ <row>
+ <entry>cfg.noprune</entry>
+ <entry>true or false</entry>
+ <entry>If true, infeasible exception edges are not pruned from
+ the control flow graphs of analyzed methods. This option
+ increases the speed of the analysis (by about 20%-30%),
+ but causes some detectors to produce more false warnings.</entry>
+ </row>
+-->
+ <row>
+ <entry>findbugs.assertionmethods</entry>
+ <entry>Comma-separated list of fully qualified method names:
+ e.g., "com.foo.MyClass.checkAssertion"</entry>
+ <entry>This property specifies the names of methods that are used
+ to check program assertions. Specifying these methods allows
+ the null pointer dereference bug detector to avoid reporting
+ false warnings for values which are checked by assertion
+ methods.</entry>
+ </row>
+ <row>
+ <entry>findbugs.de.comment</entry>
+ <entry>true or false</entry>
+ <entry>If true, the DroppedException detector scans source code
+ for empty catch blocks for a comment, and if one is found, does
+ not report a warning.</entry>
+ </row>
+ <row>
+ <entry>findbugs.maskedfields.locals</entry>
+ <entry>true or false</entry>
+ <entry>If true, emit low priority warnings for local variables
+ which obscure fields. Default is false.</entry>
+ </row>
+ <row>
+ <entry>findbugs.nullderef.assumensp</entry>
+ <entry>true or false</entry>
+ <entry>not used
+ (intention: If true, the null dereference detector assumes that any
+ reference value returned from a method or passed to a method
+ in a parameter might be null. Default is false. Note that
+ enabling this property will very likely cause a large number
+ of false warnings to be produced.)</entry>
+ </row>
+ <row>
+ <entry>findbugs.refcomp.reportAll</entry>
+ <entry>true or false</entry>
+ <entry>If true, all suspicious reference comparisons
+ using the == and != operators are reported. If false,
+ only one such warning is issued per method. Default
+ is false.</entry>
+ </row>
+ <row>
+ <entry>findbugs.sf.comment</entry>
+ <entry>true or false</entry>
+ <entry>If true, the SwitchFallthrough detector will only report
+ warnings for cases where the source code does not have a comment
+ containing the words "fall" or "nobreak". (An accurate source
+ path must be used for this feature to work correctly.)
+ This helps find cases where the switch fallthrough is likely
+ to be unintentional.</entry>
+ </row>
+<!-- see others at src/doc/manual/sysprops.html
+ <row>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+-->
+ </tbody>
+</tgroup>
+</table>
+
+</chapter>
+
+<!--
+ **************************************************************************
+ Annotations
+ ***************************************************************************
+-->
+
+<chapter id="annotations">
+<title>Annotations</title>
+
+<para>
+&FindBugs; supports several annotations to express the developer's intent
+so that FindBugs can issue warnings more appropriately. You need to use
+Java 5 to use annotations, and must place the annotations.jar on the
+classpath while compiling your program.
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.CheckForNull</command></term>
+ <listitem>
+<command>[Target]</command> Field, Method, Parameter, Local variable
+ </listitem>
+ <listitem>
+ <para>
+The annotated element might be null, and uses of the element should check for null.
+When this annotation is applied to a method it applies to the method return value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.CheckReturnValue</command></term>
+ <listitem>
+ <command>[Target]</command> Method, Constructor
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>priority:</command>The priority of the warning (HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>explanation:</command>A textual explaination of why the return value should be checked. Default value:"".
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+This annotation is used to denote a method whose return value should always be checked after invoking the method.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.DefaultAnnotation</command></term>
+ <listitem>
+ <command>[Target]</command> Type, Package
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>Annotation class objects. More than one class can be specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>priority:</command>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+Indicates that all members of the class or package should be annotated with the default
+value of the supplied annotation classes. This would be used for behavior annotations
+such as @NonNull, @CheckForNull, or @CheckReturnValue. In particular, you can use
+@DefaultAnnotation(NonNull.class) on a class or package, and then use @Nullable only
+on those parameters, methods or fields that you want to allow to be null.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields</command></term>
+ <listitem>
+ <command>[Target]</command> Type, Package
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>Annotation class objects. More than one class can be specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>priority:</command>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+This is same as the DefaultAnnotation except it only applys to fields.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods</command></term>
+ <listitem>
+ <command>[Target]</command> Type, Package
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>Annotation class objects. More than one class can be specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>priority:</command>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+This is same as the DefaultAnnotation except it only applys to methods.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters</command></term>
+ <listitem>
+ <command>[Target]</command> Type, Package
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>Annotation class objects. More than one class can be specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>priority:</command>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+This is same as the DefaultAnnotation except it only applys to method parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.NonNull</command></term>
+ <listitem>
+ <command>[Target]</command> Field, Method, Parameter, Local variable
+ </listitem>
+ <listitem>
+ <para>
+The annotated element must not be null.
+Annotated fields must not be null after construction has completed. Annotated methods must have non-null return values.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.Nullable</command></term>
+ <listitem>
+ <command>[Target]</command> Field, Method, Parameter, Local variable
+ </listitem>
+ <listitem>
+ <para>
+The annotated element could be null under some circumstances. In general, this means
+developers will have to read the documentation to determine when a null value is
+acceptable and whether it is neccessary to check for a null value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.OverrideMustInvoke</command></term>
+ <listitem>
+ <command>[Target]</command> Method
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>Specify when the super invocation should be
+ performed (FIRST, ANYTIME, LAST). Default value:ANYTIME.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+Used to annotate a method that, if overridden, must (or should) be invoke super
+in the overriding method. Examples of such methods include finalize() and clone().
+The argument to the method indicates when the super invocation should occur:
+at any time, at the beginning of the overriding method, or at the end of the overriding method.
+(This anotation is not implmemented in FindBugs as of September 8, 2006).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.PossiblyNull</command></term>
+ <listitem>
+ <para>
+This annotation is deprecated. Use CheckForNull instead.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.SuppressWarnings</command></term>
+ <listitem>
+ <command>[Target]</command> Type, Field, Method, Parameter, Constructor, Local variable, Package
+ </listitem>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><command>[Parameter]</command></term>
+ <listitem>
+ <para>
+ <command>value:</command>The name of the warning. More than one name can be specified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <command>justification:</command>Reason why the warning should be ignored. Default value:"".
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ <listitem>
+ <para>
+The set of warnings that are to be suppressed by the compiler in the annotated element.
+Duplicate names are permitted. The second and successive occurrences of a name are ignored.
+The presence of unrecognized warning names is <emphasis>not</emphasis> an error: Compilers
+must ignore any warning names they do not recognize. They are, however, free to emit a
+warning if an annotation contains an unrecognized warning name. Compiler vendors should
+document the warning names they support in conjunction with this annotation type. They
+are encouraged to cooperate to ensure that the same names work across multiple compilers.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.UnknownNullness</command></term>
+ <listitem>
+ <command>[Target]</command> Field, Method, Parameter, Local variable
+ </listitem>
+ <listitem>
+ <para>
+Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><command>edu.umd.cs.findbugs.annotations.UnknownNullness</command></term>
+ <listitem>
+ <command>[Target]</command> Field, Method, Parameter, Local variable
+ </listitem>
+ <listitem>
+ <para>
+Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+
+<para>
+ &FindBugs; also supports the following annotations:
+<itemizedlist>
+ <listitem>net.jcip.annotations.GuardedBy</listitem>
+ <listitem>net.jcip.annotations.Immutable</listitem>
+ <listitem>net.jcip.annotations.NotThreadSafe</listitem>
+ <listitem>net.jcip.annotations.ThreadSafe</listitem>
+</itemizedlist>
+</para>
+<para>
+You can refer the JCIP annotation <ulink url="http://jcip.net/annotations/doc/index.html">
+API documentation</ulink> at <ulink url="http://jcip.net/">Java Concurrency in Practice</ulink>.
+</para>
+</chapter>
+
+<!--
+ **************************************************************************
+ Using rejarForAnalysis
+ **************************************************************************
+-->
+
+<chapter>
+<title>Using rejarForAnalysis</title>
+
+<para>
+If your project consists of many jarfiles or the jarfiles are scattered
+over many directories, you may wish to use the <command>rejarForAnalysis
+</command> script to make
+FindBugs invocation easier. The script collects many jarfiles and combines them
+into a single, large jarfile that can then be easily passed to FindBugs for
+analysis. This can be particularly useful in combination with the 'find' command
+on unix systems; e.g. <command>find . -name '*.jar' | xargs rejarForAnalysis
+</command>.
+</para>
+
+<para>
+The <command>rejarForAnalysis</command> script
+can also be used to split a very large project up into a set of jarfiles with
+the project classfiles evenly divided between them. This is useful when running
+FindBugs on the entire project is not practical due to time or memory consumption.
+Instead of running FindBugs on the entire project, you may use <command>
+rejarForAnalysis</command> build one large, all-inclusive jarfile
+containing all classes, invoke <command>rejarForAnalysis</command>
+again to split the project into multiple jarfiles, then run FindBugs
+on each divided jarfiles in turn, specifying the the all-inclusive jarfile in
+the <command>-auxclasspath</command>.
+</para>
+
+<para>
+These are the options accepted by the <command>rejarForAnalysis</command> script:
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term><command>-maxAge</command> <replaceable>days</replaceable></term>
+ <listitem>
+ <para>
+ Maximum age in days (ignore jar files older than this).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-inputFileList</command> <replaceable>filename</replaceable></term>
+ <listitem>
+ <para>
+ Text file containing names of jar files.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-maxClasses</command> <replaceable>num</replaceable></term>
+ <listitem>
+ <para>
+ Maximum number of classes per analysis*.jar file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>-prefix</command> <replaceable>class name prefix</replaceable></term>
+ <listitem>
+ <para>
+ Prefix of class names that should be analyzed (e.g., edu.umd.cs.).
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</chapter>
+
+<!--
+ **************************************************************************
+ Data mining
+ **************************************************************************
+-->
+
+<chapter id="datamining">
+ <title>Data mining of bugs with &FindBugs;™</title>
+
+<para>
+FindBugs incorporates an ability to perform sophisticated queries on bug
+databases and track warnings across multiple versions of code being
+studied, allowing you to do things such as seeing when a bug was first introduced, examining
+just the warnings that have been introduced since the last release, or graphing the number
+of infinite recursive loops in your code over time.</para>
+
+<para>
+These techniques all depend upon the XML format used by FindBugs for storing warnings.
+These XML files usually contain just the warnings from one particular analysis run, but
+they can also store the results from analyzing a sequence of software builds or versions.
+ </para>
+
+<para>
+Any FindBugs XML bug database contains a version name and timestamp.
+FindBugs tries to compute a timestamp from the timestamps of the files that
+are analyzed (e.g., the timestamp is intended to be the time the class files
+were generated, not analyzed). Each bug database also contains a version name.
+Both the version name and timestamp can be set manually using the
+<command>setBugDatabaseInfo</command> (<xref linkend="setBugDatabaseInfo" />) command.
+ </para>
+
+<para>A multiversion bug database assigns a sequence number to each version of
+the analyzed code. These sequence numbers are simply successive integers,
+starting at 0 (e.g., a bug database for 4 versions of the code will contain
+versions 0..3). The bug database will also record the name and timestamp for
+each version. The <command>filterBugs</command> command allows you to refer
+to a version by sequence number, name or timestamp.</para>
+
+<para>
+You can take a sequence (or pair) of single version bug databases and create
+from them a multiversion bug database, or combine a multiversion bug database
+with a sequence of later single-version bug databases.</para>
+
+<para>
+Some of these commands can be invoked as ant tasks. See below for specifics
+on how to invoke them and what attributes and arguments they take. All of
+the examples assume that the <literal>findbugs.lib</literal>
+<literal>refid</literal> is set correctly. Here is one way to set it:
+</para>
+
+<programlisting>
+<![CDATA[
+ <!-- findbugs task definition -->
+ <property name="findbugs.home" value="/your/path/to/findbugs" />
+ <path id="findbugs.lib">
+ <fileset dir="${findbugs.home}/lib">
+ <include name="findbugs-ant.jar"/>
+ </fileset>
+ </path>
+]]>
+</programlisting>
+
+ <sect1 id="commands">
+ <title>Commands</title>
+
+ <para>
+All tools for FindBugs data mining are can be invoked from the command line,
+and some of the more useful tools can also be invoked from an
+ant build file.</para>
+
+<para>
+Briefly, the command-line tools are:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><command><link linkend="unionBugs">unionBugs</link></command></term>
+ <listitem>
+ <para>
+ combine the results from separate analysis of disjoint
+ classes
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="computeBugHistory">computeBugHistory</link></command></term>
+ <listitem>
+ <para>Merge bug warnings from multiple versions of
+ analyzed code into
+ a single multiversion bug database. This can either be used
+ to add more versions to an existing multiversion database,
+ or to create a multiversion database from a sequence of single version
+ bug warning databases.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="setBugDatabaseInfo">setBugDatabaseInfo</link></command></term>
+ <listitem>
+ <para>Set information such as the revision name or
+timestamp in an XML bug database</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="listBugDatabaseInfo">listBugDatabaseInfo</link></command></term>
+ <listitem>
+ <para>List information such as the revision name and
+timestamp for a list of XML bug databases</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="filterBugs">filterBugs</link></command></term>
+ <listitem>
+ <para>Select a subset of a bug database</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="mineBugHistory">mineBugHistory</link></command></term>
+ <listitem>
+ <para>Generate a tabular listing of the number of warnings in each
+ version of a multiversion bug database</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="defectDensity">defectDensity</link></command></term>
+ <listitem>
+ <para>List information about defect density
+ (warnings per 1000 NCSS)
+ for the entire project and each class and package</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command><link linkend="convertXmlToText">convertXmlToText</link></command></term>
+ <listitem>
+ <para>Convert bug warnings in XML format to
+ a textual one-line-per-bug format, or to HTML</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+
+ <sect2 id="unionBugs">
+ <title>unionBugs</title>
+
+ <para>
+ If you have, for example, separately analyzing each jar file used in an application,
+ you can use this command to combine the separately generated xml bug warning files into
+ a single file containing all of the warnings.</para>
+
+ <para>Do <emphasis>not</emphasis> use this command to combine results from analyzing different versions of the same
+ file; use <command>computeBugHistory</command> instead.</para>
+
+ <para>Specify the xml files on the command line. The result is sent to standard output.</para>
+ </sect2>
+
+ <sect2 id="computeBugHistory">
+ <title>computeBugHistory</title>
+
+<para>Use this command to generate a bug database containing information from different builds or versions
+of software you are analyzing.
+History is taken from the first file provided as input; any following
+files should be single version bug databases (if they contain history, the history in those
+files will be ignored).</para>
+<para>By default, output is written to the standard output.
+</para>
+
+<para>This functionality may also can be accessed from ant.
+First create a taskdef for <command>computeBugHistory</command> in your
+build file:
+</para>
+
+<programlisting>
+<![CDATA[
+<taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+]]>
+</programlisting>
+
+<para>Attributes for this ant task are listed in the following table.
+To specify input files, nest them inside with a
+<literal><datafile></literal> element. For example:
+</para>
+
+<programlisting>
+<![CDATA[
+<computeBugHistory home="${findbugs.home}" ...>
+ <datafile name="analyze1.xml"/>
+ <datafile name="analyze2.xml"/>
+</computeBugHistory>
+]]>
+</programlisting>
+
+ <table id="computeBugHistoryTable">
+ <title>Options for computeBugHistory command</title>
+ <tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Command-line option</entry>
+ <entry>Ant attribute</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+<row><entry>-output <file></entry> <entry>output="<file>"</entry> <entry>save output in the named file (may also be an input file)</entry></row>
+<row><entry>-overrideRevisionNames[:truth]</entry> <entry>overrideRevisionNames="[true|false]"</entry><entry>override revision names for each version with names computed from the filenames</entry></row>
+<row><entry>-noPackageMoves[:truth]</entry> <entry>noPackageMoves="[true|false]"</entry><entry>if a class has moved to another package, treat warnings in that class as seperate</entry></row>
+<row><entry>-preciseMatch[:truth]</entry> <entry>preciseMatch="[true|false]"</entry><entry>require bug patterns to match precisely</entry></row>
+<row><entry>-precisePriorityMatch[:truth]</entry> <entry>precisePriorityMatch="[true|false]"</entry><entry>consider two warnings as the same only if priorities match exactly</entry></row>
+<row><entry>-quiet[:truth]</entry> <entry>quiet="[true|false]"</entry><entry>don't generate any output to standard out unless there is an error</entry></row>
+<row><entry>-withMessages[:truth]</entry> <entry>withMessages="[true|false]"</entry><entry>include human-readable messages describing the warnings in XML output</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect2>
+ <sect2 id="filterBugs">
+ <title>filterBugs</title>
+<para>This command is used to select a subset of warnings from a FindBugs XML warning file
+and write the selected subset to a new FindBugs warning file.</para>
+<para>
+This command takes a sequence of options, and either zero, one or two
+filenames of findbugs xml bug files on the command line.</para>
+<para>If no file names are provided, the command reads from standard input
+and writes to standard output. If one file name is provided,
+it reads from the file and writes to standard output.
+If two file names are provided, it reads from the first and writes the output
+to the second file name.</para>
+
+<para>This functionality may also can be accessed from ant.
+First create a taskdef for <command>filterBugs</command> in your
+build file:
+</para>
+
+<programlisting>
+<![CDATA[
+<taskdef name="filterBugs" classname="edu.umd.cs.findbugs.anttask.FilterBugsTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+]]>
+</programlisting>
+
+<para>Attributes for this ant task are listed in the following table.
+To specify an input file either use the input attribute or nest it inside
+the ant call with a <literal><datafile></literal> element. For example:
+</para>
+
+<programlisting>
+<![CDATA[
+<filterBugs home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</filterBugs>
+]]>
+</programlisting>
+
+ <table id="filterOptionsTable">
+ <title>Options for filterBugs command</title>
+ <tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Command-line option</entry>
+ <entry>Ant attribute</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+<row><entry></entry> <entry>input="<file>"</entry> <entry>use file as input</entry></row>
+<row><entry></entry> <entry>output="<file>"</entry> <entry>output results to file</entry></row>
+<row><entry>-not</entry> <entry>not="[true|false]"</entry> <entry>reverse (all) switches for the filter</entry></row>
+<row><entry>-withSource[:truth]</entry> <entry>withSource="[true|false]"</entry> <entry>only warnings for switch source is available</entry></row>
+<row><entry>-exclude <filter file></entry><entry>exclude="<filter file>"</entry> <entry>exclude bugs matching given filter</entry></row>
+<row><entry>-include <filter file></entry><entry>include="<filter file>"</entry> <entry>include only bugs matching given filter</entry></row>
+<row><entry>-annotation <text></entry> <entry>annotation="<text>"</entry> <entry>allow only warnings containing this text in a manual annotation</entry></row>
+<row><entry>-after <when></entry> <entry>after="<when>"</entry> <entry>allow only warnings that first occurred after this version</entry></row>
+<row><entry>-before <when></entry> <entry>before="<when>"</entry> <entry>allow only warnings that first occurred before this version</entry></row>
+<row><entry>-first <when></entry> <entry>first="<when>"</entry> <entry>allow only warnings that first occurred in this version</entry></row>
+<row><entry>-last <when></entry> <entry>last="<when>"</entry> <entry>allow only warnings that last occurred in this version</entry></row>
+<row><entry>-fixed <when></entry> <entry>fixed="<when>"</entry> <entry>allow only warnings that last occurred in the previous version (clobbers <option>-last</option>)</entry></row>
+<row><entry>-present <when></entry> <entry>present="<when>"</entry> <entry>allow only warnings present in this version</entry></row>
+<row><entry>-absent <when></entry> <entry>absent="<when>"</entry> <entry>allow only warnings absent in this version</entry></row>
+<row><entry>-active[:truth]</entry> <entry>active="[true|false]"</entry> <entry>allow only warnings alive in the last sequence number</entry></row>
+<row><entry>-introducedByChange[:truth]</entry> <entry>introducedByChange="[true|false]"</entry><entry>allow only warnings introduced by a change of an existing class</entry></row>
+<row><entry>-removedByChange[:truth]</entry> <entry>removedByChange="[true|false]"</entry> <entry>allow only warnings removed by a change of a persisting class</entry></row>
+<row><entry>-newCode[:truth]</entry> <entry>newCode="[true|false]"</entry> <entry>allow only warnings introduced by the addition of a new class</entry></row>
+<row><entry>-removedCode[:truth]</entry> <entry>removedCode="[true|false]"</entry> <entry>allow only warnings removed by removal of a class</entry></row>
+<row><entry>-priority <level></entry> <entry>priority="<level>"</entry> <entry>allow only warnings with this priority or higher</entry></row>
+<row><entry>-class <pattern></entry> <entry>class="<class>"</entry> <entry>allow only bugs whose primary class name matches this pattern</entry></row>
+<row><entry>-bugPattern <pattern></entry> <entry>bugPattern="<pattern>"</entry> <entry>allow only bugs whose type matches this pattern</entry></row>
+<row><entry>-category <category></entry> <entry>category="<category>"</entry> <entry>allow only warnings with a category that starts with this string</entry></row>
+<row><entry>-designation <designation></entry> <entry>designation="<designation>"</entry> <entry>allow only warnings with this designation (e.g., -designation SHOULD_FIX)</entry></row>
+<row><entry>-withMessages[:truth] </entry> <entry>withMessages="[true|false]"</entry> <entry>the generated XML should contain textual messages</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect2>
+
+ <sect2 id="mineBugHistory">
+ <title>mineBugHistory</title>
+<para>This command generates a table containing counts of the numbers of warnings
+in each version of a multiversion bug database.</para>
+
+
+<para>This functionality may also can be accessed from ant.
+First create a taskdef for <command>mineBugHistory</command> in your
+build file:
+</para>
+
+<programlisting>
+<![CDATA[
+<taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+]]>
+</programlisting>
+
+<para>Attributes for this ant task are listed in the following table.
+To specify an input file either use the <literal>input</literal>
+attribute or nest it inside the ant call with a
+<literal><datafile></literal> element. For example:
+</para>
+
+<programlisting>
+<![CDATA[
+<mineBugHistory home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</mineBugHistory>
+]]>
+</programlisting>
+
+ <table id="mineBugHistoryOptionsTable">
+ <title>Options for mineBugHistory command</title>
+ <tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Command-line option</entry>
+ <entry>Ant attribute</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+<row><entry></entry> <entry>input="<file>"</entry> <entry>use file as input</entry></row>
+<row><entry></entry> <entry>output="<file>"</entry> <entry>write output to file</entry></row>
+<row><entry>-formatDates</entry> <entry>formatDates="[true|false]"</entry> <entry>render dates in textual form</entry></row>
+<row><entry>-noTabs</entry> <entry>noTabs="[true|false]"</entry> <entry>delimit columns with groups of spaces instead of tabs (see below)</entry></row>
+<row><entry>-summary</entry> <entry>summary="[true|false]"</entry> <entry>output terse summary of changes over the last ten entries</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ The <option>-noTabs</option> output can be easier to read from a shell
+ with a fixed-width font.
+ Because numeric columns are right-justified, spaces may precede the
+ first column value. This option also causes <option>-formatDates</option>
+ to render dates in terser format without embedded whitespace.
+ </para>
+
+ <para>The table is a tab-separated (barring <option>-noTabs</option>)
+ table with the following columns:</para>
+
+ <table id="mineBugHistoryColumns">
+ <title>Columns in mineBugHistory output</title>
+ <tgroup cols="2" align="left">
+ <thead>
+ <row>
+ <entry>Title</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry>seq</entry><entry>Sequence number (successive integers, starting at 0)</entry></row>
+ <row><entry>version</entry><entry>Version name</entry></row>
+ <row><entry>time</entry><entry>Release timestamp</entry></row>
+ <row><entry>classes</entry><entry>Number of classes analyzed</entry></row>
+ <row><entry>NCSS</entry><entry>Non Commenting Source Statements</entry></row>
+ <row><entry>added</entry><entry>Count of new warnings for a class that existed in the previous version</entry></row>
+ <row><entry>newCode</entry><entry>Count of new warnings for a class that did not exist in the previous version</entry></row>
+ <row><entry>fixed</entry><entry>Count of warnings removed from a class that remains in the current version</entry></row>
+ <row><entry>removed</entry><entry>Count of warnings in the previous version for a class that is not present in the current version</entry></row>
+ <row><entry>retained</entry><entry>Count of warnings that were in both the previous and current version</entry></row>
+ <row><entry>dead</entry><entry>Warnings that were present in earlier versions but in neither the current version or the immediately preceeding version</entry></row>
+ <row><entry>active</entry><entry>Total warnings present in the current version</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect2>
+
+ <sect2 id="defectDensity">
+ <title>defectDensity</title>
+<para>
+This command lists information about defect density (warnings per 1000 NCSS) for the entire project and each class and package.
+In can either be invoked with no files specified on the command line (in which case it reads from standard input)
+or with one file specified on the command line.</para>
+<para>It generates a table with the following columns, and with one
+row for the entire project, and one row for each package or class that contains at least
+4 warnings.</para>
+ <table id="defectDensityColumns">
+ <title>Columns in defectDensity output</title>
+ <tgroup cols="2" align="left">
+ <thead>
+ <row>
+ <entry>Title</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry>kind</entry><entry>project, package or class</entry></row>
+ <row><entry>name</entry><entry>The name of the project, package or class</entry></row>
+ <row><entry>density</entry><entry>Number of warnings generated per 1000 lines of NCSS.</entry></row>
+ <row><entry>bugs</entry><entry>Number of warnings</entry></row>
+ <row><entry>NCSS</entry><entry>Calculated number of NCSS</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect2>
+
+ <sect2 id="convertXmlToText">
+ <title>convertXmlToText</title>
+
+ <para>
+ This command converts a warning collection in XML format to a text
+ format with one line per warning, or to HTML.
+ </para>
+
+<para>This functionality may also can be accessed from ant.
+First create a taskdef for <command>convertXmlToText</command> in your
+build file:
+</para>
+
+<programlisting>
+<![CDATA[
+<taskdef name="convertXmlToText" classname="edu.umd.cs.findbugs.anttask.ConvertXmlToTextTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+]]>
+</programlisting>
+
+<para>Attributes for this ant task are listed in the following table.</para>
+
+ <table id="convertXmlToTextTable">
+ <title>Options for convertXmlToText command</title>
+ <tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Command-line option</entry>
+ <entry>Ant attribute</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+<row><entry></entry> <entry>input="<filename>"</entry> <entry>use file as input</entry></row>
+<row><entry></entry> <entry>output="<filename>"</entry> <entry>output results to file</entry></row>
+<row><entry>-longBugCodes</entry> <entry>longBugCodes="[true|false]"</entry> <entry>use the full bug pattern code instead of two-letter abbreviation</entry></row>
+<row><entry>-html[:stylesheet]</entry> <entry>format="html:<stylesheet>"</entry> <entry>generate output with specified stylesheet (see below), or default.xsl if unspecified</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ You may specify plain.xsl, default.xsl, fancy.xsl, fancy-hist.xsl,
+ or your own XSL stylesheet for the -html/format option.
+ Despite the name of this option, you may specify
+ a stylesheet that emits something other than html.
+ </para>
+ </sect2>
+
+ <sect2 id="setBugDatabaseInfo">
+ <title>setBugDatabaseInfo</title>
+
+ <para>
+ This command sets meta-information in a specified warning collection.
+ It takes the following options:
+ </para>
+
+<para>This functionality may also can be accessed from ant.
+First create a taskdef for <command>setBugDatabaseInfo</command> in your
+build file:
+</para>
+
+<programlisting>
+<![CDATA[
+<taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+]]>
+</programlisting>
+
+<para>Attributes for this ant task are listed in the following table.
+To specify an input file either use the <literal>input</literal>
+attribute or nest it inside the ant call with a
+<literal><datafile></literal> element. For example:
+</para>
+
+<programlisting>
+<![CDATA[
+<setBugDatabaseInfo home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</setBugDatabaseInfo>
+]]>
+</programlisting>
+
+ <table id="setBugDatabaseInfoOptions">
+ <title>setBugDatabaseInfo Options</title>
+ <tgroup cols="3" align="left">
+ <thead>
+ <row>
+ <entry>Command-line option</entry>
+ <entry>Ant attribute</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry></entry> <entry>input="<file>"</entry> <entry>use file as input</entry></row>
+ <row><entry></entry> <entry>output="<file>"</entry> <entry>write output to file</entry></row>
+ <row><entry>-name <name></entry> <entry>name="<name>"</entry> <entry>set name for (last) revision</entry></row>
+ <row><entry>-timestamp <when></entry> <entry>timestamp="<when>"</entry> <entry>set timestamp for (last) revision</entry></row>
+ <row><entry>-source <directory></entry> <entry>source="<directory>"</entry> <entry>add specified directory to the source search path</entry></row>
+ <row><entry>-findSource <directory></entry> <entry>findSource="<directory>"</entry> <entry>find and add all relevant source directions contained within specified directory</entry></row>
+ <row><entry>-suppress <filter file></entry> <entry>suppress="<filter file>"</entry> <entry>suppress warnings matched by this file (replaces previous suppressions)</entry></row>
+ <row><entry>-withMessages</entry> <entry>withMessages="[true|false]"</entry> <entry>add textual messages to XML</entry></row>
+ <row><entry>-resetSource</entry> <entry>resetSource="[true|false]"</entry> <entry>remove all source search paths</entry></row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect2>
+
+ <sect2 id="listBugDatabaseInfo">
+ <title>listBugDatabaseInfo</title>
+
+ <para>This command takes a list of zero or more xml bug database filenames on the command line.
+If zero file names are provided, it reads from standard input and does not generate
+a table header.</para>
+
+<para>There is only one option: <option>-formatDates</option> renders dates
+ in textual form.
+ </para>
+
+<para>The output is a table one row per bug database and the following columns:</para>
+ <table id="listBugDatabaseInfoColumns">
+ <title>listBugDatabaseInfo Columns</title>
+ <tgroup cols="2" align="left">
+ <thead>
+ <row>
+ <entry>Column</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row><entry>version</entry><entry>version name</entry></row>
+ <row><entry>time</entry><entry>Release timestamp</entry></row>
+ <row><entry>classes</entry><entry>Number of classes analyzed</entry></row>
+ <row><entry>NCSS</entry><entry>Non Commenting Source Statements analyzed</entry></row>
+ <row><entry>total</entry><entry>Total number of warnings of all kinds</entry></row>
+ <row><entry>high</entry><entry>Total number of high priority warnings of all kinds</entry></row>
+ <row><entry>medium</entry><entry>Total number of medium/normal priority warnings of all kinds</entry></row>
+ <row><entry>low</entry><entry>Total number of low priority warnings of all kinds</entry></row>
+ <row><entry>filename</entry><entry>filename of database</entry></row>
+<!--
+ <row><entry></entry><entry></entry></row>
+ <row><entry></entry><entry></entry></row>
+ <row><entry></entry><entry></entry></row>
+ <row><entry></entry><entry></entry></row>
+ <row><entry></entry><entry></entry></row>
+ <row><entry></entry><entry></entry></row>
+-->
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect2>
+
+ </sect1>
+
+ <sect1 id="examples">
+ <title>Examples</title>
+<sect2 id="unixscriptsexemples">
+ <title>Mining history using proveded shell scrips</title>
+<para>In all of the following, the commands are given in a directory that contains
+directories jdk1.6.0-b12, jdk1.6.0-b13, ..., jdk1.6.0-b60.</para>
+
+<para>You can use the command:</para>
+<screen>
+computeBugHistory jdk1.6.0-b* | filterBugs -bugPattern IL_ | mineBugHistory -formatDates
+</screen>
+<para>to generate the following output:</para>
+
+<screen>
+seq version time classes NCSS added newCode fixed removed retained dead active
+0 jdk1.6.0-b12 "Thu Nov 11 09:07:20 EST 2004" 13128 811569 0 4 0 0 0 0 4
+1 jdk1.6.0-b13 "Thu Nov 18 06:02:06 EST 2004" 13128 811570 0 0 0 0 4 0 4
+2 jdk1.6.0-b14 "Thu Dec 02 06:12:26 EST 2004" 13145 811786 0 0 2 0 2 0 2
+3 jdk1.6.0-b15 "Thu Dec 09 06:07:04 EST 2004" 13174 811693 0 0 1 0 1 2 1
+4 jdk1.6.0-b16 "Thu Dec 16 06:21:28 EST 2004" 13175 811715 0 0 0 0 1 3 1
+5 jdk1.6.0-b17 "Thu Dec 23 06:27:22 EST 2004" 13176 811974 0 0 0 0 1 3 1
+6 jdk1.6.0-b19 "Thu Jan 13 06:41:16 EST 2005" 13176 812011 0 0 0 0 1 3 1
+7 jdk1.6.0-b21 "Thu Jan 27 05:57:52 EST 2005" 13177 812173 0 0 0 0 1 3 1
+8 jdk1.6.0-b23 "Thu Feb 10 05:44:36 EST 2005" 13179 812188 0 0 0 0 1 3 1
+9 jdk1.6.0-b26 "Thu Mar 03 06:04:02 EST 2005" 13199 811770 0 0 0 0 1 3 1
+10 jdk1.6.0-b27 "Thu Mar 10 04:48:38 EST 2005" 13189 812440 0 0 0 0 1 3 1
+11 jdk1.6.0-b28 "Thu Mar 17 02:54:22 EST 2005" 13185 812056 0 0 0 0 1 3 1
+12 jdk1.6.0-b29 "Thu Mar 24 03:09:20 EST 2005" 13117 809468 0 0 0 0 1 3 1
+13 jdk1.6.0-b30 "Thu Mar 31 02:53:32 EST 2005" 13118 809501 0 0 0 0 1 3 1
+14 jdk1.6.0-b31 "Thu Apr 07 03:00:14 EDT 2005" 13117 809572 0 0 0 0 1 3 1
+15 jdk1.6.0-b32 "Thu Apr 14 02:56:56 EDT 2005" 13169 811096 0 0 0 0 1 3 1
+16 jdk1.6.0-b33 "Thu Apr 21 02:46:22 EDT 2005" 13187 811942 0 0 0 0 1 3 1
+17 jdk1.6.0-b34 "Thu Apr 28 02:49:00 EDT 2005" 13195 813488 0 1 0 0 1 3 2
+18 jdk1.6.0-b35 "Thu May 05 02:49:04 EDT 2005" 13457 829837 0 0 0 0 2 3 2
+19 jdk1.6.0-b36 "Thu May 12 02:59:46 EDT 2005" 13462 831278 0 0 0 0 2 3 2
+20 jdk1.6.0-b37 "Thu May 19 02:55:08 EDT 2005" 13464 831971 0 0 0 0 2 3 2
+21 jdk1.6.0-b38 "Thu May 26 03:08:16 EDT 2005" 13564 836565 0 0 0 0 2 3 2
+22 jdk1.6.0-b39 "Fri Jun 03 03:10:48 EDT 2005" 13856 849992 0 1 0 0 2 3 3
+23 jdk1.6.0-b40 "Thu Jun 09 03:30:28 EDT 2005" 15972 959619 0 2 0 0 3 3 5
+24 jdk1.6.0-b41 "Thu Jun 16 03:19:22 EDT 2005" 15972 959619 0 0 0 0 5 3 5
+25 jdk1.6.0-b42 "Fri Jun 24 03:38:54 EDT 2005" 15966 958581 0 0 0 0 5 3 5
+26 jdk1.6.0-b43 "Thu Jul 14 03:09:34 EDT 2005" 16041 960544 0 0 0 0 5 3 5
+27 jdk1.6.0-b44 "Thu Jul 21 03:05:54 EDT 2005" 16041 960547 0 0 0 0 5 3 5
+28 jdk1.6.0-b45 "Thu Jul 28 03:26:10 EDT 2005" 16037 960606 0 0 1 0 4 3 4
+29 jdk1.6.0-b46 "Thu Aug 04 03:02:48 EDT 2005" 15936 951355 0 0 0 0 4 4 4
+30 jdk1.6.0-b47 "Thu Aug 11 03:18:56 EDT 2005" 15964 952387 0 0 1 0 3 4 3
+31 jdk1.6.0-b48 "Thu Aug 18 08:10:40 EDT 2005" 15970 953421 0 0 0 0 3 5 3
+32 jdk1.6.0-b49 "Thu Aug 25 03:24:38 EDT 2005" 16048 958940 0 0 0 0 3 5 3
+33 jdk1.6.0-b50 "Thu Sep 01 01:52:40 EDT 2005" 16287 974937 1 0 0 0 3 5 4
+34 jdk1.6.0-b51 "Thu Sep 08 01:55:36 EDT 2005" 16362 979377 0 0 0 0 4 5 4
+35 jdk1.6.0-b52 "Thu Sep 15 02:04:08 EDT 2005" 16477 979399 0 0 0 0 4 5 4
+36 jdk1.6.0-b53 "Thu Sep 22 02:00:28 EDT 2005" 16019 957900 0 0 1 0 3 5 3
+37 jdk1.6.0-b54 "Thu Sep 29 01:54:34 EDT 2005" 16019 957900 0 0 0 0 3 6 3
+38 jdk1.6.0-b55 "Thu Oct 06 01:54:14 EDT 2005" 16051 959014 0 0 0 0 3 6 3
+39 jdk1.6.0-b56 "Thu Oct 13 01:54:12 EDT 2005" 16211 970835 0 0 0 0 3 6 3
+40 jdk1.6.0-b57 "Thu Oct 20 01:55:26 EDT 2005" 16279 971627 0 0 0 0 3 6 3
+41 jdk1.6.0-b58 "Thu Oct 27 01:56:30 EDT 2005" 16283 971945 0 0 0 0 3 6 3
+42 jdk1.6.0-b59 "Thu Nov 03 01:56:58 EST 2005" 16232 972193 0 0 0 0 3 6 3
+43 jdk1.6.0-b60 "Thu Nov 10 01:54:18 EST 2005" 16235 972346 0 0 0 0 3 6 3
+</screen>
+
+<para>
+We could also generate that information directly, without creating an intermediate db.xml file, using the command
+</para>
+
+<screen>
+computeBugHistory jdk1.6.0-b*/jre/lib/rt.xml | filterBugs -bugPattern IL_ db.xml | mineBugHistory -formatDates
+</screen>
+
+<para>We can then use that information to display a graph showing the number of infinite recursive loops
+found by FindBugs in each build of Sun's JDK1.6.0. The blue area indicates the number of infinite
+recursive loops in that build, the red area above it indicates the number of infinite recursive loops that existed
+in some previous version but not in the current version (thus, the combined height of the red and blue areas
+is guaranteed to never decrease, and goes up whenever a new infinite recursive loop bug is introduced). The height
+of the red area is computed as the sum of the fixed, removed and dead values for each version.
+The reductions in builds 13 and 14 came after Sun was notified about the bugs found by FindBugs in the JDK.
+ </para>
+<mediaobject>
+<imageobject>
+<imagedata fileref="infiniteRecursiveLoops.png" />
+</imageobject>
+</mediaobject>
+
+<para>
+Given the db.xml file that contains the results for all the jdk1.6.0 builds, the following command will show the history of high and medium priority correctness warnings:
+</para>
+
+<screen>
+filterBugs -priority M -category C db.xml | mineBugHistory -formatDates
+</screen>
+
+<para>
+generating the table:
+</para>
+
+<screen>
+seq version time classes NCSS added newCode fixed removed retained dead active
+0 jdk1.6.0-b12 "Thu Nov 11 09:07:20 EST 2004" 13128 811569 0 1075 0 0 0 0 1075
+1 jdk1.6.0-b13 "Thu Nov 18 06:02:06 EST 2004" 13128 811570 0 0 0 0 1075 0 1075
+2 jdk1.6.0-b14 "Thu Dec 02 06:12:26 EST 2004" 13145 811786 3 0 6 0 1069 0 1072
+3 jdk1.6.0-b15 "Thu Dec 09 06:07:04 EST 2004" 13174 811693 2 1 3 0 1069 6 1072
+4 jdk1.6.0-b16 "Thu Dec 16 06:21:28 EST 2004" 13175 811715 0 0 1 0 1071 9 1071
+5 jdk1.6.0-b17 "Thu Dec 23 06:27:22 EST 2004" 13176 811974 0 0 1 0 1070 10 1070
+6 jdk1.6.0-b19 "Thu Jan 13 06:41:16 EST 2005" 13176 812011 0 0 0 0 1070 11 1070
+7 jdk1.6.0-b21 "Thu Jan 27 05:57:52 EST 2005" 13177 812173 0 0 1 0 1069 11 1069
+8 jdk1.6.0-b23 "Thu Feb 10 05:44:36 EST 2005" 13179 812188 0 0 0 0 1069 12 1069
+9 jdk1.6.0-b26 "Thu Mar 03 06:04:02 EST 2005" 13199 811770 0 0 2 1 1066 12 1066
+10 jdk1.6.0-b27 "Thu Mar 10 04:48:38 EST 2005" 13189 812440 1 0 1 1 1064 15 1065
+11 jdk1.6.0-b28 "Thu Mar 17 02:54:22 EST 2005" 13185 812056 0 0 0 0 1065 17 1065
+12 jdk1.6.0-b29 "Thu Mar 24 03:09:20 EST 2005" 13117 809468 3 0 8 26 1031 17 1034
+13 jdk1.6.0-b30 "Thu Mar 31 02:53:32 EST 2005" 13118 809501 0 0 0 0 1034 51 1034
+14 jdk1.6.0-b31 "Thu Apr 07 03:00:14 EDT 2005" 13117 809572 0 0 0 0 1034 51 1034
+15 jdk1.6.0-b32 "Thu Apr 14 02:56:56 EDT 2005" 13169 811096 1 1 0 1 1033 51 1035
+16 jdk1.6.0-b33 "Thu Apr 21 02:46:22 EDT 2005" 13187 811942 3 0 2 1 1032 52 1035
+17 jdk1.6.0-b34 "Thu Apr 28 02:49:00 EDT 2005" 13195 813488 0 1 0 0 1035 55 1036
+18 jdk1.6.0-b35 "Thu May 05 02:49:04 EDT 2005" 13457 829837 0 36 2 0 1034 55 1070
+19 jdk1.6.0-b36 "Thu May 12 02:59:46 EDT 2005" 13462 831278 0 0 0 0 1070 57 1070
+20 jdk1.6.0-b37 "Thu May 19 02:55:08 EDT 2005" 13464 831971 0 1 1 0 1069 57 1070
+21 jdk1.6.0-b38 "Thu May 26 03:08:16 EDT 2005" 13564 836565 1 7 2 6 1062 58 1070
+22 jdk1.6.0-b39 "Fri Jun 03 03:10:48 EDT 2005" 13856 849992 6 39 5 0 1065 66 1110
+23 jdk1.6.0-b40 "Thu Jun 09 03:30:28 EDT 2005" 15972 959619 7 147 11 0 1099 71 1253
+24 jdk1.6.0-b41 "Thu Jun 16 03:19:22 EDT 2005" 15972 959619 0 0 0 0 1253 82 1253
+25 jdk1.6.0-b42 "Fri Jun 24 03:38:54 EDT 2005" 15966 958581 3 0 1 2 1250 82 1253
+26 jdk1.6.0-b43 "Thu Jul 14 03:09:34 EDT 2005" 16041 960544 5 11 15 8 1230 85 1246
+27 jdk1.6.0-b44 "Thu Jul 21 03:05:54 EDT 2005" 16041 960547 0 0 0 0 1246 108 1246
+28 jdk1.6.0-b45 "Thu Jul 28 03:26:10 EDT 2005" 16037 960606 19 0 2 0 1244 108 1263
+29 jdk1.6.0-b46 "Thu Aug 04 03:02:48 EDT 2005" 15936 951355 13 1 1 32 1230 110 1244
+30 jdk1.6.0-b47 "Thu Aug 11 03:18:56 EDT 2005" 15964 952387 163 8 7 20 1217 143 1388
+31 jdk1.6.0-b48 "Thu Aug 18 08:10:40 EDT 2005" 15970 953421 0 0 0 0 1388 170 1388
+32 jdk1.6.0-b49 "Thu Aug 25 03:24:38 EDT 2005" 16048 958940 1 11 1 0 1387 170 1399
+33 jdk1.6.0-b50 "Thu Sep 01 01:52:40 EDT 2005" 16287 974937 19 27 16 7 1376 171 1422
+34 jdk1.6.0-b51 "Thu Sep 08 01:55:36 EDT 2005" 16362 979377 1 15 3 0 1419 194 1435
+35 jdk1.6.0-b52 "Thu Sep 15 02:04:08 EDT 2005" 16477 979399 0 0 1 1 1433 197 1433
+36 jdk1.6.0-b53 "Thu Sep 22 02:00:28 EDT 2005" 16019 957900 13 12 16 20 1397 199 1422
+37 jdk1.6.0-b54 "Thu Sep 29 01:54:34 EDT 2005" 16019 957900 0 0 0 0 1422 235 1422
+38 jdk1.6.0-b55 "Thu Oct 06 01:54:14 EDT 2005" 16051 959014 1 4 7 0 1415 235 1420
+39 jdk1.6.0-b56 "Thu Oct 13 01:54:12 EDT 2005" 16211 970835 6 8 37 0 1383 242 1397
+40 jdk1.6.0-b57 "Thu Oct 20 01:55:26 EDT 2005" 16279 971627 0 0 0 0 1397 279 1397
+41 jdk1.6.0-b58 "Thu Oct 27 01:56:30 EDT 2005" 16283 971945 0 1 1 0 1396 279 1397
+42 jdk1.6.0-b59 "Thu Nov 03 01:56:58 EST 2005" 16232 972193 6 0 5 0 1392 280 1398
+43 jdk1.6.0-b60 "Thu Nov 10 01:54:18 EST 2005" 16235 972346 0 0 0 0 1398 285 1398
+44 jdk1.6.0-b61 "Thu Nov 17 01:58:42 EST 2005" 16202 971134 2 0 4 0 1394 285 1396
+</screen>
+</sect2>
+
+<sect2 id="incrementalhistory">
+ <title>Incremental history maintenance</title>
+
+<para>
+If db.xml contains the results of running findbugs over builds b12 - b60, we can update db.xml to include the results of analyzing b61 with the commands:
+</para>
+<screen>
+computeBugHistory -output db.xml db.xml jdk1.6.0-b61/jre/lib/rt.xml
+</screen>
+</sect2>
+
+ </sect1>
+
+ <sect1 id="antexemple">
+ <title>Ant exemple</title>
+<para>
+Here is a complete ant script example for both running findbugs and running a chain of data-mining tools afterward:
+</para>
+<screen>
+<![CDATA[
+<project name="analyze_asm_util" default="findbugs">
+ <!-- findbugs task definition -->
+ <property name="findbugs.home" value="/Users/ben/Documents/workspace/findbugs/findbugs" />
+ <property name="jvmargs" value="-server -Xss1m -Xmx800m -Duser.language=en -Duser.region=EN -Dfindbugs.home=${findbugs.home}" />
+
+ <path id="findbugs.lib">
+ <fileset dir="${findbugs.home}/lib">
+ <include name="findbugs-ant.jar"/>
+ </fileset>
+ </path>
+
+ <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <!-- findbugs task definition -->
+ <target name="findbugs">
+ <antcall target="analyze" />
+ <antcall target="mine" />
+ </target>
+
+ <!-- analyze task -->
+ <target name="analyze">
+ <!-- run findbugs against asm-util -->
+ <findbugs home="${findbugs.home}"
+ output="xml:withMessages"
+ timeout="90000000"
+ reportLevel="experimental"
+ workHard="true"
+ effort="max"
+ adjustExperimental="true"
+ jvmargs="${jvmargs}"
+ failOnError="true"
+ outputFile="out.xml"
+ projectName="Findbugs"
+ debug="false">
+ <class location="asm-util-3.0.jar" />
+ </findbugs>
+ </target>
+
+ <target name="mine">
+
+ <!-- Set info to the latest analysis -->
+ <setBugDatabaseInfo home="${findbugs.home}"
+ withMessages="true"
+ name="asm-util-3.0.jar"
+ input="out.xml"
+ output="out-rel.xml"/>
+
+ <!-- Checking if history file already exists (findbugs-hist.xml) -->
+ <condition property="mining.historyfile.available">
+ <available file="out-hist.xml"/>
+ </condition>
+ <condition property="mining.historyfile.notavailable">
+ <not>
+ <available file="out-hist.xml"/>
+ </not>
+ </condition>
+
+ <!-- this target is executed if the history file do not exist (first run) -->
+ <antcall target="history-init">
+ <param name="data.file" value="out-rel.xml" />
+ <param name="hist.file" value="out-hist.xml" />
+ </antcall>
+ <!-- else this one is executed -->
+ <antcall target="history">
+ <param name="data.file" value="out-rel.xml" />
+ <param name="hist.file" value="out-hist.xml" />
+ <param name="hist.summary.file" value="out-hist.txt" />
+ </antcall>
+ </target>
+
+ <!-- Initializing history file -->
+ <target name="history-init" if="mining.historyfile.notavailable">
+ <copy file="${data.file}" tofile="${hist.file}" />
+ </target>
+
+ <!-- Computing bug history -->
+ <target name="history" if="mining.historyfile.available">
+ <!-- Merging ${data.file} into ${hist.file} -->
+ <computeBugHistory home="${findbugs.home}"
+ withMessages="true"
+ output="${hist.file}">
+ <dataFile name="${hist.file}"/>
+ <dataFile name="${data.file}"/>
+ </computeBugHistory>
+
+ <!-- Compute history into ${hist.summary.file} -->
+ <mineBugHistory home="${findbugs.home}"
+ formatDates="true"
+ noTabs="true"
+ input="${hist.file}"
+ output="${hist.summary.file}"/>
+ </target>
+
+</project>
+]]>
+</screen>
+ </sect1>
+</chapter>
+
+
+<!--
+ **************************************************************************
+ License
+ **************************************************************************
+-->
+
+<chapter id="license">
+<title>License</title>
+
+<para>
+The name FindBugs and the FindBugs logo is trademarked by the University
+of Maryland.
+FindBugs is free software distributed under the terms of the
+<ulink url="http://www.gnu.org/licenses/lgpl.html">Lesser GNU Public License</ulink>.
+You should have received a copy of the license in the file <filename>LICENSE.txt</filename>
+in the &FindBugs; distribution.
+</para>
+
+<para>
+You can find the latest version of FindBugs, along with its source code, from the
+<ulink url="http://findbugs.sourceforge.net">FindBugs web page</ulink>.
+</para>
+
+</chapter>
+
+
+<!--
+ **************************************************************************
+ Acknowledgments
+ **************************************************************************
+-->
+<chapter id="acknowledgments">
+<title>Acknowledgments</title>
+
+<sect1>
+<title>Contributors</title>
+
+<para>&FindBugs; was originally written by Bill Pugh (<email>pugh@cs.umd.edu</email>).
+David Hovemeyer (<email>daveho@cs.umd.edu</email>) implemented some of the
+detectors, added the Swing GUI, and is a co-maintainer.</para>
+
+<para>Mike Fagan (<email>mfagan@tde.com</email>) contributed the &Ant; build script,
+the &Ant; task, and several enhancements and bug fixes to the GUI.</para>
+
+<para>Germano Leichsenring contributed Japanese translations of the bug
+summaries.</para>
+
+<para>David Li contributed the Emacs bug report format.</para>
+
+<para>Peter D. Stout contributed recursive detection of Class-Path
+attributes in analyzed Jar files, German translations of
+text used in the Swing GUI, and other fixes.</para>
+
+<para>Peter Friese wrote the &FindBugs; Eclipse plugin.</para>
+
+<para>Rohan Lloyd contributed several Mac OS X enhancements,
+bug detector improvements,
+and maintains the Fink package for &FindBugs;.</para>
+
+<para>Hiroshi Okugawa translated the &FindBugs; manual and
+more of the bug summaries into Japanese.</para>
+
+<para>Phil Crosby enhanced the Eclipse plugin to add a view
+to display the bug details.</para>
+
+<para>Dave Brosius fixed a number of bugs, added user preferences
+to the Swing GUI, improved several bug detectors, and
+contributed the string concatenation detector.</para>
+
+<para>Thomas Klaeger contributed a number of bug fixes and
+bug detector improvements.</para>
+
+<para>Andrei Loskutov made a number of improvements to the
+Eclipse plugin.</para>
+
+<para>Brian Goetz contributed a major refactoring of the
+visitor classes to improve readability and understandability.</para>
+
+<para> Pete Angstadt fixed several problems in the Swing GUI.</para>
+
+<para>Francis Lalonde provided a task resource file for the
+FindBugs Ant task.</para>
+
+<para>Garvin LeClaire contributed support for output in
+Xdocs format, for use by Maven.</para>
+
+<para>Holger Stenzhorn contributed improved German translations of items
+in the Swing GUI.</para>
+
+<para>Juha Knuutila contributed Finnish translations of items
+in the Swing GUI.</para>
+
+<para>Tanel Lebedev contributed Estonian translations of items
+in the Swing GUI.</para>
+
+<para>Hanai Shisei (ruimo) contributed full Japanese translations of
+bug messages, and text used in the Swing GUI.</para>
+
+<para>David Cotton contributed Fresh translations for bug
+messages and for the Swing GUI.</para>
+
+<para>Michael Tamm contributed support for the "errorProperty" attribute
+in the Ant task.</para>
+
+<para>Thomas Kuehne improved the German translation of the Swing GUI.</para>
+
+<para>Len Trigg improved source file support for the Emacs output mode.</para>
+
+<para>Greg Bentz provided a fix for the hashcode/equals detector.</para>
+
+<para>K. Hashimoto contributed internationalization fixes and several other
+ bug fixes.</para>
+
+<para>
+ Glenn Boysko contributed support for ignoring specified local
+ variables in the dead local store detector.
+</para>
+
+<para>
+ Jay Dunning contributed a detector to find equality comparisons
+ of floating-point values, and overhauled the analysis summary
+ report and its representation in the saved XML format.
+</para>
+
+<para>
+ Olivier Parent contributed updated French translations for bug descriptions and
+ Swing GUI.
+</para>
+
+<para>
+ Chris Nappin contributed the <filename>plain.xsl</filename>
+ stylesheet.
+</para>
+
+<para>
+ Etienne Giraudy contributed the <filename>fancy.xsl</filename> and <filename>fancy-hist.xsl</filename>
+ stylesheets, and made improvements to the <command>-xml:withMessages</command>
+ option.
+</para>
+
+<para>
+ Takashi Okamoto fixed bugs in the project preferences dialog
+ in the Eclipse plugin, and contributed to its internationalization and localization.
+</para>
+
+<para>Thomas Einwaller fixed bugs in the project preferences dialog in the Eclipse plugin.</para>
+
+<para>Jeff Knox contributed support for the warningsProperty attribute
+in the Ant task.</para>
+
+<para>Peter Hendriks extended the Eclipse plugin preferences,
+and fixed a bug related to renaming the Eclipse plugin ID.</para>
+
+<para>Mark McKay contributed an Ant task to launch the findbugs frame.</para>
+
+<para>Dieter von Holten (dvholten) contributed
+some German improvements to findbugs_de.properties.</para>
+
+
+<para>If you have contributed to &FindBugs;, but aren't mentioned above,
+please send email to <email>findbugs@cs.umd.edu</email> (and also accept
+our humble apologies).</para>
+
+</sect1>
+
+<sect1>
+<title>Software Used</title>
+
+<para>&FindBugs; uses several open-source software packages, without which its
+development would have been much more difficult.</para>
+
+<sect2>
+<title>BCEL</title>
+<para>&FindBugs; includes software developed by the Apache Software Foundation
+(<ulink url="http://www.apache.org/">http://www.apache.org/</ulink>).
+Specifically, it uses the <ulink url="http://jakarta.apache.org/bcel/">Byte Code
+Engineering Library</ulink>.</para>
+</sect2>
+
+<sect2>
+<title>ASM</title>
+<para>&FindBugs; uses the <ulink url="http://asm.objectweb.org/">ASM</ulink>
+bytecode framework, which is distributed under the following license:</para>
+
+<blockquote>
+<para>
+Copyright (c) 2000-2005 INRIA, France Telecom
+All rights reserved.
+</para>
+
+<para>
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+</para>
+
+<orderedlist numeration="arabic">
+ <listitem><para>
+ Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ </para></listitem>
+ <listitem><para>
+ Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ </para></listitem>
+ <listitem><para>
+ Neither the name of the copyright holders nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+ </para></listitem>
+</orderedlist>
+
+<para>
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+</para>
+</blockquote>
+</sect2>
+
+<sect2>
+<title>DOM4J</title>
+<para>&FindBugs; uses <ulink url="http://dom4j.org">DOM4J</ulink>, which is
+distributed under the following license:</para>
+
+<blockquote>
+<para>
+Copyright 2001 (C) MetaStuff, Ltd. All Rights Reserved.
+</para>
+
+<para>
+Redistribution and use of this software and associated documentation
+("Software"), with or without modification, are permitted provided that
+the following conditions are met:
+</para>
+
+<orderedlist numeration="arabic">
+ <listitem><para>
+ Redistributions of source code must retain copyright statements and
+ notices. Redistributions must also contain a copy of this document.
+ </para></listitem>
+ <listitem><para>
+ Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ </para></listitem>
+ <listitem><para>
+ The name "DOM4J" must not be used to endorse or promote products
+ derived from this Software without prior written permission
+ of MetaStuff, Ltd. For written permission, please contact
+ <email>dom4j-info@metastuff.com</email>.
+ </para></listitem>
+ <listitem><para>
+ Products derived from this Software may not be called "DOM4J" nor may
+ "DOM4J" appear in their names without prior written permission of
+ MetaStuff, Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
+ </para></listitem>
+ <listitem><para>
+ Due credit should be given to the DOM4J Project (<ulink url="http://dom4j.org/">http://dom4j.org/</ulink>).
+ </para></listitem>
+</orderedlist>
+
+<para>
+THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS''
+AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+</para>
+</blockquote>
+
+</sect2>
+
+</sect1>
+
+</chapter>
+
+
+</book>
--- /dev/null
+<?xml version='1.0'?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version='1.0'
+ xmlns="http://www.w3.org/TR/xhtml1/transitional"
+ exclude-result-prefixes="#default">
+
+<!-- build.xml will substitute the real path to chunk.xsl here. -->
+<xsl:import href="/Users/langmead/software/docbook-xsl-1.71.1/html/chunk.xsl"/>
+
+<xsl:template name="user.header.content">
+
+</xsl:template>
+
+<!-- This causes the stylesheet to put chapters in a single HTML file,
+ rather than putting individual sections into seperate files. -->
+<xsl:variable name="chunk.section.depth">0</xsl:variable>
+
+<!-- Put the HTML in the "manual" directory. -->
+<xsl:variable name="base.dir">manual/</xsl:variable>
+
+<!-- Enumerate sections. -->
+<xsl:variable name="section.autolabel">1</xsl:variable>
+
+<!-- Name the HTML files based on the id of the document elements. -->
+<xsl:variable name="use.id.as.filename">1</xsl:variable>
+
+<!-- Use graphics in admonitions -->
+<xsl:variable name="admon.graphics">1</xsl:variable>
+
+<!-- Admonition graphics are in the same place as the generated HTML. -->
+<xsl:variable name="admon.graphics.path"></xsl:variable>
+
+<!-- Just put chapters and sect1s in the TOC. -->
+<xsl:variable name="toc.section.depth">1</xsl:variable>
+
+</xsl:stylesheet>
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 14. Acknowledgments</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="license.html" title="Chapter 13. License"></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">Chapter 14. Acknowledgments</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="license.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="acknowledgments"></a>Chapter 14. Acknowledgments</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="acknowledgments.html#d0e3272">1. Contributors</a></span></dt><dt><span class="sect1"><a href="acknowledgments.html#d0e3395">2. Software Used</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e3272"></a>1. Contributors</h2></div></div></div><p><span class="application">FindBugs</span> was originally written by Bill Pugh (<code class="email"><<a href="mailto:pugh@cs.umd.edu">pugh@cs.umd.edu</a>></code>).
+David Hovemeyer (<code class="email"><<a href="mailto:daveho@cs.umd.edu">daveho@cs.umd.edu</a>></code>) implemented some of the
+detectors, added the Swing GUI, and is a co-maintainer.</p><p>Mike Fagan (<code class="email"><<a href="mailto:mfagan@tde.com">mfagan@tde.com</a>></code>) contributed the <span class="application">Ant</span> build script,
+the <span class="application">Ant</span> task, and several enhancements and bug fixes to the GUI.</p><p>Germano Leichsenring contributed Japanese translations of the bug
+summaries.</p><p>David Li contributed the Emacs bug report format.</p><p>Peter D. Stout contributed recursive detection of Class-Path
+attributes in analyzed Jar files, German translations of
+text used in the Swing GUI, and other fixes.</p><p>Peter Friese wrote the <span class="application">FindBugs</span> Eclipse plugin.</p><p>Rohan Lloyd contributed several Mac OS X enhancements,
+bug detector improvements,
+and maintains the Fink package for <span class="application">FindBugs</span>.</p><p>Hiroshi Okugawa translated the <span class="application">FindBugs</span> manual and
+more of the bug summaries into Japanese.</p><p>Phil Crosby enhanced the Eclipse plugin to add a view
+to display the bug details.</p><p>Dave Brosius fixed a number of bugs, added user preferences
+to the Swing GUI, improved several bug detectors, and
+contributed the string concatenation detector.</p><p>Thomas Klaeger contributed a number of bug fixes and
+bug detector improvements.</p><p>Andrei Loskutov made a number of improvements to the
+Eclipse plugin.</p><p>Brian Goetz contributed a major refactoring of the
+visitor classes to improve readability and understandability.</p><p> Pete Angstadt fixed several problems in the Swing GUI.</p><p>Francis Lalonde provided a task resource file for the
+FindBugs Ant task.</p><p>Garvin LeClaire contributed support for output in
+Xdocs format, for use by Maven.</p><p>Holger Stenzhorn contributed improved German translations of items
+in the Swing GUI.</p><p>Juha Knuutila contributed Finnish translations of items
+in the Swing GUI.</p><p>Tanel Lebedev contributed Estonian translations of items
+in the Swing GUI.</p><p>Hanai Shisei (ruimo) contributed full Japanese translations of
+bug messages, and text used in the Swing GUI.</p><p>David Cotton contributed Fresh translations for bug
+messages and for the Swing GUI.</p><p>Michael Tamm contributed support for the "errorProperty" attribute
+in the Ant task.</p><p>Thomas Kuehne improved the German translation of the Swing GUI.</p><p>Len Trigg improved source file support for the Emacs output mode.</p><p>Greg Bentz provided a fix for the hashcode/equals detector.</p><p>K. Hashimoto contributed internationalization fixes and several other
+ bug fixes.</p><p>
+ Glenn Boysko contributed support for ignoring specified local
+ variables in the dead local store detector.
+</p><p>
+ Jay Dunning contributed a detector to find equality comparisons
+ of floating-point values, and overhauled the analysis summary
+ report and its representation in the saved XML format.
+</p><p>
+ Olivier Parent contributed updated French translations for bug descriptions and
+ Swing GUI.
+</p><p>
+ Chris Nappin contributed the <code class="filename">plain.xsl</code>
+ stylesheet.
+</p><p>
+ Etienne Giraudy contributed the <code class="filename">fancy.xsl</code> and <code class="filename">fancy-hist.xsl</code>
+ stylesheets, and made improvements to the <span><strong class="command">-xml:withMessages</strong></span>
+ option.
+</p><p>
+ Takashi Okamoto fixed bugs in the project preferences dialog
+ in the Eclipse plugin, and contributed to its internationalization and localization.
+</p><p>Thomas Einwaller fixed bugs in the project preferences dialog in the Eclipse plugin.</p><p>Jeff Knox contributed support for the warningsProperty attribute
+in the Ant task.</p><p>Peter Hendriks extended the Eclipse plugin preferences,
+and fixed a bug related to renaming the Eclipse plugin ID.</p><p>Mark McKay contributed an Ant task to launch the findbugs frame.</p><p>Dieter von Holten (dvholten) contributed
+some German improvements to findbugs_de.properties.</p><p>If you have contributed to <span class="application">FindBugs</span>, but aren't mentioned above,
+please send email to <code class="email"><<a href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>></code> (and also accept
+our humble apologies).</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e3395"></a>2. Software Used</h2></div></div></div><p><span class="application">FindBugs</span> uses several open-source software packages, without which its
+development would have been much more difficult.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e3402"></a>2.1. BCEL</h3></div></div></div><p><span class="application">FindBugs</span> includes software developed by the Apache Software Foundation
+(<a href="http://www.apache.org/" target="_top">http://www.apache.org/</a>).
+Specifically, it uses the <a href="http://jakarta.apache.org/bcel/" target="_top">Byte Code
+Engineering Library</a>.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e3415"></a>2.2. ASM</h3></div></div></div><p><span class="application">FindBugs</span> uses the <a href="http://asm.objectweb.org/" target="_top">ASM</a>
+bytecode framework, which is distributed under the following license:</p><div class="blockquote"><blockquote class="blockquote"><p>
+Copyright (c) 2000-2005 INRIA, France Telecom
+All rights reserved.
+</p><p>
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+</p><div class="orderedlist"><ol type="1"><li><p>
+ Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ </p></li><li><p>
+ Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ </p></li><li><p>
+ Neither the name of the copyright holders nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+ </p></li></ol></div><p>
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+</p></blockquote></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e3442"></a>2.3. DOM4J</h3></div></div></div><p><span class="application">FindBugs</span> uses <a href="http://dom4j.org" target="_top">DOM4J</a>, which is
+distributed under the following license:</p><div class="blockquote"><blockquote class="blockquote"><p>
+Copyright 2001 (C) MetaStuff, Ltd. All Rights Reserved.
+</p><p>
+Redistribution and use of this software and associated documentation
+("Software"), with or without modification, are permitted provided that
+the following conditions are met:
+</p><div class="orderedlist"><ol type="1"><li><p>
+ Redistributions of source code must retain copyright statements and
+ notices. Redistributions must also contain a copy of this document.
+ </p></li><li><p>
+ Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ </p></li><li><p>
+ The name "DOM4J" must not be used to endorse or promote products
+ derived from this Software without prior written permission
+ of MetaStuff, Ltd. For written permission, please contact
+ <code class="email"><<a href="mailto:dom4j-info@metastuff.com">dom4j-info@metastuff.com</a>></code>.
+ </p></li><li><p>
+ Products derived from this Software may not be called "DOM4J" nor may
+ "DOM4J" appear in their names without prior written permission of
+ MetaStuff, Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
+ </p></li><li><p>
+ Due credit should be given to the DOM4J Project (<a href="http://dom4j.org/" target="_top">http://dom4j.org/</a>).
+ </p></li></ol></div><p>
+THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS''
+AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+</p></blockquote></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="license.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Chapter 13. License </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 9. Analysis Properties</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="filter.html" title="Chapter 8. Filter Files"><link rel="next" href="annotations.html" title="Chapter 10. Annotations"></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">Chapter 9. Analysis Properties</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="filter.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="annotations.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="analysisprops"></a>Chapter 9. Analysis Properties</h2></div></div></div><p>
+<span class="application">FindBugs</span> allows several aspects of the analyses it performs to be
+customized. System properties are used to configure these options.
+This chapter describes the configurable analysis options.
+</p><p>
+The analysis options have two main purposes. First, they allow you
+to inform <span class="application">FindBugs</span> about the meaning of methods in your application,
+so that it can produce more accurate results, or produce fewer
+false warnings. Second, they allow you to configure the precision
+of the analysis performed. Reducing analysis precision can save
+memory and analysis time, at the expense of missing some real bugs,
+or producing more false warnings.
+</p><p>
+The analysis options are set using the <span><strong class="command">-property</strong></span>
+command line option. For example:
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs -textui -property "cfg.noprune=true" <em class="replaceable"><code>myApp.jar</code></em></strong></span>
+</pre><p>
+</p><p>
+The list of configurable analysis properties is shown in
+<a href="analysisprops.html#analysisproptable" title="Table 9.1. Configurable Analysis Properties">Table 9.1, “Configurable Analysis Properties”</a>.
+</p><div class="table"><a name="analysisproptable"></a><p class="title"><b>Table 9.1. Configurable Analysis Properties</b></p><div class="table-contents"><table summary="Configurable Analysis Properties" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Property Name</th><th align="left">Value</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left">findbugs.assertionmethods</td><td align="left">Comma-separated list of fully qualified method names:
+ e.g., "com.foo.MyClass.checkAssertion"</td><td align="left">This property specifies the names of methods that are used
+ to check program assertions. Specifying these methods allows
+ the null pointer dereference bug detector to avoid reporting
+ false warnings for values which are checked by assertion
+ methods.</td></tr><tr><td align="left">findbugs.de.comment</td><td align="left">true or false</td><td align="left">If true, the DroppedException detector scans source code
+ for empty catch blocks for a comment, and if one is found, does
+ not report a warning.</td></tr><tr><td align="left">findbugs.maskedfields.locals</td><td align="left">true or false</td><td align="left">If true, emit low priority warnings for local variables
+ which obscure fields. Default is false.</td></tr><tr><td align="left">findbugs.nullderef.assumensp</td><td align="left">true or false</td><td align="left">not used
+ (intention: If true, the null dereference detector assumes that any
+ reference value returned from a method or passed to a method
+ in a parameter might be null. Default is false. Note that
+ enabling this property will very likely cause a large number
+ of false warnings to be produced.)</td></tr><tr><td align="left">findbugs.refcomp.reportAll</td><td align="left">true or false</td><td align="left">If true, all suspicious reference comparisons
+ using the == and != operators are reported. If false,
+ only one such warning is issued per method. Default
+ is false.</td></tr><tr><td align="left">findbugs.sf.comment</td><td align="left">true or false</td><td align="left">If true, the SwitchFallthrough detector will only report
+ warnings for cases where the source code does not have a comment
+ containing the words "fall" or "nobreak". (An accurate source
+ path must be used for this feature to work correctly.)
+ This helps find cases where the switch fallthrough is likely
+ to be unintentional.</td></tr></tbody></table></div></div><br class="table-break"></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="filter.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="annotations.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 8. Filter Files </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 10. Annotations</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 10. Annotations</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="analysisprops.html" title="Chapter 9. Analysis Properties"><link rel="next" href="ch11.html" title="Chapter 11. Using rejarForAnalysis"></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">Chapter 10. Annotations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="analysisprops.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch11.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="annotations"></a>Chapter 10. Annotations</h2></div></div></div><p>
+<span class="application">FindBugs</span> supports several annotations to express the developer's intent
+so that FindBugs can issue warnings more appropriately. You need to use
+Java 5 to use annotations, and must place the annotations.jar on the
+classpath while compiling your program.
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.CheckForNull</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Field, Method, Parameter, Local variable
+ <p>
+The annotated element might be null, and uses of the element should check for null.
+When this annotation is applied to a method it applies to the method return value.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.CheckReturnValue</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Method, Constructor
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">priority:</strong></span>The priority of the warning (HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </p><p>
+ <span><strong class="command">explanation:</strong></span>A textual explaination of why the return value should be checked. Default value:"".
+ </p></dd></dl></div><p>
+This annotation is used to denote a method whose return value should always be checked after invoking the method.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.DefaultAnnotation</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Type, Package
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>Annotation class objects. More than one class can be specified.
+ </p><p>
+ <span><strong class="command">priority:</strong></span>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </p></dd></dl></div><p>
+Indicates that all members of the class or package should be annotated with the default
+value of the supplied annotation classes. This would be used for behavior annotations
+such as @NonNull, @CheckForNull, or @CheckReturnValue. In particular, you can use
+@DefaultAnnotation(NonNull.class) on a class or package, and then use @Nullable only
+on those parameters, methods or fields that you want to allow to be null.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Type, Package
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>Annotation class objects. More than one class can be specified.
+ </p><p>
+ <span><strong class="command">priority:</strong></span>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </p></dd></dl></div><p>
+This is same as the DefaultAnnotation except it only applys to fields.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Type, Package
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>Annotation class objects. More than one class can be specified.
+ </p><p>
+ <span><strong class="command">priority:</strong></span>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </p></dd></dl></div><p>
+This is same as the DefaultAnnotation except it only applys to methods.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Type, Package
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>Annotation class objects. More than one class can be specified.
+ </p><p>
+ <span><strong class="command">priority:</strong></span>Default priority(HIGH, MEDIUM, LOW, IGNORE). Default value:MEDIUM.
+ </p></dd></dl></div><p>
+This is same as the DefaultAnnotation except it only applys to method parameters.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.NonNull</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Field, Method, Parameter, Local variable
+ <p>
+The annotated element must not be null.
+Annotated fields must not be null after construction has completed. Annotated methods must have non-null return values.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.Nullable</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Field, Method, Parameter, Local variable
+ <p>
+The annotated element could be null under some circumstances. In general, this means
+developers will have to read the documentation to determine when a null value is
+acceptable and whether it is neccessary to check for a null value.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.OverrideMustInvoke</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Method
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>Specify when the super invocation should be
+ performed (FIRST, ANYTIME, LAST). Default value:ANYTIME.
+ </p></dd></dl></div><p>
+Used to annotate a method that, if overridden, must (or should) be invoke super
+in the overriding method. Examples of such methods include finalize() and clone().
+The argument to the method indicates when the super invocation should occur:
+at any time, at the beginning of the overriding method, or at the end of the overriding method.
+(This anotation is not implmemented in FindBugs as of September 8, 2006).
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.PossiblyNull</strong></span></span></dt><dd><p>
+This annotation is deprecated. Use CheckForNull instead.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.SuppressWarnings</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Type, Field, Method, Parameter, Constructor, Local variable, Package
+ <div class="variablelist"><dl><dt><span class="term"><span><strong class="command">[Parameter]</strong></span></span></dt><dd><p>
+ <span><strong class="command">value:</strong></span>The name of the warning. More than one name can be specified.
+ </p><p>
+ <span><strong class="command">justification:</strong></span>Reason why the warning should be ignored. Default value:"".
+ </p></dd></dl></div><p>
+The set of warnings that are to be suppressed by the compiler in the annotated element.
+Duplicate names are permitted. The second and successive occurrences of a name are ignored.
+The presence of unrecognized warning names is <span class="emphasis"><em>not</em></span> an error: Compilers
+must ignore any warning names they do not recognize. They are, however, free to emit a
+warning if an annotation contains an unrecognized warning name. Compiler vendors should
+document the warning names they support in conjunction with this annotation type. They
+are encouraged to cooperate to ensure that the same names work across multiple compilers.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.UnknownNullness</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Field, Method, Parameter, Local variable
+ <p>
+Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.
+ </p></dd><dt><span class="term"><span><strong class="command">edu.umd.cs.findbugs.annotations.UnknownNullness</strong></span></span></dt><dd><span><strong class="command">[Target]</strong></span> Field, Method, Parameter, Local variable
+ <p>
+Used to indicate that the nullness of the target is unknown, or my vary in unknown ways in subclasses.
+ </p></dd></dl></div><p>
+ <span class="application">FindBugs</span> also supports the following annotations:
+</p><div class="itemizedlist"><ul type="disc"><li>net.jcip.annotations.GuardedBy</li><li>net.jcip.annotations.Immutable</li><li>net.jcip.annotations.NotThreadSafe</li><li>net.jcip.annotations.ThreadSafe</li></ul></div><p>
+</p><p>
+You can refer the JCIP annotation <a href="http://jcip.net/annotations/doc/index.html" target="_top">
+API documentation</a> at <a href="http://jcip.net/" target="_top">Java Concurrency in Practice</a>.
+</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="analysisprops.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch11.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Analysis Properties </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 11. Using rejarForAnalysis</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 6. Using the FindBugs™ Ant task</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="textui.html" title="Chapter 5. Using the FindBugs™ Command Line Interface"><link rel="next" href="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"></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">Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="textui.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="eclipse.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="anttask"></a>Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="anttask.html#d0e1012">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1050">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1121">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1146">4. Parameters</a></span></dt></dl></div><p>
+This chapter describes how to integrate <span class="application">FindBugs</span> into a build script
+for <a href="http://ant.apache.org/" target="_top"><span class="application">Ant</span></a>, which is a popular Java build
+and deployment tool. Using the <span class="application">FindBugs</span> <span class="application">Ant</span> task, your build script can
+automatically run <span class="application">FindBugs</span> on your Java code.
+</p><p>
+The <span class="application">Ant</span> task was generously contributed by Mike Fagan.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1012"></a>1. Installing the <span class="application">Ant</span> task</h2></div></div></div><p>
+To install the <span class="application">Ant</span> task, simply copy <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/lib/findbugs-ant.jar</code>
+into the <code class="filename">lib</code> subdirectory of your <span class="application">Ant</span> installation.
+
+</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>It is strongly recommended that you use the <span class="application">Ant</span> task with the version
+of <span class="application">FindBugs</span> it was included with. We do not guarantee that the <span class="application">Ant</span> task Jar file
+will work with any version of <span class="application">FindBugs</span> other than the one it was included with.</p></td></tr></table></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1050"></a>2. Modifying build.xml</h2></div></div></div><p>
+To incorporate <span class="application">FindBugs</span> into <code class="filename">build.xml</code> (the build script
+for <span class="application">Ant</span>), you first need to add a task definition. This should appear as follows:
+
+</p><pre class="screen">
+ <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask"/>
+</pre><p>
+
+The task definition specifies that when a <code class="literal">findbugs</code> element is
+seen in <code class="filename">build.xml</code>, it should use the indicated class to execute the task.
+</p><p>
+After you have added the task definition, you can define a target
+which uses the <code class="literal">findbugs</code> task. Here is an example
+which could be added to the <code class="filename">build.xml</code> for the
+Apache <a href="http://jakarta.apache.org/bcel/" target="_top">BCEL</a> library.
+
+</p><pre class="screen">
+ <property name="findbugs.home" value="/export/home/daveho/work/findbugs" />
+
+ <target name="findbugs" depends="jar">
+ <findbugs home="${findbugs.home}"
+ output="xml"
+ outputFile="bcel-fb.xml" >
+ <auxClasspath path="${basedir}/lib/Regex.jar" />
+ <sourcePath path="${basedir}/src/java" />
+ <class location="${basedir}/bin/bcel.jar" />
+ </findbugs>
+ </target>
+</pre><p>
+
+The <code class="literal">findbugs</code> element must have the <code class="literal">home</code>
+attribute set to the directory in which <span class="application">FindBugs</span> is installed; in other words,
+<em class="replaceable"><code>$FINDBUGS_HOME</code></em>. See <a href="installing.html" title="Chapter 2. Installing and Running FindBugs™">Chapter 2, <i>Installing and Running <span class="application">FindBugs</span>™</i></a>.
+</p><p>
+This target will execute <span class="application">FindBugs</span> on <code class="filename">bcel.jar</code>, which is the
+Jar file produced by BCEL's build script. (By making it depend on the "jar"
+target, we ensure that the library is fully compiled before running <span class="application">FindBugs</span> on it.)
+The output of <span class="application">FindBugs</span> will be saved in XML format to a file called
+<code class="filename">bcel-fb.xml</code>.
+An auxiliary Jar file, <code class="filename">Regex.jar</code>, is added to the aux classpath,
+because it is referenced by the main BCEL library. A source path is specified
+so that the saved bug data will have accurate references to the BCEL source code.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1121"></a>3. Executing the task</h2></div></div></div><p>
+Here is an example of invoking <span class="application">Ant</span> from the command line, using the <code class="literal">findbugs</code>
+target defined above.
+
+</p><pre class="screen">
+ <code class="prompt">[daveho@noir]$</code> <span><strong class="command">ant findbugs</strong></span>
+ Buildfile: build.xml
+
+ init:
+
+ compile:
+
+ examples:
+
+ jar:
+
+ findbugs:
+ [findbugs] Running FindBugs...
+ [findbugs] Bugs were found
+ [findbugs] Output saved to bcel-fb.xml
+
+ BUILD SUCCESSFUL
+ Total time: 35 seconds
+</pre><p>
+
+In this case, because we saved the bug results in an XML file, we can
+use the <span class="application">FindBugs</span> GUI to view the results; see <a href="gui.html" title="Chapter 4. Using the FindBugs™ Graphical User Interface">Chapter 4, <i>Using the <span class="application">FindBugs</span>™ Graphical User Interface</i></a>.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1146"></a>4. Parameters</h2></div></div></div><p>This section describes the parameters that may be specified when
+using the <span class="application">FindBugs</span> task.
+
+</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">class</code></span></dt><dd><p>
+ A nested element specifying which classes to analyze. The <code class="literal">class</code>
+ element must specify a <code class="literal">location</code> attribute which names the
+ archive file (jar, zip, etc.), directory, or class file to be analyzed. Multiple <code class="literal">class</code>
+ elements may be specified as children of a single <code class="literal">findbugs</code> element.
+ </p></dd><dt><span class="term"><code class="literal">auxClasspath</code></span></dt><dd><p>
+ An optional nested element which specifies a classpath (Jar files or directories)
+ containing classes used by the analyzed library or application, but which
+ you don't want to analyze. It is specified the same way as
+ <span class="application">Ant</span>'s <code class="literal">classpath</code> element for the Java task.
+ </p></dd><dt><span class="term"><code class="literal">sourcePath</code></span></dt><dd><p>
+ An optional nested element which specifies a source directory path
+ containing source files used to compile the Java code being analyzed.
+ By specifying a source path, any generated XML bug output will have
+ complete source information, which allows later viewing in the
+ GUI.
+ </p></dd><dt><span class="term"><code class="literal">home</code></span></dt><dd><p>
+ A required attribute.
+ It must be set to the name of the directory where <span class="application">FindBugs</span> is installed.
+ </p></dd><dt><span class="term"><code class="literal">quietErrors</code></span></dt><dd><p>
+ An optional boolean attribute.
+ If true, reports of serious analysis errors and missing classes will
+ be suppressed in the <span class="application">FindBugs</span> output. Default is false.
+ </p></dd><dt><span class="term"><code class="literal">reportLevel</code></span></dt><dd><p>
+ An optional attribute. It specifies
+ the priority threshold for reporting bugs. If set to "low", all bugs are reported.
+ If set to "medium" (the default), medium and high priority bugs are reported.
+ If set to "high", only high priority bugs are reported.
+ </p></dd><dt><span class="term"><code class="literal">output</code></span></dt><dd><p>
+ Optional attribute.
+ It specifies the output format. If set to "xml" (the default), output
+ is in XML format.
+ If set to "xml:withMessages", output is in XML format augmented with
+ human-readable messages. (You should use this format if you plan
+ to generate a report using an XSL stylesheet.)
+ If set to "html", output is in HTML formatted (default stylesheet is default.xsl).
+ If set to "text", output is in ad-hoc text format.
+ If set to "emacs", output is in <a href="http://www.gnu.org/software/emacs/" target="_top">Emacs</a> error message format.
+ If set to "xdocs", output is xdoc XML for use with Apache Maven.
+ </p></dd><dt><span class="term"><code class="literal">stylesheet</code></span></dt><dd><p>
+ Optional attribute.
+ It specifies the stylesheet to use to generate html output when the output is set to html.
+ Stylesheets included in the FindBugs distribution include default.xsl, fancy.xsl, fancy-hist.xsl, plain.xsl, and summary.xsl.
+ The default value, if no stylesheet attribute is provided, is default.xsl.
+
+ </p></dd><dt><span class="term"><code class="literal">sort</code></span></dt><dd><p>
+ Optional attribute. If the <code class="literal">output</code> attribute
+ is set to "text", then the <code class="literal">sort</code> attribute specifies
+ whether or not reported bugs are sorted by class. Default is true.
+ </p></dd><dt><span class="term"><code class="literal">outputFile</code></span></dt><dd><p>
+ Optional attribute. If specified, names the output file in which the
+ <span class="application">FindBugs</span> output will be saved. By default, the output is displayed
+ directly by <span class="application">Ant</span>.
+ </p></dd><dt><span class="term"><code class="literal">debug</code></span></dt><dd><p>
+ Optional boolean attribute. If set to true, <span class="application">FindBugs</span> prints diagnostic
+ information about which classes are being analyzed, and which bug pattern
+ detectors are being run. Default is false.
+ </p></dd><dt><span class="term"><code class="literal">effort</code></span></dt><dd><p>
+ Set the analysis effort level. The value specified should be
+ one of <code class="literal">min</code>, <code class="literal">default</code>,
+ or <code class="literal">max</code>. See <a href="installing.html#commandLineOptions" title="3. Command Line Options">Section 3, “Command Line Options”</a>
+ for more information about setting the analysis level.
+ </p></dd><dt><span class="term"><code class="literal">conserveSpace</code></span></dt><dd><p>Synonym for effort="min".</p></dd><dt><span class="term"><code class="literal">workHard</code></span></dt><dd><p>Synonym for effort="max".</p></dd><dt><span class="term"><code class="literal">visitors</code></span></dt><dd><p>
+ Optional attribute. It specifies a comma-separated list of bug detectors
+ which should be run. The bug detectors are specified by their class names,
+ without any package qualification. By default, all detectors which are
+ not disabled by default are run.
+ </p></dd><dt><span class="term"><code class="literal">omitVisitors</code></span></dt><dd><p>
+ Optional attribute. It is like the <code class="literal">visitors</code> attribute,
+ except it specifies detectors which will <span class="emphasis"><em>not</em></span> be run.
+ </p></dd><dt><span class="term"><code class="literal">excludeFilter</code></span></dt><dd><p>
+ Optional attribute. It specifies the filename of a filter specifying bugs
+ to exclude from being reported. See <a href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a>.
+ </p></dd><dt><span class="term"><code class="literal">includeFilter</code></span></dt><dd><p>
+ Optional attribute. It specifies the filename of a filter specifying
+ which bugs are reported. See <a href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a>.
+ </p></dd><dt><span class="term"><code class="literal">projectFile</code></span></dt><dd><p>
+ Optional attribute. It specifies the name of a project file.
+ Project files are created by the <span class="application">FindBugs</span> GUI, and specify classes,
+ aux classpath entries, and source directories. By naming a project,
+ you don't need to specify any <code class="literal">class</code> elements,
+ nor do you need to specify <code class="literal">auxClasspath</code> or
+ <code class="literal">sourcePath</code> attributes.
+ See <a href="gui.html" title="Chapter 4. Using the FindBugs™ Graphical User Interface">Chapter 4, <i>Using the <span class="application">FindBugs</span>™ Graphical User Interface</i></a> for how to create a project.
+ </p></dd><dt><span class="term"><code class="literal">jvmargs</code></span></dt><dd><p>
+ Optional attribute. It specifies any arguments that should be passed
+ to the Java virtual machine used to run <span class="application">FindBugs</span>. You may need to
+ use this attribute to specify flags to increase the amount of memory
+ the JVM may use if you are analyzing a very large program.
+ </p></dd><dt><span class="term"><code class="literal">systemProperty</code></span></dt><dd><p>
+ Optional nested element. If specified, defines a system property.
+ The <code class="literal">name</code> attribute specifies the name of the
+ system property, and the <code class="literal">value</code> attribute specifies
+ the value of the system property.
+ </p></dd><dt><span class="term"><code class="literal">timeout</code></span></dt><dd><p>
+ Optional attribute. It specifies the amount of time, in milliseconds,
+ that the Java process executing <span class="application">FindBugs</span> may run before it is
+ assumed to be hung and is terminated. The default is 600,000
+ milliseconds, which is ten minutes. Note that for very large
+ programs, <span class="application">FindBugs</span> may require more than ten minutes to complete its
+ analysis.
+ </p></dd><dt><span class="term"><code class="literal">failOnError</code></span></dt><dd><p>
+ Optional boolean attribute. Whether to abort the build process if there is an
+ error running <span class="application">FindBugs</span>. Defaults to "false"
+ </p></dd><dt><span class="term"><code class="literal">errorProperty</code></span></dt><dd><p>
+ Optional attribute which specifies the name of a property that
+ will be set to "true" if an error occurs while running <span class="application">FindBugs</span>.
+ </p></dd><dt><span class="term"><code class="literal">warningsProperty</code></span></dt><dd><p>
+ Optional attribute which specifies the name of a property
+ that will be set to "true" if any warnings are reported by
+ <span class="application">FindBugs</span> on the analyzed program.
+ </p></dd></dl></div><p>
+
+
+</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="textui.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="eclipse.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Using the <span class="application">FindBugs</span>™ Command Line Interface </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 7. Using the <span class="application">FindBugs</span>™ Eclipse plugin</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 3. Building FindBugs™ from Source</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="installing.html" title="Chapter 2. Installing and Running FindBugs™"><link rel="next" href="gui.html" title="Chapter 4. Using the FindBugs™ Graphical User Interface"></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">Chapter 3. Building <span class="application">FindBugs</span>™ from Source</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="installing.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="gui.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="building"></a>Chapter 3. Building <span class="application">FindBugs</span>™ from Source</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="building.html#d0e594">1. Prerequisites</a></span></dt><dt><span class="sect1"><a href="building.html#d0e686">2. Extracting the Source Distribution</a></span></dt><dt><span class="sect1"><a href="building.html#d0e699">3. Modifying <code class="filename">build.properties</code></a></span></dt><dt><span class="sect1"><a href="building.html#d0e751">4. Running <span class="application">Ant</span></a></span></dt><dt><span class="sect1"><a href="building.html#d0e845">5. Running <span class="application">FindBugs</span>™</a></span></dt></dl></div><p>
+This chapter describes how to build <span class="application">FindBugs</span> from source code. Unless you are
+interesting in modifying <span class="application">FindBugs</span>, you will probably want to skip to the
+<a href="gui.html" title="Chapter 4. Using the FindBugs™ Graphical User Interface">next chapter</a>.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e594"></a>1. Prerequisites</h2></div></div></div><p>
+To compile <span class="application">FindBugs</span> from source, you will need the following:
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+ The <a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0-source.zip?download" target="_top"><span class="application">FindBugs</span> source distribution</a>
+ </p></li><li><p>
+ <a href="http://java.sun.com/j2se/" target="_top">JDK 1.5.0 beta or later</a>
+ </p></li><li><p>
+ <a href="http://ant.apache.org/" target="_top">Apache <span class="application">Ant</span></a>, version 1.6.3 or later
+ </p></li></ul></div><p>
+</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
+ The version of <span class="application">Ant</span> included as <code class="filename">/usr/bin/ant</code> on
+ Redhat Linux systems will <span class="emphasis"><em>not</em></span> work for compiling
+ <span class="application">FindBugs</span>. We recommend you install a binary distribution of <span class="application">Ant</span>
+ downloaded from the <a href="http://ant.apache.org/" target="_top"><span class="application">Ant</span> website</a>.
+ Make sure that when you run <span class="application">Ant</span> your <em class="replaceable"><code>JAVA_HOME</code></em>
+ environment variable points to the directory in which you installed
+ JDK 1.5 (or later).
+ </p></td></tr></table></div><p>
+If you want to be able to generate formatted versions of the <span class="application">FindBugs</span> documentation,
+you will also need the following software:
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+ The <a href="http://docbook.sourceforge.net/projects/xsl/index.html" target="_top">DocBook XSL Stylesheets</a>.
+ These are required to convert the <span class="application">FindBugs</span> manual into HTML and PDF formats.
+ </p></li><li><p>
+ The <a href="http://saxon.sourceforge.net/" target="_top"><span class="application">Saxon</span> XSLT Processor</a>.
+ The file <code class="filename">saxon.jar</code> should be in your <code class="envar">CLASSPATH</code>.
+ </p></li></ul></div><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e686"></a>2. Extracting the Source Distribution</h2></div></div></div><p>
+After you download the source distribution, you'll need to extract it into
+a working directory. A typical command to do this is:
+
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">unzip findbugs-1.3.0-source.zip</strong></span>
+</pre><p>
+
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e699"></a>3. Modifying <code class="filename">build.properties</code></h2></div></div></div><p>
+If you intend to build the FindBugs documentation,
+you will need to modify the <code class="filename">build.properties</code> file
+used by the <a href="http://ant.apache.org/" target="_top"><span class="application">Ant</span></a>
+<code class="filename">build.xml</code> file to build <span class="application">FindBugs</span>.
+If you do not want to build the FindBugs documentation, then you
+can ignore this file.
+</p><p>
+The <code class="filename">build.properties</code> looks like this:
+</p><pre class="programlisting">
+
+# User Configuration:
+# This section must be modified to reflect your system.
+
+local.software.home =/export/home/daveho/linux
+
+# Set this to the directory containing the DocBook Modular XSL Stylesheets
+# from http://docbook.sourceforge.net/projects/xsl/
+
+xsl.stylesheet.home =${local.software.home}/docbook/docbook-xsl-1.71.1
+
+# Set this to the directory where Saxon (http://saxon.sourceforge.net/)
+# is installed.
+
+saxon.home =${local.software.home}/java/saxon-6.5.5
+
+</pre><p>
+</p><p>
+The <code class="varname">xsl.stylesheet.home</code> property specifies the full
+path to the directory where you have installed the
+<a href="http://docbook.sourceforge.net/projects/xsl/" target="_top">DocBook Modular XSL
+Stylesheets</a>. You only need to specify this property if you will be
+generating the <span class="application">FindBugs</span> documentation.
+</p><p>
+The <code class="varname">saxon.home</code> property is the full path to the
+directory where you installed the <a href="http://saxon.sourceforge.net/" target="_top"><span class="application">Saxon</span> XSLT Processor</a>.
+You only need to specify this property if you will be
+generating the <span class="application">FindBugs</span> documentation.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e751"></a>4. Running <span class="application">Ant</span></h2></div></div></div><p>
+Once you have extracted the source distribution,
+made sure that <span class="application">Ant</span> is installed,
+modified <code class="filename">build.properties</code> (optional),
+and configured the tools (such as <span class="application">Saxon</span>),
+you are ready to build <span class="application">FindBugs</span>. Invoking <span class="application">Ant</span> is a simple matter
+of running the command
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">ant <em class="replaceable"><code>target</code></em></strong></span>
+</pre><p>
+where <em class="replaceable"><code>target</code></em> is one of the following:
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">build</strong></span></span></dt><dd><p>
+ This target compiles the code for <span class="application">FindBugs</span>. It is the default target.
+ </p></dd><dt><span class="term"><span><strong class="command">docs</strong></span></span></dt><dd><p>
+ This target formats the documentation. (It also compiles some of
+ the source code as a side-effect.)
+ </p></dd><dt><span class="term"><span><strong class="command">runjunit</strong></span></span></dt><dd><p>
+ This target compiles and runs the internal JUnit tests included
+ in <span class="application">FindBugs</span>. It will print an error message if any unit
+ tests fail.
+ </p></dd><dt><span class="term"><span><strong class="command">bindist</strong></span></span></dt><dd><p>
+ Builds a binary distribution of <span class="application">FindBugs</span>.
+ The target creates both <code class="filename">.zip</code> and
+ <code class="filename">.tar.gz</code> archives.
+ </p></dd></dl></div><p>
+</p><p>
+After running an <span class="application">Ant</span> command, you should see output similar to
+the following (after some other messages regarding the tasks that
+<span class="application">Ant</span> is running):
+</p><pre class="screen">
+<code class="computeroutput">
+BUILD SUCCESSFUL
+Total time: 17 seconds
+</code>
+</pre><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e845"></a>5. Running <span class="application">FindBugs</span>™</h2></div></div></div><p>
+The <span class="application">Ant</span> build script for <span class="application">FindBugs</span> is set up such that after
+building the <span><strong class="command">build</strong></span> target, the working directory
+is set up just like a binary distribution. So, the information about
+installing a binary distribution of <span class="application">FindBugs</span> in <a href="installing.html" title="Chapter 2. Installing and Running FindBugs™">Chapter 2, <i>Installing and Running <span class="application">FindBugs</span>™</i></a>
+applies to source distributions, too.
+</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="installing.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="gui.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Installing and Running <span class="application">FindBugs</span>™ </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Using the <span class="application">FindBugs</span>™ Graphical User Interface</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 11. Using rejarForAnalysis</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="annotations.html" title="Chapter 10. Annotations"><link rel="next" href="datamining.html" title="Chapter 12. Data mining of bugs with FindBugs™"></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">Chapter 11. Using rejarForAnalysis</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="annotations.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="datamining.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e2298"></a>Chapter 11. Using rejarForAnalysis</h2></div></div></div><p>
+If your project consists of many jarfiles or the jarfiles are scattered
+over many directories, you may wish to use the <span><strong class="command">rejarForAnalysis
+</strong></span> script to make
+FindBugs invocation easier. The script collects many jarfiles and combines them
+into a single, large jarfile that can then be easily passed to FindBugs for
+analysis. This can be particularly useful in combination with the 'find' command
+on unix systems; e.g. <span><strong class="command">find . -name '*.jar' | xargs rejarForAnalysis
+</strong></span>.
+</p><p>
+The <span><strong class="command">rejarForAnalysis</strong></span> script
+can also be used to split a very large project up into a set of jarfiles with
+the project classfiles evenly divided between them. This is useful when running
+FindBugs on the entire project is not practical due to time or memory consumption.
+Instead of running FindBugs on the entire project, you may use <span><strong class="command">
+rejarForAnalysis</strong></span> build one large, all-inclusive jarfile
+containing all classes, invoke <span><strong class="command">rejarForAnalysis</strong></span>
+again to split the project into multiple jarfiles, then run FindBugs
+on each divided jarfiles in turn, specifying the the all-inclusive jarfile in
+the <span><strong class="command">-auxclasspath</strong></span>.
+</p><p>
+These are the options accepted by the <span><strong class="command">rejarForAnalysis</strong></span> script:
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">-maxAge</strong></span> <em class="replaceable"><code>days</code></em></span></dt><dd><p>
+ Maximum age in days (ignore jar files older than this).
+ </p></dd><dt><span class="term"><span><strong class="command">-inputFileList</strong></span> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>
+ Text file containing names of jar files.
+ </p></dd><dt><span class="term"><span><strong class="command">-maxClasses</strong></span> <em class="replaceable"><code>num</code></em></span></dt><dd><p>
+ Maximum number of classes per analysis*.jar file.
+ </p></dd><dt><span class="term"><span><strong class="command">-prefix</strong></span> <em class="replaceable"><code>class name prefix</code></em></span></dt><dd><p>
+ Prefix of class names that should be analyzed (e.g., edu.umd.cs.).
+ </p></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="annotations.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="datamining.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 10. Annotations </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 12. Data mining of bugs with <span class="application">FindBugs</span>™</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 12. Data mining of bugs with FindBugs™</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="ch11.html" title="Chapter 11. Using rejarForAnalysis"><link rel="next" href="license.html" title="Chapter 13. License"></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">Chapter 12. Data mining of bugs with <span class="application">FindBugs</span>™</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="license.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="datamining"></a>Chapter 12. Data mining of bugs with <span class="application">FindBugs</span>™</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><p>
+FindBugs incorporates an ability to perform sophisticated queries on bug
+databases and track warnings across multiple versions of code being
+studied, allowing you to do things such as seeing when a bug was first introduced, examining
+just the warnings that have been introduced since the last release, or graphing the number
+of infinite recursive loops in your code over time.</p><p>
+These techniques all depend upon the XML format used by FindBugs for storing warnings.
+These XML files usually contain just the warnings from one particular analysis run, but
+they can also store the results from analyzing a sequence of software builds or versions.
+ </p><p>
+Any FindBugs XML bug database contains a version name and timestamp.
+FindBugs tries to compute a timestamp from the timestamps of the files that
+are analyzed (e.g., the timestamp is intended to be the time the class files
+were generated, not analyzed). Each bug database also contains a version name.
+Both the version name and timestamp can be set manually using the
+<span><strong class="command">setBugDatabaseInfo</strong></span> (<a href="datamining.html#setBugDatabaseInfo" title="1.7. setBugDatabaseInfo">Section 1.7, “setBugDatabaseInfo”</a>) command.
+ </p><p>A multiversion bug database assigns a sequence number to each version of
+the analyzed code. These sequence numbers are simply successive integers,
+starting at 0 (e.g., a bug database for 4 versions of the code will contain
+versions 0..3). The bug database will also record the name and timestamp for
+each version. The <span><strong class="command">filterBugs</strong></span> command allows you to refer
+to a version by sequence number, name or timestamp.</p><p>
+You can take a sequence (or pair) of single version bug databases and create
+from them a multiversion bug database, or combine a multiversion bug database
+with a sequence of later single-version bug databases.</p><p>
+Some of these commands can be invoked as ant tasks. See below for specifics
+on how to invoke them and what attributes and arguments they take. All of
+the examples assume that the <code class="literal">findbugs.lib</code>
+<code class="literal">refid</code> is set correctly. Here is one way to set it:
+</p><pre class="programlisting">
+
+ <!-- findbugs task definition -->
+ <property name="findbugs.home" value="/your/path/to/findbugs" />
+ <path id="findbugs.lib">
+ <fileset dir="${findbugs.home}/lib">
+ <include name="findbugs-ant.jar"/>
+ </fileset>
+ </path>
+
+</pre><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="commands"></a>1. Commands</h2></div></div></div><p>
+All tools for FindBugs data mining are can be invoked from the command line,
+and some of the more useful tools can also be invoked from an
+ant build file.</p><p>
+Briefly, the command-line tools are:</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command"><a href="datamining.html#unionBugs" title="1.1. unionBugs">unionBugs</a></strong></span></span></dt><dd><p>
+ combine the results from separate analysis of disjoint
+ classes
+ </p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#computeBugHistory" title="1.2. computeBugHistory">computeBugHistory</a></strong></span></span></dt><dd><p>Merge bug warnings from multiple versions of
+ analyzed code into
+ a single multiversion bug database. This can either be used
+ to add more versions to an existing multiversion database,
+ or to create a multiversion database from a sequence of single version
+ bug warning databases.</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#setBugDatabaseInfo" title="1.7. setBugDatabaseInfo">setBugDatabaseInfo</a></strong></span></span></dt><dd><p>Set information such as the revision name or
+timestamp in an XML bug database</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#listBugDatabaseInfo" title="1.8. listBugDatabaseInfo">listBugDatabaseInfo</a></strong></span></span></dt><dd><p>List information such as the revision name and
+timestamp for a list of XML bug databases</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#filterBugs" title="1.3. filterBugs">filterBugs</a></strong></span></span></dt><dd><p>Select a subset of a bug database</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#mineBugHistory" title="1.4. mineBugHistory">mineBugHistory</a></strong></span></span></dt><dd><p>Generate a tabular listing of the number of warnings in each
+ version of a multiversion bug database</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#defectDensity" title="1.5. defectDensity">defectDensity</a></strong></span></span></dt><dd><p>List information about defect density
+ (warnings per 1000 NCSS)
+ for the entire project and each class and package</p></dd><dt><span class="term"><span><strong class="command"><a href="datamining.html#convertXmlToText" title="1.6. convertXmlToText">convertXmlToText</a></strong></span></span></dt><dd><p>Convert bug warnings in XML format to
+ a textual one-line-per-bug format, or to HTML</p></dd></dl></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="unionBugs"></a>1.1. unionBugs</h3></div></div></div><p>
+ If you have, for example, separately analyzing each jar file used in an application,
+ you can use this command to combine the separately generated xml bug warning files into
+ a single file containing all of the warnings.</p><p>Do <span class="emphasis"><em>not</em></span> use this command to combine results from analyzing different versions of the same
+ file; use <span><strong class="command">computeBugHistory</strong></span> instead.</p><p>Specify the xml files on the command line. The result is sent to standard output.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="computeBugHistory"></a>1.2. computeBugHistory</h3></div></div></div><p>Use this command to generate a bug database containing information from different builds or versions
+of software you are analyzing.
+History is taken from the first file provided as input; any following
+files should be single version bug databases (if they contain history, the history in those
+files will be ignored).</p><p>By default, output is written to the standard output.
+</p><p>This functionality may also can be accessed from ant.
+First create a taskdef for <span><strong class="command">computeBugHistory</strong></span> in your
+build file:
+</p><pre class="programlisting">
+
+<taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+
+</pre><p>Attributes for this ant task are listed in the following table.
+To specify input files, nest them inside with a
+<code class="literal"><datafile></code> element. For example:
+</p><pre class="programlisting">
+
+<computeBugHistory home="${findbugs.home}" ...>
+ <datafile name="analyze1.xml"/>
+ <datafile name="analyze2.xml"/>
+</computeBugHistory>
+
+</pre><div class="table"><a name="computeBugHistoryTable"></a><p class="title"><b>Table 12.1. Options for computeBugHistory command</b></p><div class="table-contents"><table summary="Options for computeBugHistory command" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Command-line option</th><th align="left">Ant attribute</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left">-output <file></td><td align="left">output="<file>"</td><td align="left">save output in the named file (may also be an input file)</td></tr><tr><td align="left">-overrideRevisionNames[:truth]</td><td align="left">overrideRevisionNames="[true|false]"</td><td align="left">override revision names for each version with names computed from the filenames</td></tr><tr><td align="left">-noPackageMoves[:truth]</td><td align="left">noPackageMoves="[true|false]"</td><td align="left">if a class has moved to another package, treat warnings in that class as seperate</td></tr><tr><td align="left">-preciseMatch[:truth]</td><td align="left">preciseMatch="[true|false]"</td><td align="left">require bug patterns to match precisely</td></tr><tr><td align="left">-precisePriorityMatch[:truth]</td><td align="left">precisePriorityMatch="[true|false]"</td><td align="left">consider two warnings as the same only if priorities match exactly</td></tr><tr><td align="left">-quiet[:truth]</td><td align="left">quiet="[true|false]"</td><td align="left">don't generate any output to standard out unless there is an error</td></tr><tr><td align="left">-withMessages[:truth]</td><td align="left">withMessages="[true|false]"</td><td align="left">include human-readable messages describing the warnings in XML output</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="filterBugs"></a>1.3. filterBugs</h3></div></div></div><p>This command is used to select a subset of warnings from a FindBugs XML warning file
+and write the selected subset to a new FindBugs warning file.</p><p>
+This command takes a sequence of options, and either zero, one or two
+filenames of findbugs xml bug files on the command line.</p><p>If no file names are provided, the command reads from standard input
+and writes to standard output. If one file name is provided,
+it reads from the file and writes to standard output.
+If two file names are provided, it reads from the first and writes the output
+to the second file name.</p><p>This functionality may also can be accessed from ant.
+First create a taskdef for <span><strong class="command">filterBugs</strong></span> in your
+build file:
+</p><pre class="programlisting">
+
+<taskdef name="filterBugs" classname="edu.umd.cs.findbugs.anttask.FilterBugsTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+
+</pre><p>Attributes for this ant task are listed in the following table.
+To specify an input file either use the input attribute or nest it inside
+the ant call with a <code class="literal"><datafile></code> element. For example:
+</p><pre class="programlisting">
+
+<filterBugs home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</filterBugs>
+
+</pre><div class="table"><a name="filterOptionsTable"></a><p class="title"><b>Table 12.2. Options for filterBugs command</b></p><div class="table-contents"><table summary="Options for filterBugs command" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Command-line option</th><th align="left">Ant attribute</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left"> </td><td align="left">input="<file>"</td><td align="left">use file as input</td></tr><tr><td align="left"> </td><td align="left">output="<file>"</td><td align="left">output results to file</td></tr><tr><td align="left">-not</td><td align="left">not="[true|false]"</td><td align="left">reverse (all) switches for the filter</td></tr><tr><td align="left">-withSource[:truth]</td><td align="left">withSource="[true|false]"</td><td align="left">only warnings for switch source is available</td></tr><tr><td align="left">-exclude <filter file></td><td align="left">exclude="<filter file>"</td><td align="left">exclude bugs matching given filter</td></tr><tr><td align="left">-include <filter file></td><td align="left">include="<filter file>"</td><td align="left">include only bugs matching given filter</td></tr><tr><td align="left">-annotation <text></td><td align="left">annotation="<text>"</td><td align="left">allow only warnings containing this text in a manual annotation</td></tr><tr><td align="left">-after <when></td><td align="left">after="<when>"</td><td align="left">allow only warnings that first occurred after this version</td></tr><tr><td align="left">-before <when></td><td align="left">before="<when>"</td><td align="left">allow only warnings that first occurred before this version</td></tr><tr><td align="left">-first <when></td><td align="left">first="<when>"</td><td align="left">allow only warnings that first occurred in this version</td></tr><tr><td align="left">-last <when></td><td align="left">last="<when>"</td><td align="left">allow only warnings that last occurred in this version</td></tr><tr><td align="left">-fixed <when></td><td align="left">fixed="<when>"</td><td align="left">allow only warnings that last occurred in the previous version (clobbers <code class="option">-last</code>)</td></tr><tr><td align="left">-present <when></td><td align="left">present="<when>"</td><td align="left">allow only warnings present in this version</td></tr><tr><td align="left">-absent <when></td><td align="left">absent="<when>"</td><td align="left">allow only warnings absent in this version</td></tr><tr><td align="left">-active[:truth]</td><td align="left">active="[true|false]"</td><td align="left">allow only warnings alive in the last sequence number</td></tr><tr><td align="left">-introducedByChange[:truth]</td><td align="left">introducedByChange="[true|false]"</td><td align="left">allow only warnings introduced by a change of an existing class</td></tr><tr><td align="left">-removedByChange[:truth]</td><td align="left">removedByChange="[true|false]"</td><td align="left">allow only warnings removed by a change of a persisting class</td></tr><tr><td align="left">-newCode[:truth]</td><td align="left">newCode="[true|false]"</td><td align="left">allow only warnings introduced by the addition of a new class</td></tr><tr><td align="left">-removedCode[:truth]</td><td align="left">removedCode="[true|false]"</td><td align="left">allow only warnings removed by removal of a class</td></tr><tr><td align="left">-priority <level></td><td align="left">priority="<level>"</td><td align="left">allow only warnings with this priority or higher</td></tr><tr><td align="left">-class <pattern></td><td align="left">class="<class>"</td><td align="left">allow only bugs whose primary class name matches this pattern</td></tr><tr><td align="left">-bugPattern <pattern></td><td align="left">bugPattern="<pattern>"</td><td align="left">allow only bugs whose type matches this pattern</td></tr><tr><td align="left">-category <category></td><td align="left">category="<category>"</td><td align="left">allow only warnings with a category that starts with this string</td></tr><tr><td align="left">-designation <designation></td><td align="left">designation="<designation>"</td><td align="left">allow only warnings with this designation (e.g., -designation SHOULD_FIX)</td></tr><tr><td align="left">-withMessages[:truth] </td><td align="left">withMessages="[true|false]"</td><td align="left">the generated XML should contain textual messages</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="mineBugHistory"></a>1.4. mineBugHistory</h3></div></div></div><p>This command generates a table containing counts of the numbers of warnings
+in each version of a multiversion bug database.</p><p>This functionality may also can be accessed from ant.
+First create a taskdef for <span><strong class="command">mineBugHistory</strong></span> in your
+build file:
+</p><pre class="programlisting">
+
+<taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+
+</pre><p>Attributes for this ant task are listed in the following table.
+To specify an input file either use the <code class="literal">input</code>
+attribute or nest it inside the ant call with a
+<code class="literal"><datafile></code> element. For example:
+</p><pre class="programlisting">
+
+<mineBugHistory home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</mineBugHistory>
+
+</pre><div class="table"><a name="mineBugHistoryOptionsTable"></a><p class="title"><b>Table 12.3. Options for mineBugHistory command</b></p><div class="table-contents"><table summary="Options for mineBugHistory command" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Command-line option</th><th align="left">Ant attribute</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left"> </td><td align="left">input="<file>"</td><td align="left">use file as input</td></tr><tr><td align="left"> </td><td align="left">output="<file>"</td><td align="left">write output to file</td></tr><tr><td align="left">-formatDates</td><td align="left">formatDates="[true|false]"</td><td align="left">render dates in textual form</td></tr><tr><td align="left">-noTabs</td><td align="left">noTabs="[true|false]"</td><td align="left">delimit columns with groups of spaces instead of tabs (see below)</td></tr><tr><td align="left">-summary</td><td align="left">summary="[true|false]"</td><td align="left">output terse summary of changes over the last ten entries</td></tr></tbody></table></div></div><br class="table-break"><p>
+ The <code class="option">-noTabs</code> output can be easier to read from a shell
+ with a fixed-width font.
+ Because numeric columns are right-justified, spaces may precede the
+ first column value. This option also causes <code class="option">-formatDates</code>
+ to render dates in terser format without embedded whitespace.
+ </p><p>The table is a tab-separated (barring <code class="option">-noTabs</code>)
+ table with the following columns:</p><div class="table"><a name="mineBugHistoryColumns"></a><p class="title"><b>Table 12.4. Columns in mineBugHistory output</b></p><div class="table-contents"><table summary="Columns in mineBugHistory output" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Title</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left">seq</td><td align="left">Sequence number (successive integers, starting at 0)</td></tr><tr><td align="left">version</td><td align="left">Version name</td></tr><tr><td align="left">time</td><td align="left">Release timestamp</td></tr><tr><td align="left">classes</td><td align="left">Number of classes analyzed</td></tr><tr><td align="left">NCSS</td><td align="left">Non Commenting Source Statements</td></tr><tr><td align="left">added</td><td align="left">Count of new warnings for a class that existed in the previous version</td></tr><tr><td align="left">newCode</td><td align="left">Count of new warnings for a class that did not exist in the previous version</td></tr><tr><td align="left">fixed</td><td align="left">Count of warnings removed from a class that remains in the current version</td></tr><tr><td align="left">removed</td><td align="left">Count of warnings in the previous version for a class that is not present in the current version</td></tr><tr><td align="left">retained</td><td align="left">Count of warnings that were in both the previous and current version</td></tr><tr><td align="left">dead</td><td align="left">Warnings that were present in earlier versions but in neither the current version or the immediately preceeding version</td></tr><tr><td align="left">active</td><td align="left">Total warnings present in the current version</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="defectDensity"></a>1.5. defectDensity</h3></div></div></div><p>
+This command lists information about defect density (warnings per 1000 NCSS) for the entire project and each class and package.
+In can either be invoked with no files specified on the command line (in which case it reads from standard input)
+or with one file specified on the command line.</p><p>It generates a table with the following columns, and with one
+row for the entire project, and one row for each package or class that contains at least
+4 warnings.</p><div class="table"><a name="defectDensityColumns"></a><p class="title"><b>Table 12.5. Columns in defectDensity output</b></p><div class="table-contents"><table summary="Columns in defectDensity output" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Title</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left">kind</td><td align="left">project, package or class</td></tr><tr><td align="left">name</td><td align="left">The name of the project, package or class</td></tr><tr><td align="left">density</td><td align="left">Number of warnings generated per 1000 lines of NCSS.</td></tr><tr><td align="left">bugs</td><td align="left">Number of warnings</td></tr><tr><td align="left">NCSS</td><td align="left">Calculated number of NCSS</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="convertXmlToText"></a>1.6. convertXmlToText</h3></div></div></div><p>
+ This command converts a warning collection in XML format to a text
+ format with one line per warning, or to HTML.
+ </p><p>This functionality may also can be accessed from ant.
+First create a taskdef for <span><strong class="command">convertXmlToText</strong></span> in your
+build file:
+</p><pre class="programlisting">
+
+<taskdef name="convertXmlToText" classname="edu.umd.cs.findbugs.anttask.ConvertXmlToTextTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+
+</pre><p>Attributes for this ant task are listed in the following table.</p><div class="table"><a name="convertXmlToTextTable"></a><p class="title"><b>Table 12.6. Options for convertXmlToText command</b></p><div class="table-contents"><table summary="Options for convertXmlToText command" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Command-line option</th><th align="left">Ant attribute</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left"> </td><td align="left">input="<filename>"</td><td align="left">use file as input</td></tr><tr><td align="left"> </td><td align="left">output="<filename>"</td><td align="left">output results to file</td></tr><tr><td align="left">-longBugCodes</td><td align="left">longBugCodes="[true|false]"</td><td align="left">use the full bug pattern code instead of two-letter abbreviation</td></tr><tr><td align="left">-html[:stylesheet]</td><td align="left">format="html:<stylesheet>"</td><td align="left">generate output with specified stylesheet (see below), or default.xsl if unspecified</td></tr></tbody></table></div></div><br class="table-break"><p>
+ You may specify plain.xsl, default.xsl, fancy.xsl, fancy-hist.xsl,
+ or your own XSL stylesheet for the -html/format option.
+ Despite the name of this option, you may specify
+ a stylesheet that emits something other than html.
+ </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="setBugDatabaseInfo"></a>1.7. setBugDatabaseInfo</h3></div></div></div><p>
+ This command sets meta-information in a specified warning collection.
+ It takes the following options:
+ </p><p>This functionality may also can be accessed from ant.
+First create a taskdef for <span><strong class="command">setBugDatabaseInfo</strong></span> in your
+build file:
+</p><pre class="programlisting">
+
+<taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
+ <classpath refid="findbugs.lib" />
+</taskdef>
+
+</pre><p>Attributes for this ant task are listed in the following table.
+To specify an input file either use the <code class="literal">input</code>
+attribute or nest it inside the ant call with a
+<code class="literal"><datafile></code> element. For example:
+</p><pre class="programlisting">
+
+<setBugDatabaseInfo home="${findbugs.home}" ...>
+ <datafile name="analyze.xml"/>
+</setBugDatabaseInfo>
+
+</pre><div class="table"><a name="setBugDatabaseInfoOptions"></a><p class="title"><b>Table 12.7. setBugDatabaseInfo Options</b></p><div class="table-contents"><table summary="setBugDatabaseInfo Options" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Command-line option</th><th align="left">Ant attribute</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left"> </td><td align="left">input="<file>"</td><td align="left">use file as input</td></tr><tr><td align="left"> </td><td align="left">output="<file>"</td><td align="left">write output to file</td></tr><tr><td align="left">-name <name></td><td align="left">name="<name>"</td><td align="left">set name for (last) revision</td></tr><tr><td align="left">-timestamp <when></td><td align="left">timestamp="<when>"</td><td align="left">set timestamp for (last) revision</td></tr><tr><td align="left">-source <directory></td><td align="left">source="<directory>"</td><td align="left">add specified directory to the source search path</td></tr><tr><td align="left">-findSource <directory></td><td align="left">findSource="<directory>"</td><td align="left">find and add all relevant source directions contained within specified directory</td></tr><tr><td align="left">-suppress <filter file></td><td align="left">suppress="<filter file>"</td><td align="left">suppress warnings matched by this file (replaces previous suppressions)</td></tr><tr><td align="left">-withMessages</td><td align="left">withMessages="[true|false]"</td><td align="left">add textual messages to XML</td></tr><tr><td align="left">-resetSource</td><td align="left">resetSource="[true|false]"</td><td align="left">remove all source search paths</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="listBugDatabaseInfo"></a>1.8. listBugDatabaseInfo</h3></div></div></div><p>This command takes a list of zero or more xml bug database filenames on the command line.
+If zero file names are provided, it reads from standard input and does not generate
+a table header.</p><p>There is only one option: <code class="option">-formatDates</code> renders dates
+ in textual form.
+ </p><p>The output is a table one row per bug database and the following columns:</p><div class="table"><a name="listBugDatabaseInfoColumns"></a><p class="title"><b>Table 12.8. listBugDatabaseInfo Columns</b></p><div class="table-contents"><table summary="listBugDatabaseInfo Columns" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Column</th><th align="left">Meaning</th></tr></thead><tbody><tr><td align="left">version</td><td align="left">version name</td></tr><tr><td align="left">time</td><td align="left">Release timestamp</td></tr><tr><td align="left">classes</td><td align="left">Number of classes analyzed</td></tr><tr><td align="left">NCSS</td><td align="left">Non Commenting Source Statements analyzed</td></tr><tr><td align="left">total</td><td align="left">Total number of warnings of all kinds</td></tr><tr><td align="left">high</td><td align="left">Total number of high priority warnings of all kinds</td></tr><tr><td align="left">medium</td><td align="left">Total number of medium/normal priority warnings of all kinds</td></tr><tr><td align="left">low</td><td align="left">Total number of low priority warnings of all kinds</td></tr><tr><td align="left">filename</td><td align="left">filename of database</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="examples"></a>2. Examples</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="unixscriptsexemples"></a>2.1. Mining history using proveded shell scrips</h3></div></div></div><p>In all of the following, the commands are given in a directory that contains
+directories jdk1.6.0-b12, jdk1.6.0-b13, ..., jdk1.6.0-b60.</p><p>You can use the command:</p><pre class="screen">
+computeBugHistory jdk1.6.0-b* | filterBugs -bugPattern IL_ | mineBugHistory -formatDates
+</pre><p>to generate the following output:</p><pre class="screen">
+seq version time classes NCSS added newCode fixed removed retained dead active
+0 jdk1.6.0-b12 "Thu Nov 11 09:07:20 EST 2004" 13128 811569 0 4 0 0 0 0 4
+1 jdk1.6.0-b13 "Thu Nov 18 06:02:06 EST 2004" 13128 811570 0 0 0 0 4 0 4
+2 jdk1.6.0-b14 "Thu Dec 02 06:12:26 EST 2004" 13145 811786 0 0 2 0 2 0 2
+3 jdk1.6.0-b15 "Thu Dec 09 06:07:04 EST 2004" 13174 811693 0 0 1 0 1 2 1
+4 jdk1.6.0-b16 "Thu Dec 16 06:21:28 EST 2004" 13175 811715 0 0 0 0 1 3 1
+5 jdk1.6.0-b17 "Thu Dec 23 06:27:22 EST 2004" 13176 811974 0 0 0 0 1 3 1
+6 jdk1.6.0-b19 "Thu Jan 13 06:41:16 EST 2005" 13176 812011 0 0 0 0 1 3 1
+7 jdk1.6.0-b21 "Thu Jan 27 05:57:52 EST 2005" 13177 812173 0 0 0 0 1 3 1
+8 jdk1.6.0-b23 "Thu Feb 10 05:44:36 EST 2005" 13179 812188 0 0 0 0 1 3 1
+9 jdk1.6.0-b26 "Thu Mar 03 06:04:02 EST 2005" 13199 811770 0 0 0 0 1 3 1
+10 jdk1.6.0-b27 "Thu Mar 10 04:48:38 EST 2005" 13189 812440 0 0 0 0 1 3 1
+11 jdk1.6.0-b28 "Thu Mar 17 02:54:22 EST 2005" 13185 812056 0 0 0 0 1 3 1
+12 jdk1.6.0-b29 "Thu Mar 24 03:09:20 EST 2005" 13117 809468 0 0 0 0 1 3 1
+13 jdk1.6.0-b30 "Thu Mar 31 02:53:32 EST 2005" 13118 809501 0 0 0 0 1 3 1
+14 jdk1.6.0-b31 "Thu Apr 07 03:00:14 EDT 2005" 13117 809572 0 0 0 0 1 3 1
+15 jdk1.6.0-b32 "Thu Apr 14 02:56:56 EDT 2005" 13169 811096 0 0 0 0 1 3 1
+16 jdk1.6.0-b33 "Thu Apr 21 02:46:22 EDT 2005" 13187 811942 0 0 0 0 1 3 1
+17 jdk1.6.0-b34 "Thu Apr 28 02:49:00 EDT 2005" 13195 813488 0 1 0 0 1 3 2
+18 jdk1.6.0-b35 "Thu May 05 02:49:04 EDT 2005" 13457 829837 0 0 0 0 2 3 2
+19 jdk1.6.0-b36 "Thu May 12 02:59:46 EDT 2005" 13462 831278 0 0 0 0 2 3 2
+20 jdk1.6.0-b37 "Thu May 19 02:55:08 EDT 2005" 13464 831971 0 0 0 0 2 3 2
+21 jdk1.6.0-b38 "Thu May 26 03:08:16 EDT 2005" 13564 836565 0 0 0 0 2 3 2
+22 jdk1.6.0-b39 "Fri Jun 03 03:10:48 EDT 2005" 13856 849992 0 1 0 0 2 3 3
+23 jdk1.6.0-b40 "Thu Jun 09 03:30:28 EDT 2005" 15972 959619 0 2 0 0 3 3 5
+24 jdk1.6.0-b41 "Thu Jun 16 03:19:22 EDT 2005" 15972 959619 0 0 0 0 5 3 5
+25 jdk1.6.0-b42 "Fri Jun 24 03:38:54 EDT 2005" 15966 958581 0 0 0 0 5 3 5
+26 jdk1.6.0-b43 "Thu Jul 14 03:09:34 EDT 2005" 16041 960544 0 0 0 0 5 3 5
+27 jdk1.6.0-b44 "Thu Jul 21 03:05:54 EDT 2005" 16041 960547 0 0 0 0 5 3 5
+28 jdk1.6.0-b45 "Thu Jul 28 03:26:10 EDT 2005" 16037 960606 0 0 1 0 4 3 4
+29 jdk1.6.0-b46 "Thu Aug 04 03:02:48 EDT 2005" 15936 951355 0 0 0 0 4 4 4
+30 jdk1.6.0-b47 "Thu Aug 11 03:18:56 EDT 2005" 15964 952387 0 0 1 0 3 4 3
+31 jdk1.6.0-b48 "Thu Aug 18 08:10:40 EDT 2005" 15970 953421 0 0 0 0 3 5 3
+32 jdk1.6.0-b49 "Thu Aug 25 03:24:38 EDT 2005" 16048 958940 0 0 0 0 3 5 3
+33 jdk1.6.0-b50 "Thu Sep 01 01:52:40 EDT 2005" 16287 974937 1 0 0 0 3 5 4
+34 jdk1.6.0-b51 "Thu Sep 08 01:55:36 EDT 2005" 16362 979377 0 0 0 0 4 5 4
+35 jdk1.6.0-b52 "Thu Sep 15 02:04:08 EDT 2005" 16477 979399 0 0 0 0 4 5 4
+36 jdk1.6.0-b53 "Thu Sep 22 02:00:28 EDT 2005" 16019 957900 0 0 1 0 3 5 3
+37 jdk1.6.0-b54 "Thu Sep 29 01:54:34 EDT 2005" 16019 957900 0 0 0 0 3 6 3
+38 jdk1.6.0-b55 "Thu Oct 06 01:54:14 EDT 2005" 16051 959014 0 0 0 0 3 6 3
+39 jdk1.6.0-b56 "Thu Oct 13 01:54:12 EDT 2005" 16211 970835 0 0 0 0 3 6 3
+40 jdk1.6.0-b57 "Thu Oct 20 01:55:26 EDT 2005" 16279 971627 0 0 0 0 3 6 3
+41 jdk1.6.0-b58 "Thu Oct 27 01:56:30 EDT 2005" 16283 971945 0 0 0 0 3 6 3
+42 jdk1.6.0-b59 "Thu Nov 03 01:56:58 EST 2005" 16232 972193 0 0 0 0 3 6 3
+43 jdk1.6.0-b60 "Thu Nov 10 01:54:18 EST 2005" 16235 972346 0 0 0 0 3 6 3
+</pre><p>
+We could also generate that information directly, without creating an intermediate db.xml file, using the command
+</p><pre class="screen">
+computeBugHistory jdk1.6.0-b*/jre/lib/rt.xml | filterBugs -bugPattern IL_ db.xml | mineBugHistory -formatDates
+</pre><p>We can then use that information to display a graph showing the number of infinite recursive loops
+found by FindBugs in each build of Sun's JDK1.6.0. The blue area indicates the number of infinite
+recursive loops in that build, the red area above it indicates the number of infinite recursive loops that existed
+in some previous version but not in the current version (thus, the combined height of the red and blue areas
+is guaranteed to never decrease, and goes up whenever a new infinite recursive loop bug is introduced). The height
+of the red area is computed as the sum of the fixed, removed and dead values for each version.
+The reductions in builds 13 and 14 came after Sun was notified about the bugs found by FindBugs in the JDK.
+ </p><div class="mediaobject"><img src="infiniteRecursiveLoops.png"></div><p>
+Given the db.xml file that contains the results for all the jdk1.6.0 builds, the following command will show the history of high and medium priority correctness warnings:
+</p><pre class="screen">
+filterBugs -priority M -category C db.xml | mineBugHistory -formatDates
+</pre><p>
+generating the table:
+</p><pre class="screen">
+seq version time classes NCSS added newCode fixed removed retained dead active
+0 jdk1.6.0-b12 "Thu Nov 11 09:07:20 EST 2004" 13128 811569 0 1075 0 0 0 0 1075
+1 jdk1.6.0-b13 "Thu Nov 18 06:02:06 EST 2004" 13128 811570 0 0 0 0 1075 0 1075
+2 jdk1.6.0-b14 "Thu Dec 02 06:12:26 EST 2004" 13145 811786 3 0 6 0 1069 0 1072
+3 jdk1.6.0-b15 "Thu Dec 09 06:07:04 EST 2004" 13174 811693 2 1 3 0 1069 6 1072
+4 jdk1.6.0-b16 "Thu Dec 16 06:21:28 EST 2004" 13175 811715 0 0 1 0 1071 9 1071
+5 jdk1.6.0-b17 "Thu Dec 23 06:27:22 EST 2004" 13176 811974 0 0 1 0 1070 10 1070
+6 jdk1.6.0-b19 "Thu Jan 13 06:41:16 EST 2005" 13176 812011 0 0 0 0 1070 11 1070
+7 jdk1.6.0-b21 "Thu Jan 27 05:57:52 EST 2005" 13177 812173 0 0 1 0 1069 11 1069
+8 jdk1.6.0-b23 "Thu Feb 10 05:44:36 EST 2005" 13179 812188 0 0 0 0 1069 12 1069
+9 jdk1.6.0-b26 "Thu Mar 03 06:04:02 EST 2005" 13199 811770 0 0 2 1 1066 12 1066
+10 jdk1.6.0-b27 "Thu Mar 10 04:48:38 EST 2005" 13189 812440 1 0 1 1 1064 15 1065
+11 jdk1.6.0-b28 "Thu Mar 17 02:54:22 EST 2005" 13185 812056 0 0 0 0 1065 17 1065
+12 jdk1.6.0-b29 "Thu Mar 24 03:09:20 EST 2005" 13117 809468 3 0 8 26 1031 17 1034
+13 jdk1.6.0-b30 "Thu Mar 31 02:53:32 EST 2005" 13118 809501 0 0 0 0 1034 51 1034
+14 jdk1.6.0-b31 "Thu Apr 07 03:00:14 EDT 2005" 13117 809572 0 0 0 0 1034 51 1034
+15 jdk1.6.0-b32 "Thu Apr 14 02:56:56 EDT 2005" 13169 811096 1 1 0 1 1033 51 1035
+16 jdk1.6.0-b33 "Thu Apr 21 02:46:22 EDT 2005" 13187 811942 3 0 2 1 1032 52 1035
+17 jdk1.6.0-b34 "Thu Apr 28 02:49:00 EDT 2005" 13195 813488 0 1 0 0 1035 55 1036
+18 jdk1.6.0-b35 "Thu May 05 02:49:04 EDT 2005" 13457 829837 0 36 2 0 1034 55 1070
+19 jdk1.6.0-b36 "Thu May 12 02:59:46 EDT 2005" 13462 831278 0 0 0 0 1070 57 1070
+20 jdk1.6.0-b37 "Thu May 19 02:55:08 EDT 2005" 13464 831971 0 1 1 0 1069 57 1070
+21 jdk1.6.0-b38 "Thu May 26 03:08:16 EDT 2005" 13564 836565 1 7 2 6 1062 58 1070
+22 jdk1.6.0-b39 "Fri Jun 03 03:10:48 EDT 2005" 13856 849992 6 39 5 0 1065 66 1110
+23 jdk1.6.0-b40 "Thu Jun 09 03:30:28 EDT 2005" 15972 959619 7 147 11 0 1099 71 1253
+24 jdk1.6.0-b41 "Thu Jun 16 03:19:22 EDT 2005" 15972 959619 0 0 0 0 1253 82 1253
+25 jdk1.6.0-b42 "Fri Jun 24 03:38:54 EDT 2005" 15966 958581 3 0 1 2 1250 82 1253
+26 jdk1.6.0-b43 "Thu Jul 14 03:09:34 EDT 2005" 16041 960544 5 11 15 8 1230 85 1246
+27 jdk1.6.0-b44 "Thu Jul 21 03:05:54 EDT 2005" 16041 960547 0 0 0 0 1246 108 1246
+28 jdk1.6.0-b45 "Thu Jul 28 03:26:10 EDT 2005" 16037 960606 19 0 2 0 1244 108 1263
+29 jdk1.6.0-b46 "Thu Aug 04 03:02:48 EDT 2005" 15936 951355 13 1 1 32 1230 110 1244
+30 jdk1.6.0-b47 "Thu Aug 11 03:18:56 EDT 2005" 15964 952387 163 8 7 20 1217 143 1388
+31 jdk1.6.0-b48 "Thu Aug 18 08:10:40 EDT 2005" 15970 953421 0 0 0 0 1388 170 1388
+32 jdk1.6.0-b49 "Thu Aug 25 03:24:38 EDT 2005" 16048 958940 1 11 1 0 1387 170 1399
+33 jdk1.6.0-b50 "Thu Sep 01 01:52:40 EDT 2005" 16287 974937 19 27 16 7 1376 171 1422
+34 jdk1.6.0-b51 "Thu Sep 08 01:55:36 EDT 2005" 16362 979377 1 15 3 0 1419 194 1435
+35 jdk1.6.0-b52 "Thu Sep 15 02:04:08 EDT 2005" 16477 979399 0 0 1 1 1433 197 1433
+36 jdk1.6.0-b53 "Thu Sep 22 02:00:28 EDT 2005" 16019 957900 13 12 16 20 1397 199 1422
+37 jdk1.6.0-b54 "Thu Sep 29 01:54:34 EDT 2005" 16019 957900 0 0 0 0 1422 235 1422
+38 jdk1.6.0-b55 "Thu Oct 06 01:54:14 EDT 2005" 16051 959014 1 4 7 0 1415 235 1420
+39 jdk1.6.0-b56 "Thu Oct 13 01:54:12 EDT 2005" 16211 970835 6 8 37 0 1383 242 1397
+40 jdk1.6.0-b57 "Thu Oct 20 01:55:26 EDT 2005" 16279 971627 0 0 0 0 1397 279 1397
+41 jdk1.6.0-b58 "Thu Oct 27 01:56:30 EDT 2005" 16283 971945 0 1 1 0 1396 279 1397
+42 jdk1.6.0-b59 "Thu Nov 03 01:56:58 EST 2005" 16232 972193 6 0 5 0 1392 280 1398
+43 jdk1.6.0-b60 "Thu Nov 10 01:54:18 EST 2005" 16235 972346 0 0 0 0 1398 285 1398
+44 jdk1.6.0-b61 "Thu Nov 17 01:58:42 EST 2005" 16202 971134 2 0 4 0 1394 285 1396
+</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="incrementalhistory"></a>2.2. Incremental history maintenance</h3></div></div></div><p>
+If db.xml contains the results of running findbugs over builds b12 - b60, we can update db.xml to include the results of analyzing b61 with the commands:
+</p><pre class="screen">
+computeBugHistory -output db.xml db.xml jdk1.6.0-b61/jre/lib/rt.xml
+</pre></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="antexemple"></a>3. Ant exemple</h2></div></div></div><p>
+Here is a complete ant script example for both running findbugs and running a chain of data-mining tools afterward:
+</p><pre class="screen">
+
+<project name="analyze_asm_util" default="findbugs">
+ <!-- findbugs task definition -->
+ <property name="findbugs.home" value="/Users/ben/Documents/workspace/findbugs/findbugs" />
+ <property name="jvmargs" value="-server -Xss1m -Xmx800m -Duser.language=en -Duser.region=EN -Dfindbugs.home=${findbugs.home}" />
+
+ <path id="findbugs.lib">
+ <fileset dir="${findbugs.home}/lib">
+ <include name="findbugs-ant.jar"/>
+ </fileset>
+ </path>
+
+ <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
+ <classpath refid="findbugs.lib" />
+ </taskdef>
+
+ <!-- findbugs task definition -->
+ <target name="findbugs">
+ <antcall target="analyze" />
+ <antcall target="mine" />
+ </target>
+
+ <!-- analyze task -->
+ <target name="analyze">
+ <!-- run findbugs against asm-util -->
+ <findbugs home="${findbugs.home}"
+ output="xml:withMessages"
+ timeout="90000000"
+ reportLevel="experimental"
+ workHard="true"
+ effort="max"
+ adjustExperimental="true"
+ jvmargs="${jvmargs}"
+ failOnError="true"
+ outputFile="out.xml"
+ projectName="Findbugs"
+ debug="false">
+ <class location="asm-util-3.0.jar" />
+ </findbugs>
+ </target>
+
+ <target name="mine">
+
+ <!-- Set info to the latest analysis -->
+ <setBugDatabaseInfo home="${findbugs.home}"
+ withMessages="true"
+ name="asm-util-3.0.jar"
+ input="out.xml"
+ output="out-rel.xml"/>
+
+ <!-- Checking if history file already exists (findbugs-hist.xml) -->
+ <condition property="mining.historyfile.available">
+ <available file="out-hist.xml"/>
+ </condition>
+ <condition property="mining.historyfile.notavailable">
+ <not>
+ <available file="out-hist.xml"/>
+ </not>
+ </condition>
+
+ <!-- this target is executed if the history file do not exist (first run) -->
+ <antcall target="history-init">
+ <param name="data.file" value="out-rel.xml" />
+ <param name="hist.file" value="out-hist.xml" />
+ </antcall>
+ <!-- else this one is executed -->
+ <antcall target="history">
+ <param name="data.file" value="out-rel.xml" />
+ <param name="hist.file" value="out-hist.xml" />
+ <param name="hist.summary.file" value="out-hist.txt" />
+ </antcall>
+ </target>
+
+ <!-- Initializing history file -->
+ <target name="history-init" if="mining.historyfile.notavailable">
+ <copy file="${data.file}" tofile="${hist.file}" />
+ </target>
+
+ <!-- Computing bug history -->
+ <target name="history" if="mining.historyfile.available">
+ <!-- Merging ${data.file} into ${hist.file} -->
+ <computeBugHistory home="${findbugs.home}"
+ withMessages="true"
+ output="${hist.file}">
+ <dataFile name="${hist.file}"/>
+ <dataFile name="${data.file}"/>
+ </computeBugHistory>
+
+ <!-- Compute history into ${hist.summary.file} -->
+ <mineBugHistory home="${findbugs.home}"
+ formatDates="true"
+ noTabs="true"
+ input="${hist.file}"
+ output="${hist.summary.file}"/>
+ </target>
+
+</project>
+
+</pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch11.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="license.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 11. Using rejarForAnalysis </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 13. License</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 7. Using the FindBugs™ Eclipse plugin</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="anttask.html" title="Chapter 6. Using the FindBugs™ Ant task"><link rel="next" href="filter.html" title="Chapter 8. Filter Files"></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">Chapter 7. Using the <span class="application">FindBugs</span>™ Eclipse plugin</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="anttask.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="filter.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="eclipse"></a>Chapter 7. Using the <span class="application">FindBugs</span>™ Eclipse plugin</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="eclipse.html#d0e1448">1. Requirements</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1456">2. Installation</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1503">3. Using the Plugin</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1526">4. Troubleshooting</a></span></dt></dl></div><p>
+The FindBugs Eclipse plugin allows <span class="application">FindBugs</span> to be used within
+the <a href="http://www.eclipse.org/" target="_top">Eclipse</a> IDE.
+The FindBugs Eclipse plugin was generously contributed by Peter Friese.
+Phil Crosby and Andrei Loskutov contributed major improvements
+to the plugin.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1448"></a>1. Requirements</h2></div></div></div><p>
+To use the <span class="application">FindBugs</span> Plugin for Eclipse, you need Eclipse 3.0.1 or later,
+and JRE/JDK 1.4.0 or later.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1456"></a>2. Installation</h2></div></div></div><p>
+ We provide update sites that allow you to automatically install FindBugs into Eclipse and also query and install updates.
+ There are three different update sites</p><div class="variablelist"><p class="title"><b>FindBugs Eclipse update sites</b></p><dl><dt><span class="term"><a href="http://findbugs.cs.umd.edu/eclipse/" target="_top">http://findbugs.cs.umd.edu/eclipse/</a></span></dt><dd><p>
+ Only provides official releases of FindBugs.
+ </p></dd><dt><span class="term"><a href="http://findbugs.cs.umd.edu/eclipse-candidate/" target="_top">http://findbugs.cs.umd.edu/eclips-candidate/</a></span></dt><dd><p>
+ Provides official releases and release candidates of FindBugs.
+ </p></dd><dt><span class="term"><a href="http://findbugs.cs.umd.edu/eclipse-daily/" target="_top">http://findbugs.cs.umd.edu/eclipse-daily/</a></span></dt><dd><p>
+ Provides the daily build of FindBugs. No testing other than that it compiles.
+ </p></dd></dl></div><p>You can also manually
+download the plugin from the following link:
+<a href="http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip?download" target="_top">http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108.zip?download</a>.
+Extract it in Eclipse's "plugins" subdirectory.
+(So <eclipse_install_dir>/plugins/edu.umd.cs.findbugs.plugin.eclipse_1.3.0.20071108/findbugs.png
+should be the path to the <span class="application">FindBugs</span> logo.)
+
+</p><p>
+Once the plugin is extracted, start Eclipse and choose
+<span class="guimenu">Help</span> → <span class="guimenuitem">About Eclipse Platform</span> → <span class="guimenuitem">Plug-in Details</span>.
+You should find a plugin called "FindBugs Plug-in" provided by "FindBugs Project".
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1503"></a>3. Using the Plugin</h2></div></div></div><p>
+To get started, right click on a Java project,
+and select the option labeled "Find Bugs".
+<span class="application">FindBugs</span> will run, and problem markers (displayed in source
+windows, and also in the Eclipse Problems view) will point to
+locations in your code which have been identified as potential instances
+of bug patterns.
+</p><p>
+You may customize how <span class="application">FindBugs</span> runs by opening the Properties
+dialog for a Java project, and choosing the "Findbugs" property page.
+Options you may choose include:
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+ Enable or disable the "Run FindBugs Automatically" checkbox.
+ When enabled, FindBugs will run every time you modify a Java class
+ within the project.
+ </p></li><li><p>
+ Choose minimum warning priority and enabled bug categories.
+ These options will choose which warnings are shown.
+ For example, if you select the "Medium" warning priority,
+ only Medium and High priority warnings will be shown.
+ Similarly, if you uncheck the "Style" checkbox, no warnings
+ in the Style category will be displayed.
+ </p></li><li><p>
+ Select detectors. The table allows you to select which detectors
+ you want to enable for your project.
+ </p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1526"></a>4. Troubleshooting</h2></div></div></div><p>
+The <span class="application">FindBugs</span> Eclipse plugin is still experimental. This section
+lists common problems with the plugin and (if known) how to resolve them.
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+ If you do not see any <span class="application">FindBugs</span> problem markers (in your source
+ windows or in the Problems View), you may need to change your
+ Problems View filter settings. See
+ <a href="http://findbugs.sourceforge.net/FAQ.html#q7" target="_top">http://findbugs.sourceforge.net/FAQ.html#q7</a> for more information.
+ </p></li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="anttask.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="filter.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. Filter Files</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 8. Filter Files</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"><link rel="next" href="analysisprops.html" title="Chapter 9. Analysis Properties"></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">Chapter 8. Filter Files</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="eclipse.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="analysisprops.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="filter"></a>Chapter 8. Filter Files</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="filter.html#d0e1556">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1606">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1799">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1824">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1854">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1907">6. Complete Example</a></span></dt></dl></div><p>
+Filter files may be used to include or exclude bug reports for particular classes
+and methods. This chapter explains how to use filter files.
+
+</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Planned Features"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="note.png"></td><th align="left">Planned Features</th></tr><tr><td align="left" valign="top"><p>
+ Filters are currently only supported by the Command Line interface.
+ Eventually, filter support will be added to the GUI.
+</p></td></tr></table></div><p>
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1556"></a>1. Introduction to Filter Files</h2></div></div></div><p>
+Conceptually, a filter matches bug instances against a set of criteria.
+By defining a filter, you can select bug instances for special treatment;
+for example, to exclude or include them in a report.
+</p><p>
+A filter file is an <a href="http://www.w3.org/XML/" target="_top">XML</a> document with a top-level <code class="literal">FindBugsFilter</code> element
+which has some number of <code class="literal">Match</code> elements as children. Each <code class="literal">Match</code>
+element represents a predicate which is applied to generated bug instances.
+Usually, a filter will be used to exclude bug instances. For example:
+
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs -textui -exclude <em class="replaceable"><code>myExcludeFilter.xml</code></em> <em class="replaceable"><code>myApp.jar</code></em></strong></span>
+</pre><p>
+
+However, a filter could also be used to select bug instances to specifically
+report:
+
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs -textui -include <em class="replaceable"><code>myIncludeFilter.xml</code></em> <em class="replaceable"><code>myApp.jar</code></em></strong></span>
+</pre><p>
+</p><p>
+<code class="literal">Match</code> elements contain children, which are conjuncts of the predicate.
+In other words, each of the children must be true for the predicate to be true.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1606"></a>2. Types of Match clauses</h2></div></div></div><div class="variablelist"><dl><dt><span class="term"><code class="literal"><Bug></code></span></dt><dd><p>
+ This element specifies a particular bug pattern or patterns to match.
+ The <code class="literal">pattern</code> attribute is a comma-separated list of
+ bug pattern types. You can find the bug pattern types for particular
+ warnings by looking at the output produced by the <span><strong class="command">-xml</strong></span>
+ output option (the <code class="literal">type</code> attribute of <code class="literal">BugInstance</code>
+ elements), or from the <a href="../bugDescriptions.html" target="_top">bug
+ descriptions document</a>.
+ </p><p>
+ For more coarse-grained matching, use <code class="literal">code</code> attribute. It takes
+ a comma-separated list of bug abbreviations. For most-coarse grained matching use
+ <code class="literal">category</code> attriute, that takes a comma separated list of bug category names:
+ <code class="literal">CORRECTNESS</code>, <code class="literal">MT_CORRECTNESS</code>,
+ <code class="literal">BAD_PRACTICICE</code>, <code class="literal">PERFORMANCE</code>, <code class="literal">STYLE</code>.
+ </p><p>
+ If more than one of the attributes mentioned above are specified on the same
+ <code class="literal"><Bug></code> element, all bug patterns that match either one of specified
+ pattern names, or abreviations, or categories will be matched.
+ </p><p>
+ As a backwards compatibility measure, <code class="literal"><BugPattern></code> and
+ <code class="literal"><BugCode></code> elements may be used instead of
+ <code class="literal"><Bug></code> element. Each of these uses a
+ <code class="literal">name</code> attribute for specifying accepted values list. Support for these
+ elements may be removed in a future release.
+ </p></dd><dt><span class="term"><code class="literal"><Priority></code></span></dt><dd><p>
+ This element matches warnings with a particular priority.
+ The <code class="literal">value</code> attribute should be an integer value:
+ 1 to match high-priority warnings, 2 to match medium-priority warnings,
+ or 3 to match low-priority warnings.
+ </p></dd><dt><span class="term"><code class="literal"><Package></code></span></dt><dd><p>
+ This element matches warnings associated with classes within the package specified
+ using <code class="literal">name</code> attribute. Nested packages are not included (along the
+ lines of Java import statement). However matching multiple packages can be achieved
+ easily using regex name match.
+ </p></dd><dt><span class="term"><code class="literal"><Class></code></span></dt><dd><p>
+ This element matches warnings associated with a particular class. The
+ <code class="literal">name</code> attribute is used to specify the exact or regex match pattern
+ for the class name.
+ </p><p>
+ As a backward compatibility measure, instead of element of this type, you can use
+ <code class="literal">class</code> attribute on a <code class="literal">Match</code> element to specify
+ exact an class name or <code class="literal">classregex</code> attribute to specify a regular
+ expression to match the class name against.
+ </p><p>
+ If the <code class="literal">Match</code> element contains neither a <code class="literal">Class</code> element,
+ nor a <code class="literal">class</code> / <code class="literal">classregex</code> attribute, the predicate will apply
+ to all classes. Such predicate is likely to match more bug instances than you want, unless it is
+ refined further down with apropriate method or field predicates.
+ </p></dd><dt><span class="term"><code class="literal"><Method></code></span></dt><dd><p>This element specifies a method. The <code class="literal">name</code> is used to specify
+ the exact or regex match pattern for the method name.
+ The <code class="literal">params</code> attribute is a comma-separated list
+ of the types of the method's parameters. The <code class="literal">returns</code> attribute is
+ the method's return type. In <code class="literal">params</code> and <code class="literal">returns</code>, class names
+ must be fully qualified. (E.g., "java.lang.String" instead of just
+ "String".) If one of the latter attributes is specified the other is required for creating a method signature.
+ Note that you can provide either <code class="literal">name</code> attribute or <code class="literal">params</code>
+ and <code class="literal">returns</code> attributes or all three of them. This way you can provide various kinds of
+ name and signature based matches.
+ </p></dd><dt><span class="term"><code class="literal"><Field></code></span></dt><dd><p>This element specifies a field. The <code class="literal">name</code> attribute is is used to specify
+ the exact or regex match pattern for the field name. You can also filter fields according to their signature -
+ use <code class="literal">type</code> attribute to specify fully qualified type of the field. You can specify eiter or both
+ of these attributes in order to perform name / signature based matches.
+ </p></dd><dt><span class="term"><code class="literal"><Local></code></span></dt><dd><p>This element specifies a local variable. The <code class="literal">name</code> attribute is is used to specify
+ the exact or regex match pattern for the local variable name. Local variables are variables defined within a method.
+ </p></dd><dt><span class="term"><code class="literal"><Or></code></span></dt><dd><p>
+ This element combines <code class="literal">Match</code> clauses as disjuncts. I.e., you can put two
+ <code class="literal">Method</code> elements in an <code class="literal">Or</code> clause in order match either method.
+ </p></dd></dl></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1799"></a>3. Java element name matching</h2></div></div></div><p>
+If the <code class="literal">name</code> attribute or <code class="literal">Class</code>, <code class="literal">Method</code> or
+<code class="literal">Field</code> starts with the ~ character the rest of attribute content is interpreted as
+a Java regular expression that is matched against the names of the Java element in question.
+</p><p>
+Note that the pattern is matched against whole element name and therefore .* clauses need to be used
+at pattern beginning and/or end to perform substring matching.
+</p><p>
+See <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html" target="_top"><code class="literal">java.util.regex.Pattern</code></a>
+documentation for pattern syntax.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1824"></a>4. Caveats</h2></div></div></div><p>
+<code class="literal">Match</code> clauses can only match information that is actually contained in the
+bug instances. Every bug instance has a class, so in general, excluding
+bugs by class will work.
+</p><p>
+Some bug instances have two (or more) classes. For example, the DE (dropped exception)
+bugs report both the class containing the method where the dropped exception
+happens, and the class which represents the type of the dropped exception.
+Only the <span class="emphasis"><em>first</em></span> (primary) class is matched against <code class="literal">Match</code> clauses.
+So, for example, if you want to suppress IC (initialization circularity)
+reports for classes "com.foobar.A" and "com.foobar.B", you would use
+two <code class="literal">Match</code> clauses:
+
+</p><pre class="programlisting">
+ <Match>
+ <Class name="com.foobar.A" />
+ <Bug code="IC" />
+ </Match>
+
+ <Match>
+ <Class name="com.foobar.B" />
+ <Bug code="IC" />
+ </Match>
+</pre><p>
+
+By explicitly matching both classes, you ensure that the IC bug instance will be
+matched regardless of which class involved in the circularity happens to be
+listed first in the bug instance. (Of course, this approach might accidentally
+supress circularities involving "com.foobar.A" or "com.foobar.B" and a third
+class.)
+</p><p>
+Many kinds of bugs report what method they occur in. For those bug instances,
+you can put <code class="literal">Method</code> clauses in the <code class="literal">Match</code> element and they should work
+as expected.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1854"></a>5. Examples</h2></div></div></div><p>
+ 1. Match all bug reports for a class.
+
+</p><pre class="programlisting">
+
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ </Match>
+
+</pre><p>
+
+</p><p>
+ 2. Match certain tests from a class by specifying their abbreviations.
+</p><pre class="programlisting">
+
+ <Match>
+ <Class name="com.foobar.MyClass"/ >
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 3. Match certain tests from all classes by specifying their abbreviations.
+
+</p><pre class="programlisting">
+
+ <Match>
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 4. Match certain tests from all classes by specifying their category.
+
+</p><pre class="programlisting">
+
+ <Match>
+ <Bug category="PERFORMANCE" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 5. Match bug types from specified methods of a class by their abbreviations.
+
+</p><pre class="programlisting">
+
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Or>
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <Bug code="DC" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 6. Match a particular bug pattern in a particular method.
+
+</p><pre class="programlisting">
+
+ <!-- A method with an open stream false positive. -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="writeDataToFile" />
+ <Bug pattern="OS_OPEN_STREAM" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 7. Match a particular bug pattern with a given priority in a particular method.
+
+</p><pre class="programlisting">
+
+ <!-- A method with a dead local store false positive (medium priority). -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="someMethod" />
+ <Bug pattern="DLS_DEAD_LOCAL_STORE" />
+ <Priority value="2" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 8. Match minor bugs introduced by AspectJ compiler (you are probably not interested in these unless
+ you are an AspectJ developer).
+
+</p><pre class="programlisting">
+
+ <Match>
+ <Class name="~.*\$AjcClosure\d+" />
+ <Bug pattern="DLS_DEAD_LOCAL_STORE" />
+ <Method name="run" />
+ </Match>
+ <Match>
+ <Bug pattern="UUF_UNUSED_FIELD" />
+ <Field name="~ajc\$.*" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 9. Match bugs in specific parts of the code base
+
+</p><pre class="programlisting">
+
+ <!-- match unused fields warnings in Messages classes in all packages -->
+ <Match>
+ <Class name="~.*\.Messages" />
+ <Bug code="UUF" />
+ </Match>
+ <!-- match mutable statics warnings in all internal packages -->
+ <Match>
+ <Package name="~.*\.internal" />
+ <Bug code="MS" />
+ </Match>
+ <!-- match anonymoous inner classes warnings in ui package hierarchy -->
+ <Match>
+ <Package name="~com\.foobar\.fooproject\.ui.*" />
+ <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON" />
+ </Match>
+
+</pre><p>
+</p><p>
+ 10. Match bugs on fieds or methods with specific signatures
+</p><pre class="programlisting">
+
+ <!-- match System.exit(...) usage warnings in void main(String[]) methods in all classes -->
+ <Match>
+ <Method returns="void" name="main" params="java.lang.String[]" />
+ <Method pattern="DM_EXIT" />
+ </Match>
+ <!-- match UuF warnings on fields of type com.foobar.DebugInfo on all classes -->
+ <Match>
+ <Field type="com.foobar.DebugInfo" />
+ <Bug code="UuF" />
+ </Match>
+
+</pre><p>
+
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1907"></a>6. Complete Example</h2></div></div></div><pre class="programlisting">
+
+<FindBugsFilter>
+ <Match>
+ <Class name="com.foobar.ClassNotToBeAnalyzed" />
+ </Match>
+
+ <Match>
+ <Class name="com.foobar.ClassWithSomeBugsMatched" />
+ <Bug code="DE,UrF,SIC" />
+ </Match>
+
+ <!-- Match all XYZ violations. -->
+ <Match>
+ <Bug code="XYZ" />
+ </Match>
+
+ <!-- Match all doublecheck violations in these methods of "AnotherClass". -->
+ <Match>
+ <Class name="com.foobar.AnotherClass" />
+ <Or>
+ <Method name="nonOverloadedMethod" />
+ <Method name="frob" params="int,java.lang.String" returns="void" />
+ <Method name="blat" params="" returns="boolean" />
+ </Or>
+ <Bug code="DC" />
+ </Match>
+
+ <!-- A method with a dead local store false positive (medium priority). -->
+ <Match>
+ <Class name="com.foobar.MyClass" />
+ <Method name="someMethod" />
+ <Bug code="DLS_DEAD_LOCAL_STORE" />
+ <Priority value="2" />
+ </Match>
+</FindBugsFilter&gt;
+
+</pre></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="eclipse.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="analysisprops.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Using the <span class="application">FindBugs</span>™ Eclipse plugin </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 9. Analysis Properties</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 4. Using the FindBugs™ Graphical User Interface</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="building.html" title="Chapter 3. Building FindBugs™ from Source"><link rel="next" href="textui.html" title="Chapter 5. Using the FindBugs™ Command Line Interface"></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">Chapter 4. Using the <span class="application">FindBugs</span>™ Graphical User Interface</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="building.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="textui.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="gui"></a>Chapter 4. Using the <span class="application">FindBugs</span>™ Graphical User Interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="gui.html#d0e880">1. Creating a Project</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e922">2. Running the Analysis</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e927">3. Browsing Results</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e942">4. Saving and Opening</a></span></dt></dl></div><p>
+<span class="application">FindBugs</span> has two user interfaces: a graphical user interface (GUI) and a
+command line user interface. This chapter describes the graphical user interface.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e880"></a>1. Creating a Project</h2></div></div></div><p>
+After you have started <span class="application">FindBugs</span> using the <span><strong class="command">findbugs</strong></span> command,
+choose the <span class="guimenu">File</span> → <span class="guimenuitem">New Project</span>
+menu item. You will see a dialog which looks like this:
+</p><div class="mediaobject"><img src="project-dialog.png"></div><p>
+</p><p>
+Use the "Add" button next to the "Class archives and directories to analyze" text field to select a Java archive
+file (zip, jar, ear, or war file) or directory containing java classes to analyze for bugs. You may add multiple
+archives/directories.
+</p><p>
+You can also add the source directories which contain
+the source code for the Java archives you are analyzing. This will enable
+<span class="application">FindBugs</span> to highlight the source code which contains a possible error.
+The source directories you add should be the roots of the Java
+package hierarchy. For example, if your application is contained in the
+<code class="varname">org.foobar.myapp</code> package, you should add the
+parent directory of the <code class="filename">org</code> directory
+to the source directory list for the project.
+</p><p>
+Another optional step is to add additional Jar files or directories as
+"Auxiliary classpath locations" entries. You should do this if the archives and directories you are analyzing
+have references to other classes which are not included in the analyzed
+archives/directories and are not in the standard runtime classpath. Some of the bug
+pattern detectors in <span class="application">FindBugs</span> make use of class hierarchy information,
+so you will get more accurate results if the entire class hierarchy is
+available which <span class="application">FindBugs</span> performs its analysis.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e922"></a>2. Running the Analysis</h2></div></div></div><p>
+Once you have added all of the archives, directories, and source directories,
+click the "Finish" button to analyze the classes contained in the
+Jar files. Note that for a very large program on an older computer,
+this may take quite a while (tens of minutes). A recent computer with
+ample memory will typically be able to analyze a large program in only a
+few minutes.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e927"></a>3. Browsing Results</h2></div></div></div><p>
+When the analysis completes, you will see a screen like the following:
+</p><div class="mediaobject"><img src="example-details.png"></div><p>
+</p><p>
+The upper left-hand pane of the window shows the bug tree; this is a hierarchical
+representation of all of the potential bugs detected in the analyzed
+Jar files.
+</p><p>
+When you select a particular bug instance in the top pane, you will
+see a description of the bug in the "Details" tab of the bottom pane.
+In addition, the source code pane on the upper-right will show the
+program source code where the potential bug occurs, if source is available.
+In the above example, the bug is a stream object that is not closed. The
+source code window highlights the line where the stream object is created.
+</p><p>
+You may add a textual annotations to bug instances. To do so, type them
+into the text box just below the hierarchical view. You can type any
+information which you would like to record. When you load and save bug
+results files, the annotations are preserved.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e942"></a>4. Saving and Opening</h2></div></div></div><p>
+You may use the <span class="guimenu">File</span> → <span class="guimenuitem">Save as...</span>
+menu option to save your work. To save your work, including the jar
+file lists you specified and all bug results, choose
+"FindBugs analysis results (.xml)" from the drop-down list in the
+"Save as..." dialog. There are also options for saving just the jar
+file lists ("FindBugs project file (.fbp)") or just the results
+("FindBugs analysis file (.fba)"), but these are rarely needed. A
+saved file may be loaded with the
+<span class="guimenu">File</span> → <span class="guimenuitem">Open...</span>
+menu option.
+</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="building.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="textui.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Building <span class="application">FindBugs</span>™ from Source </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 5. Using the <span class="application">FindBugs</span>™ Command Line Interface</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<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">09:39:09 EST, 08 November, 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#d0e594">1. Prerequisites</a></span></dt><dt><span class="sect1"><a href="building.html#d0e686">2. Extracting the Source Distribution</a></span></dt><dt><span class="sect1"><a href="building.html#d0e699">3. Modifying <code class="filename">build.properties</code></a></span></dt><dt><span class="sect1"><a href="building.html#d0e751">4. Running <span class="application">Ant</span></a></span></dt><dt><span class="sect1"><a href="building.html#d0e845">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#d0e880">1. Creating a Project</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e922">2. Running the Analysis</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e927">3. Browsing Results</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e942">4. Saving and Opening</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#d0e1012">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1050">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1121">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1146">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#d0e1448">1. Requirements</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1456">2. Installation</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1503">3. Using the Plugin</a></span></dt><dt><span class="sect1"><a href="eclipse.html#d0e1526">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#d0e1556">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1606">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1799">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1824">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1854">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1907">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="ch11.html">11. Using rejarForAnalysis</a></span></dt><dt><span class="chapter"><a href="datamining.html">12. 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">13. License</a></span></dt><dt><span class="chapter"><a href="acknowledgments.html">14. Acknowledgments</a></span></dt><dd><dl><dt><span class="sect1"><a href="acknowledgments.html#d0e3272">1. Contributors</a></span></dt><dt><span class="sect1"><a href="acknowledgments.html#d0e3395">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>12.1. <a href="datamining.html#computeBugHistoryTable">Options for computeBugHistory command</a></dt><dt>12.2. <a href="datamining.html#filterOptionsTable">Options for filterBugs command</a></dt><dt>12.3. <a href="datamining.html#mineBugHistoryOptionsTable">Options for mineBugHistory command</a></dt><dt>12.4. <a href="datamining.html#mineBugHistoryColumns">Columns in mineBugHistory output</a></dt><dt>12.5. <a href="datamining.html#defectDensityColumns">Columns in defectDensity output</a></dt><dt>12.6. <a href="datamining.html#convertXmlToTextTable">Options for convertXmlToText command</a></dt><dt>12.7. <a href="datamining.html#setBugDatabaseInfoOptions">setBugDatabaseInfo Options</a></dt><dt>12.8. <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>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 2. Installing and Running FindBugs™</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="introduction.html" title="Chapter 1. Introduction"><link rel="next" href="building.html" title="Chapter 3. Building FindBugs™ from Source"></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">Chapter 2. Installing and Running <span class="application">FindBugs</span>™</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="introduction.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="building.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="installing"></a>Chapter 2. Installing and Running <span class="application">FindBugs</span>™</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><p>
+This chapter explains how to install and run <span class="application">FindBugs</span>.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e104"></a>1. Extracting the Distribution</h2></div></div></div><p>
+The easiest way to install <span class="application">FindBugs</span> is to download a binary distribution.
+Binary distributions are available in
+<a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.tar.gz?download" target="_top">gzipped tar format</a> and
+<a href="http://prdownloads.sourceforge.net/findbugs/findbugs-1.3.0.zip?download" target="_top">zip format</a>.
+Once you have downloaded a binary distribution, extract it into a directory of your choice.
+</p><p>
+Extracting a gzipped tar format distribution:
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">gunzip -c findbugs-1.3.0.tar.gz | tar xvf -</strong></span>
+</pre><p>
+</p><p>
+Extracting a zip format distribution:
+</p><pre class="screen">
+<code class="prompt">C:\Software></code><span><strong class="command">unzip findbugs-1.3.0.zip</strong></span>
+</pre><p>
+</p><p>
+Usually, extracting a binary distribution will create a directory ending in
+<code class="filename">findbugs-1.3.0</code>. For example, if you extracted
+the binary distribution from the <code class="filename">C:\Software</code>
+directory, then the <span class="application">FindBugs</span> software will be extracted into the directory
+<code class="filename">C:\Software\findbugs-1.3.0</code>.
+This directory is the <span class="application">FindBugs</span> home directory. We'll refer to it as
+<em class="replaceable"><code>$FINDBUGS_HOME</code></em> throughout this manual.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e158"></a>2. Configuration</h2></div></div></div><p>
+Once you have extracted the binary distribution, all you need to do in order
+to run <span class="application">FindBugs</span> is to invoke the wrapper script.
+</p><p>
+On Unix-like systems, use the following command to invoke the wrapper script:
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin/findbugs <em class="replaceable"><code>options...</code></em></strong></span>
+</pre><p>
+</p><p>
+On Windows systems, the command to invoke the wrapper script is
+</p><pre class="screen">
+<code class="prompt">C:\My Directory></code><span><strong class="command"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>\bin\findbugs.bat <em class="replaceable"><code>options...</code></em></strong></span>
+</pre><p>
+</p><p>
+On both Unix-like and Windows systems, you can simply add the <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin</code>
+directory to your <code class="filename">PATH</code> environment variable and then invoke
+FindBugs using the <span><strong class="command">findbugs</strong></span> command.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="commandLineOptions"></a>3. Command Line Options</h2></div></div></div><p>
+
+There are two ways to invoke <span class="application">FindBugs</span>. The first invokes the the Graphical User Interface (GUI):
+
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs <em class="replaceable"><code>[standard options]</code></em> <em class="replaceable"><code>[GUI options]</code></em></strong></span>
+</pre><p>
+
+The second invokes the Command Line Interface (Text UI):
+
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs -textui <em class="replaceable"><code>[standard options]</code></em> <em class="replaceable"><code>[Text UI options]</code></em></strong></span>
+</pre><p>
+</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e241"></a>3.1. Standard options</h3></div></div></div><p>
+These options may be used with both the GUI and Text UI.
+
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">-jvmArgs <em class="replaceable"><code>args</code></em></strong></span></span></dt><dd><p>
+ Specifies arguments to pass to the JVM. For example, you might want
+ to set a JVM property:
+</p><pre class="screen">
+<code class="prompt">$ </code><span><strong class="command">findbugs -textui -jvmArgs "-Duser.language=ja" <em class="replaceable"><code>myApp.jar</code></em></strong></span>
+</pre><p>
+ </p></dd><dt><span class="term"><span><strong class="command">-javahome <em class="replaceable"><code>directory</code></em></strong></span></span></dt><dd><p>
+ Specifies the directory containing the JRE (Java Runtime Environment) to
+ use to execute <span class="application">FindBugs</span>.
+ </p></dd><dt><span class="term"><span><strong class="command">-maxHeap <em class="replaceable"><code>size</code></em></strong></span></span></dt><dd><p>
+ Specifies the maximum Java heap size in megabytes. The default is 256.
+ More memory may be required to analyze very large programs or libraries.
+ </p></dd><dt><span class="term"><span><strong class="command">-debug</strong></span></span></dt><dd><p>
+ Prints a trace of detectors run and classes analyzed to standard output.
+ Useful for troubleshooting unexpected analysis failures.
+ </p></dd><dt><span class="term"><span><strong class="command">-effort:min</strong></span></span></dt><dd><p>
+ This option disables analyses that increase precision but also
+ increase memory consumption. You may want to try this option if
+ you find that <span class="application">FindBugs</span> runs out of memory, or takes an unusually
+ long time to complete its analysis.
+ </p></dd><dt><span class="term"><span><strong class="command">-effort:max</strong></span></span></dt><dd><p>
+ Enable analyses which increase precision and find more bugs, but which
+ may require more memory and take more time to complete.
+ </p></dd><dt><span class="term"><span><strong class="command">-property</strong></span> <em class="replaceable"><code>name=value</code></em></span></dt><dd><p>
+ This option sets a system property. <span class="application">FindBugs</span> uses system properties
+ to configure analysis options. See <a href="analysisprops.html" title="Chapter 9. Analysis Properties">Chapter 9, <i>Analysis Properties</i></a>.
+ You can use this option multiple times in order to set multiple properties.
+ Note: In most versions of Windows, the <em class="replaceable"><code>name=value</code></em>
+ string must be in quotes.
+ </p></dd><dt><span class="term"><span><strong class="command">-project</strong></span> <em class="replaceable"><code>project</code></em></span></dt><dd><p>
+ Specify a project to be analyzed. The project file you specify should
+ be one that was created using the GUI interface. It will typically end
+ in the extension <code class="filename">.fb</code>.
+ </p></dd></dl></div><p>
+</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e344"></a>3.2. GUI Options</h3></div></div></div><p>
+These options are only accepted by the Graphical User Interface.
+
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">-look:</strong></span><em class="replaceable"><code>plastic|gtk|native</code></em></span></dt><dd><p>
+ Set Swing look and feel.
+ </p></dd></dl></div><p>
+</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e360"></a>3.3. Text UI Options</h3></div></div></div><p>
+These options are only accepted by the Text User Interface.
+</p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">-sortByClass</strong></span></span></dt><dd><p>
+ Sort reported bug instances by class name.
+ </p></dd><dt><span class="term"><span><strong class="command">-include</strong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></dt><dd><p>
+ Only report bug instances that match the filter specified by <em class="replaceable"><code>filterFile.xml</code></em>.
+ See <a href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a>.
+ </p></dd><dt><span class="term"><span><strong class="command">-exclude</strong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></dt><dd><p>
+ Report all bug instances except those matching the filter specified by <em class="replaceable"><code>filterFile.xml</code></em>.
+ See <a href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a>.
+ </p></dd><dt><span class="term"><span><strong class="command">-onlyAnalyze</strong></span> <em class="replaceable"><code>com.foobar.MyClass,com.foobar.mypkg.*</code></em></span></dt><dd><p>
+ Restrict analysis to find bugs to given comma-separated list of
+ classes and packages.
+ Unlike filtering, this option avoids running analysis on
+ classes and packages that are not explicitly matched:
+ for large projects, this may greatly reduce the amount of time
+ needed to run the analysis. (However, some detectors may produce
+ inaccurate results if they aren't run on the entire application.)
+ Classes should be specified using their full classnames (including
+ package), and packages should be specified in the same way
+ they would in a Java <code class="literal">import</code> statement to
+ import all classes in the package (i.e., add <code class="literal">.*</code>
+ to the full name of the package).
+ Replace <code class="literal">.*</code> with <code class="literal">.-</code> to also
+ analyze all subpackages.
+ </p></dd><dt><span class="term"><span><strong class="command">-low</strong></span></span></dt><dd><p>
+ Report all bugs.
+ </p></dd><dt><span class="term"><span><strong class="command">-medium</strong></span></span></dt><dd><p>
+ Report medium and high priority bugs. This is the default setting.
+ </p></dd><dt><span class="term"><span><strong class="command">-high</strong></span></span></dt><dd><p>
+ Report only high priority bugs.
+ </p></dd><dt><span class="term"><span><strong class="command">-relaxed</strong></span></span></dt><dd><p>
+ Relaxed reporting mode. For many detectors, this option
+ suppresses the heuristics used to avoid reporting false positives.
+ </p></dd><dt><span class="term"><span><strong class="command">-xml</strong></span></span></dt><dd><p>
+ Produce the bug reports as XML. The XML data produced may be
+ viewed in the GUI at a later time. You may also specify this
+ option as <span><strong class="command">-xml:withMessages</strong></span>; when this variant
+ of the option is used, the XML output will contain human-readable
+ messages describing the warnings contained in the file.
+ XML files generated this way are easy to transform into reports.
+ </p></dd><dt><span class="term"><span><strong class="command">-html</strong></span></span></dt><dd><p>
+ Generate HTML output. By default, <span class="application">FindBugs</span> will use the <code class="filename">default.xsl</code>
+ <a href="http://www.w3.org/TR/xslt" target="_top">XSLT</a>
+ stylesheet to generate the HTML: you can find this file in <code class="filename">findbugs.jar</code>,
+ or in the <span class="application">FindBugs</span> source or binary distributions. Variants of this option include
+ <span><strong class="command">-html:plain.xsl</strong></span>, <span><strong class="command">-html:fancy.xsl</strong></span> and <span><strong class="command">-html:fancy-hist.xsl</strong></span>.
+ The <code class="filename">plain.xsl</code> stylesheet does not use Javascript or DOM,
+ and may work better with older web browsers, or for printing. The <code class="filename">fancy.xsl</code>
+ stylesheet uses DOM and Javascript for navigation and CSS for
+ visual presentation. The <span><strong class="command">fancy-hist.xsl</strong></span> an evolution of <span><strong class="command">fancy.xsl</strong></span> stylesheet.
+ It makes an extensive use of DOM and Javascript for dynamically filtering the lists of bugs.
+ </p><p>
+ If you want to specify your own
+ XSLT stylesheet to perform the transformation to HTML, specify the option as
+ <span><strong class="command">-html:<em class="replaceable"><code>myStylesheet.xsl</code></em></strong></span>,
+ where <em class="replaceable"><code>myStylesheet.xsl</code></em> is the filename of the
+ stylesheet you want to use.
+ </p></dd><dt><span class="term"><span><strong class="command">-emacs</strong></span></span></dt><dd><p>
+ Produce the bug reports in Emacs format.
+ </p></dd><dt><span class="term"><span><strong class="command">-xdocs</strong></span></span></dt><dd><p>
+ Produce the bug reports in xdoc XML format for use with Apache Maven.
+ </p></dd><dt><span class="term"><span><strong class="command">-output</strong></span> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>
+ Produce the output in the specified file.
+ </p></dd><dt><span class="term"><span><strong class="command">-outputFile</strong></span> <em class="replaceable"><code>filename</code></em></span></dt><dd><p>
+ This argument is deprecated. Use <span><strong class="command">-output</strong></span> instead.
+ </p></dd><dt><span class="term"><span><strong class="command">-nested</strong></span><em class="replaceable"><code>[:true|false]</code></em></span></dt><dd><p>
+ This option enables or disables scanning of nested jar and zip files found in
+ the list of files and directories to be analyzed.
+ By default, scanning of nested jar/zip files is enabled.
+ To disable it, add <span><strong class="command">-nested:false</strong></span> to the command line
+ arguments.
+ </p></dd><dt><span class="term"><span><strong class="command">-auxclasspath</strong></span> <em class="replaceable"><code>classpath</code></em></span></dt><dd><p>
+ Set the auxiliary classpath for analysis. This classpath should include all
+ jar files and directories containing classes that are part of the program
+ being analyzed but you do not want to have analyzed for bugs.
+ </p></dd></dl></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="introduction.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="building.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. Introduction </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. Building <span class="application">FindBugs</span>™ from Source</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 1. Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="index.html" title="FindBugs™ Manual"><link rel="next" href="installing.html" title="Chapter 2. Installing and Running FindBugs™"></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">Chapter 1. Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="installing.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="introduction.html#d0e73">1. Requirements</a></span></dt></dl></div><p> <span class="application">FindBugs</span>™ is a program to find bugs in Java programs. It looks for instances
+of "bug patterns" --- code instances that are likely to be errors.</p><p> This document describes version 1.3.0 of <span class="application">FindBugs</span>. This is an
+early release of the tool, so you may find problems with it. We
+are very interested in getting your feedback on <span class="application">FindBugs</span>. Please visit
+the <a href="http://findbugs.sourceforge.net" target="_top"><span class="application">FindBugs</span> web page</a> for
+the latest information on <span class="application">FindBugs</span>, contact information, and support resources such
+as information about the <span class="application">FindBugs</span> mailing lists.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e73"></a>1. Requirements</h2></div></div></div><p> To use <span class="application">FindBugs</span>, you need a runtime environment compatible with
+<a href="http://java.sun.com/j2se" target="_top">Java 2 Standard Edition</a>, version 1.4.0 or later.
+<span class="application">FindBugs</span> is platform independent, and is known to run on GNU/Linux, Windows, and
+MacOS X platforms.</p><p>You should have at least 512 MB of memory to use <span class="application">FindBugs</span>.
+To analyze very large projects, more memory may be needed.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="installing.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="application">FindBugs</span>™ Manual </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. Installing and Running <span class="application">FindBugs</span>™</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 13. License</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="datamining.html" title="Chapter 12. Data mining of bugs with FindBugs™"><link rel="next" href="acknowledgments.html" title="Chapter 14. Acknowledgments"></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">Chapter 13. License</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="datamining.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="acknowledgments.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="license"></a>Chapter 13. License</h2></div></div></div><p>
+The name FindBugs and the FindBugs logo is trademarked by the University
+of Maryland.
+FindBugs is free software distributed under the terms of the
+<a href="http://www.gnu.org/licenses/lgpl.html" target="_top">Lesser GNU Public License</a>.
+You should have received a copy of the license in the file <code class="filename">LICENSE.txt</code>
+in the <span class="application">FindBugs</span> distribution.
+</p><p>
+You can find the latest version of FindBugs, along with its source code, from the
+<a href="http://findbugs.sourceforge.net" target="_top">FindBugs web page</a>.
+</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="datamining.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="acknowledgments.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 12. Data mining of bugs with <span class="application">FindBugs</span>™ </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 14. Acknowledgments</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 5. Using the FindBugs™ Command Line Interface</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="gui.html" title="Chapter 4. Using the FindBugs™ Graphical User Interface"><link rel="next" href="anttask.html" title="Chapter 6. Using the FindBugs™ Ant task"></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">Chapter 5. Using the <span class="application">FindBugs</span>™ Command Line Interface</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gui.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="anttask.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="textui"></a>Chapter 5. Using the <span class="application">FindBugs</span>™ Command Line Interface</h2></div></div></div><p>
+The <span class="application">FindBugs</span> Command Line Interface (or Text UI) can be used to
+analyze an application for bugs non-interactively. Each bug instance will be
+reported on a single line. All output is written to the standard output file descriptor.
+<a href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a> explains how bug reports may be filtered in order
+to get only the output you're interested in.
+</p><p>
+See <a href="installing.html#commandLineOptions" title="3. Command Line Options">Section 3, “Command Line Options”</a> in <a href="installing.html" title="Chapter 2. Installing and Running FindBugs™">Chapter 2, <i>Installing and Running <span class="application">FindBugs</span>™</i></a> for a description of how to invoke the
+Command Line Interface.
+</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gui.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="anttask.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 4. Using the <span class="application">FindBugs</span>™ Graphical User Interface </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</td></tr></table></div></body></html>
\ No newline at end of file
--- /dev/null
+<html>
+<head>
+<title>FindBugs Documents and Publications</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs Documents and Publications</h1>
+
+<p> This page lists documents, publications, and other sources
+of information about FindBugs.
+
+<h2>General Information</h2>
+
+<ul>
+<li> The <a href="manual/index.html">FindBugs manual</a> describes how to
+install and use FindBugs.
+<li> A <a href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Japanese translation</a>
+of the FindBugs manual contributed by Hiroshi Okugawa.
+<li> A <a href="bugDescriptions.html">list of bug patterns reported by FindBugs</a>.
+<li> The <a href="FAQ.html">FindBugs FAQ</a> contains answers to frequently asked
+questions about FindBugs.
+</ul>
+
+<h2>Publications</h2>
+
+<ul>
+<li> <a href="http://findbugs.sourceforge.net/docs/oopsla2004.pdf">Finding Bugs is Easy</a>, a
+paper that appeared in the December 2004 issue of SIGPLAN Notices.
+An extended abstract of the paper appeared in the OOPSLA 2004 Companion,
+as part of the Onward! track of the conference. The raw data
+we used in the empirical evaluation section is available:
+ <ul>
+ <li> <a href="http://findbugs.sourceforge.net/data/classpath-0.08.xml">classpath-0.08.xml</a>
+ <li> <a href="http://findbugs.sourceforge.net/data/drjava-stable-20040326.xml">drjava-stable-20040326.xml</a>
+ <li> <a href="http://findbugs.sourceforge.net/data/eclipse-3.0.xml">eclipse-3.0.xml</a>
+ <li> <a href="http://findbugs.sourceforge.net/data/jboss-4.0.0RC1.xml">jboss-4.0.0RC1.xml</a>
+ <li> <a href="http://findbugs.sourceforge.net/data/jedit-4.2pre15.xml">jedit-4.2pre15.xml</a>
+ <li> <a href="http://findbugs.sourceforge.net/data/rt-1.5-59.xml">rt-1.5-59.xml</a>
+ </ul>
+<li> <a href="http://www.cs.umd.edu/~jfoster/papers/issre04.pdf">A Comparison of Bug Finding Tools for Java</a>, by Nick Rutar, Christian Almazan, and Jeff Foster,
+compares several bug checkers for Java, including FindBugs.
+<li> Chris Grindstaff has written a two-part article about FindBugs
+(<a href="http://www-106.ibm.com/developerworks/java/library/j-findbug1/">Part 1</a>,
+<a href="http://www-106.ibm.com/developerworks/java/library/j-findbug2/">Part 2</a>)
+for IBM developerWorks.
+</ul>
+
+<h2>Presentations</h2>
+<ul>
+<li> <a href="http://findbugs.sourceforge.net/docs/oopsla2004-slides.pdf">Presentation slides</a>
+ from a talk given by David Hovemeyer at OOPSLA 2004.
+<li> <a href="http://findbugs.sourceforge.net/docs/FindBugsTalk2.pdf">Presentation slides</a>
+ from a talk given by Bill Pugh at the
+ <a href="http://fc-md.umd.edu/fcmd/index.html"
+ >Fraunhofer Center for Experimental Software Engineering</a>,
+ July 2004
+<li> <a href="http://findbugs.sourceforge.net/docs/FindBugsJavaOne.pdf">Finding Bugs is Easy</a>,
+ a presentation given by David Hovemeyer and Bill Pugh
+ at <a href="http://java.sun.com/javaone/">JavaOne 2004</a>,
+ June 2004
+<li> <a href="http://findbugs.sourceforge.net/docs/FindBugsJKeller.pdf">Presentation slides</a>
+ from J. Keller's presentation at the FindBugs JavaOne BOF,
+ June 2004
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>Reporting Bugs in FindBugs</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>Reporting Bugs in FindBugs</h1>
+
+<p>
+First of all, if you find a bug in FindBugs, and have the
+skills to fix it, we encourage you to unleash the power of open source and
+<a href="contributing.html">send us a patch</a>. We will gladly
+credit you on our website and in the manual.
+</p>
+
+<p>
+Please report bugs using the
+<a href="http://sourceforge.net/tracker/?atid=614693&group_id=96405&func=browse">Sourceforge
+bugs tracker</a>. Note that you need to be logged in to sourceforge to
+use the bug tracker.
+</p>
+
+<p>
+If you cannot use the Sourceforge tracker, you can try sending
+email to the <a href="http://www.cs.umd.edu/mailman/listinfo/findbugs-discuss"
+>findbugs-discuss mailing list</a>. You must be subscribed
+to the list to post a message.
+</p>
+
+<p>
+Finally, as a last resort, you can email <a href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>.
+However, such emails are much less likely to be handled in a timely manner than
+posts to the tracker or mailing list.
+</p>
+
+<h2>False and Inaccurate Warnings</h2>
+
+<p>
+ Like most bug-detection tools based on static analysis, FindBugs
+ issues some warnings that do not correspond to real bugs.
+ While in general we would like to make the percentage of such warnings
+ small, we can never fully eliminate them.
+</p>
+
+<h2>Information to include</h2>
+
+<p>
+When reporting a bug, please include the following information:
+</p>
+<ul>
+<li>Complete list of steps to reproduce the problem</li>
+<li>If the error occurs during analysis, a jar file, class file,
+ or self-contained Java class that demonstrates the problem</li>
+<li>FindBugs version</li>
+<li>JDK/JRE version</li>
+<li>Host operating system</li>
+<li>Any exception traces, Eclipse error log entries, etc. that might
+ be relevant</li>
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs Optional System Properties</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs Optional System Properties</h1>
+
+<p> These system properties can be added to the command line to alter the way
+findbugs works. These options should be considered experimental. The description
+gives information if the field is set to true.
+</p>
+
+<table width="100%" border="1">
+ <tr bgColor="#F0F0F0"><th>System Property</th><th>Description</th></tr>
+
+ <tr>
+ <td>findbugs.assertionmethods</td>
+ <td>methods supplied by user that have assertions</td>
+ </tr>
+ <tr>
+ <td>findbugs.checkreturn.loadtraining
+ <br/>findbugs.checkreturn.savetraining</td>
+ <td>file name to read/write list of methods whose return values must be checked</td>
+ </tr>
+ <tr>
+ <td>findbugs.de.comment</td>
+ <td>Don't report empty catch blocks if a source comment is found in the block.</td>
+ </tr>
+ <tr>
+ <td>findbugs.dls.exclusions</td>
+ <td>local variables that will be excluded from Dead Local Store</td>
+ </tr>
+ <tr>
+ <td>findbugs.fis.unsyncFactor</td>
+ <td>Default value is 2.0, which means that we report a bug if more than 1/3 of accesses are unsynchronized.</td>
+ </tr>
+ <tr>
+ <td>findbugs.fis.writeBias</td>
+ <td>Default value is 2.0. The idea is that this should be above 1.0, because unsynchronized writes are more dangerous than unsynchronized reads.</td>
+ </tr>
+ <tr>
+ <td>fundbugs.gui.bugCount</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>findbugs.maskedfields.locals</td>
+ <td>Report on local variables that mask fields.</td>
+ </tr>
+ <tr>
+ <td>findbugs.noSummary</td>
+ <td>Don't create the report summary</td>
+ </tr>
+ <tr>
+ <td>findbugs.nullderef.assumensp</td>
+ <td>sets value for IsNullValueAnalysisFeatures.UNKNOWN_VALUES_ARE_NSP, but is not used by FindBugs</td>
+ </tr>
+ <tr>
+ <td>findbugs.refcomp.reportAll</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>findbugs.report.SummaryHTML</td>
+ <td>emit SummaryHTML element</td>
+ </tr>
+ <tr>
+ <td>findbugs.sf.comment</td>
+ <td>Ignore switch fall thru bugs if a comment is found with 'fall' or 'nobreak'
+ </tr>
+ <tr>
+ <td>ba.checkAssertions</td>
+ <td>throw excptions on certain illegal class type signatures</td>
+ </tr>
+ <tr>
+ <td>ba.verifyIntegrity</td>
+ <td>enable data structure integrity checks</td>
+ </tr>
+ <tr>
+ <td>BCPMethodReturnCheck.java</td>
+ <td>Add methods to the list requiring a check. (format: "class:method:sig|...")</td>
+ </tr>
+ <tr>
+ <td>dataflow.stackonly</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>fis.eval</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>fis.noAdjustSubclass</td>
+ <td>Adjust field so its class name is the same as the type of reference it is accessed through.</td>
+ </tr>
+ <tr>
+ <td>fos.allowWUS</td>
+ <td>Ignore wrapping streams that are wrapping uninteresting streams (like in memory streams).</td>
+ </tr>
+ <tr>
+ <td>ic.createInstance</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>inva.ncpExtraBranch</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>inva.noAssertHack</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>inva.noSplitDowngradeNSP</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>inva.noSwitchDefaultAsException</td>
+ <td>Don't consider switch default cases as exception paths.</td>
+ </tr>
+ <tr>
+ <td>lineNumberBug</td>
+ <td>Disable the workaround for the bug in BCEL 5.0's LineNumberTable class.</td>
+ </tr>
+ <tr>
+ <td>ma.ugly</td>
+ <td>Report method signature with method class and name.</td>
+ </tr>
+ <tr>
+ <td>mrc.checkall</td>
+ <td>Check for 1.5-specific method return values being ignored even if runtime Java predates 1.5.</td>
+ </tr>
+ <tr>
+ <td>ta.accurateExceptions</td>
+ <td>?</td>
+ </tr>
+ <tr>
+ <td>vna.noRLE</td>
+ <td>Perform redundant load elimination and forward substitution (but not in a correctness-preserving way).</td>
+ </tr>
+
+</table>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<title>FindBugs Development Team</title>
+<link rel="stylesheet" type="text/css" href="findbugs.css">
+
+</head>
+<body>
+
+<table width="100%"><tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+<td align="left" valign="top">
+
+<h1>FindBugs Development Team</h1>
+
+<p> These are the current members of the FindBugs development team:
+
+<ul>
+<li> Bill Pugh (project admin)
+<li> David Hovemeyer (project admin)
+<li> Phil Crosby
+<li> Peter Friese (eclipse plugin)
+<li> Dave Brosius
+<li> Brian Goetz
+<li> Rohan Lloyd
+</ul>
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+</td>
+
+</tr></table>
+
+</body>
+</html>
--- /dev/null
+<html>
+ <head>
+ <title>FindBugs™ Users and Supporters</title>
+ <link rel="stylesheet" type="text/css" href="findbugs.css" />
+
+ </head>
+
+ <body>
+
+ <table width="100%">
+ <tr>
+
+
+<td bgcolor="#b9b9fe" valign="top" align="left" width="20%">
+<table width="100%" cellspacing="0" border="0">
+<tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Docs and Info</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual (en)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://www.simeji.com/findbugs/doc/manual_ja/index.html">Manual (ja)</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
+
+<tr><td> </td></tr>
+
+<tr><td><b>Development</b></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr>
+<tr><td><font size="-1"><a class="sidebar" href="http://findbugs.cvs.sourceforge.net/findbugs">Browse source</a></font></td></tr>
+</table>
+</td>
+
+ <td align="left" valign="top">
+
+ <!--
+<p>
+ <a href="http://findbugs.sourceforge.net/"><img src="buggy-sm.png" alt="FindBugs logo" border="0" /></a>
+ <a href="http://www.umd.edu/"><img src="informal.png" alt="UMD logo" border="0" /></a>
+</p>
+-->
+
+ <h1>
+ FindBugs Users
+ </h1>
+
+ <p>
+ There are a
+ <em>lot</em> of FindBugs users; as of September 2006, we've had
+ more than 270,000 downloads.
+
+ </p>
+ <p>
+ FindBugs is used in many companies and organizations. We don't
+ have a list of all the users of FindBugs, and we don't have
+ permission to identify many of the companies where we know
+ FindBugs is being used (getting this permission often involves red
+ tape and lawyers). But here are some statics from Google Analytics
+ showing unique visitors to the FindBugs web pages for the months
+ of June through August, 2006.
+
+ </p>
+ <p align="center">
+ <img src="customers/geoLocation.png" alt="Downloads by country">
+ </p>
+ <p align="center">
+ <img src="customers/geoMap.png" alt="Cities with the most downloads">
+
+ </p>
+ <h2>
+ FindBugs Users
+ </h2>
+ <p>
+ The following companies, projects and organizations have given us
+ permission to identify them as FindBugs users and/or have
+ publically stated that they use FindBugs. Send email to
+ <a href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a> if
+ you'd like to be listed here.
+ </p>
+
+ <table cellpadding="10pt" align="center">
+ <tr>
+ <td align="center">
+ <a href="http://itasoftware.com/"><img
+ src="customers/ITAsoftware.png" alt="ITA Software">
+ </a>
+ </td>
+ <td align="center">
+ <a href="https://glassfish.dev.java.net/"><img
+ src="customers/glassfish.png" alt="Glassfish">
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td align="center">
+ <a href="https://javaserverfaces.dev.java.net/">Java Server
+ Faces</a>
+ </td>
+ <td align="center">
+ <a href="http://www.objectlab.co.uk/"><img
+ src="http://www.objectlab.co.uk/images/objectlab-web-noblue.gif"
+ alt="ObjectLab">
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td align="center">
+ <a href="http://www.sat4j.org/"><img
+ src="customers/sat4j.png" alt="SAT 4j">
+ </a>
+ </td>
+ <td align="center">
+ <a href="http://www.sleepycat.com/"><img
+ src="customers/sleepycat.png" alt="SleepyCat">
+ </a>
+ </td>
+ </tr>
+ </table>
+ <h2>
+ FindBugs Supporters
+ </h2>
+ <p>
+ The following companies, organizations and institutions provide
+ financial support for FindBugs. Tax deductable donations to
+ support FindBugs can be made to the University of Maryland.
+
+ </p>
+
+ <table cellpadding="10pt" align="center">
+ <tr>
+ <td align="center">
+ <a href="http://www.fortifysoftware.com/products/sca40.jsp#findbugs"><img
+ src="Fortify.png" alt="Fortify Software">
+ </a>
+ </td>
+ <td align="center">
+ <a href="http://www.google.com"><img
+ src="customers/google.png" alt="Google">
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td align="center">
+ <a href="http://www.sun.com"><img src="customers/sun.png"
+ alt="Sun Microsystems">
+ </a>
+ </td>
+ <td align="center">
+ <a href="http://www.nsf.gov/"><img src="customers/nsf.png"
+ alt="National Science Foundation">
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td align="center">
+ <a href="http://www.cs.umd.edu/"><img
+ src="customers/logo_umd.png" alt="Univ. of Maryland">
+ </a>
+ </td>
+ </tr>
+ </table>
+
+
+
+<hr> <p>
+<script language="JavaScript" type="text/javascript">
+<!---//hide script from old browsers
+document.write( "Last updated "+ document.lastModified + "." );
+//end hiding contents --->
+</script>
+<p> Send comments to <a class="sidebar" href="mailto:findbugs@cs.umd.edu">findbugs@cs.umd.edu</a>
+<p>
+<A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
+
+ </td align="center">
+ </tr>
+ </table>
+
+ </body>
+</html>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ FindBugs - Find bugs in Java programs
+ Copyright (C) 2004,2005 University of Maryland
+ Copyright (C) 2005, Chris Nappin
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+-->
+
+<!--
+ A simple XSLT stylesheet to transform FindBugs XML results
+ annotated with messages into HTML.
+
+ If you want to experiment with modifying this stylesheet,
+ or write your own, you need to generate XML output from FindBugs
+ using a special option which lets it know to include
+ human-readable messages in the XML. Invoke the findbugs script
+ as follows:
+
+ findbugs -textui -xml:withMessages -project myProject.fb > results.xml
+
+ Then you can use your favorite XSLT implementation to transform
+ the XML output into HTML. (But don't use xsltproc. It generates well-nigh
+ unreadable output, and generates incorrect output for the
+ <script> element.)
+
+ Authors:
+ David Hovemeyer
+ Chris Nappin (summary table)
+-->
+
+<xsl:stylesheet
+ version="1.0"
+ xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+<xsl:output
+ method="xml"
+ indent="yes"
+ omit-xml-declaration="yes"
+ standalone="yes"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ encoding="UTF-8"/>
+
+<xsl:variable name="literalNbsp">&nbsp;</xsl:variable>
+
+<!--xsl:key name="bug-category-key" match="/BugCollection/BugInstance" use="@category"/-->
+
+<xsl:variable name="bugTableHeader">
+ <tr class="tableheader">
+ <th align="left">Code<xsl:value-of select="$literalNbsp"/></th>
+ <th align="left">Warning</th>
+ </tr>
+</xsl:variable>
+
+<xsl:template match="/">
+ <html>
+ <head>
+ <title>FindBugs Report</title>
+ <style type="text/css">
+ .tablerow0 {
+ background: #EEEEEE;
+ }
+
+ .tablerow1 {
+ background: white;
+ }
+
+ .detailrow0 {
+ background: #EEEEEE;
+ }
+
+ .detailrow1 {
+ background: white;
+ }
+
+ .tableheader {
+ background: #b9b9fe;
+ font-size: larger;
+ }
+
+ .tablerow0:hover, .tablerow1:hover {
+ background: #aaffaa;
+ }
+
+ .priority-1 {
+ color: red;
+ font-weight: bold;
+ }
+ .priority-2 {
+ color: orange;
+ font-weight: bold;
+ }
+ .priority-3 {
+ color: green;
+ font-weight: bold;
+ }
+ .priority-4 {
+ color: blue;
+ font-weight: bold;
+ }
+ </style>
+ <script type="text/javascript">
+ function toggleRow(elid) {
+ if (document.getElementById) {
+ element = document.getElementById(elid);
+ if (element) {
+ if (element.style.display == 'none') {
+ element.style.display = 'block';
+ //window.status = 'Toggle on!';
+ } else {
+ element.style.display = 'none';
+ //window.status = 'Toggle off!';
+ }
+ }
+ }
+ }
+ </script>
+ </head>
+
+ <xsl:variable name="unique-catkey" select="/BugCollection/BugCategory/@category"/>
+ <!--xsl:variable name="unique-catkey" select="/BugCollection/BugInstance[generate-id() = generate-id(key('bug-category-key',@category))]/@category"/-->
+
+ <body>
+
+ <h1><a href="http://findbugs.sourceforge.net">FindBugs</a> Report</h1>
+
+ <h2>Project Information</h2>
+ <xsl:apply-templates select="/BugCollection/Project"/>
+
+ <h2>Metrics</h2>
+ <xsl:apply-templates select="/BugCollection/FindBugsSummary"/>
+
+ <h2>Contents</h2>
+ <ul>
+ <xsl:for-each select="$unique-catkey">
+ <xsl:sort select="." order="ascending"/>
+ <xsl:variable name="catkey" select="."/>
+ <xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
+
+ <li><a href="#Warnings_{$catkey}"><xsl:value-of select="$catdesc"/> Warnings</a></li>
+ </xsl:for-each>
+
+ <li><a href="#Details">Details</a></li>
+ </ul>
+
+ <h1>Summary</h1>
+ <table width="500" cellpadding="5" cellspacing="2">
+ <tr class="tableheader">
+ <th align="left">Warning Type</th>
+ <th align="right">Number</th>
+ </tr>
+
+ <xsl:for-each select="$unique-catkey">
+ <xsl:sort select="." order="ascending"/>
+ <xsl:variable name="catkey" select="."/>
+ <xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
+ <xsl:variable name="styleclass">
+ <xsl:choose><xsl:when test="position() mod 2 = 1">tablerow0</xsl:when>
+ <xsl:otherwise>tablerow1</xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <tr class="{$styleclass}">
+ <td><a href="#Warnings_{$catkey}"><xsl:value-of select="$catdesc"/> Warnings</a></td>
+ <td align="right"><xsl:value-of select="count(/BugCollection/BugInstance[@category=$catkey])"/></td>
+ </tr>
+ </xsl:for-each>
+
+ <xsl:variable name="styleclass">
+ <xsl:choose><xsl:when test="count($unique-catkey) mod 2 = 0">tablerow0</xsl:when>
+ <xsl:otherwise>tablerow1</xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+ <tr class="{$styleclass}">
+ <td><b>Total</b></td>
+ <td align="right"><b><xsl:value-of select="count(/BugCollection/BugInstance)"/></b></td>
+ </tr>
+ </table>
+
+ <h1>Warnings</h1>
+
+ <p>Click on a warning row to see full context information.</p>
+
+ <xsl:for-each select="$unique-catkey">
+ <xsl:sort select="." order="ascending"/>
+ <xsl:variable name="catkey" select="."/>
+ <xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
+
+ <xsl:call-template name="generateWarningTable">
+ <xsl:with-param name="warningSet" select="/BugCollection/BugInstance[@category=$catkey]"/>
+ <xsl:with-param name="sectionTitle"><xsl:value-of select="$catdesc"/> Warnings</xsl:with-param>
+ <xsl:with-param name="sectionId">Warnings_<xsl:value-of select="$catkey"/></xsl:with-param>
+ </xsl:call-template>
+ </xsl:for-each>
+
+ <h1><a name="Details">Details</a></h1>
+
+ <xsl:apply-templates select="/BugCollection/BugPattern">
+ <xsl:sort select="@abbrev"/>
+ <xsl:sort select="ShortDescription"/>
+ </xsl:apply-templates>
+
+ </body>
+ </html>
+</xsl:template>
+
+<xsl:template match="Project">
+ <p>Project:
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </p>
+ <p>FindBugs version: <xsl:value-of select="/BugCollection/@version"/></p>
+
+ <p>Code analyzed:</p>
+ <ul>
+ <xsl:for-each select="./Jar">
+ <li><xsl:value-of select="text()"/></li>
+ </xsl:for-each>
+ </ul>
+ <p><br/><br/></p>
+</xsl:template>
+
+<xsl:template match="BugInstance">
+ <xsl:variable name="warningId"><xsl:value-of select="generate-id()"/></xsl:variable>
+
+ <tr class="tablerow{position() mod 2}" onclick="toggleRow('{$warningId}');">
+
+ <td>
+ <span><xsl:attribute name="class">priority-<xsl:value-of select="@priority"/></xsl:attribute>
+ <xsl:value-of select="@abbrev"/>
+ </span>
+ </td>
+
+ <td>
+ <xsl:value-of select="LongMessage"/>
+ </td>
+
+ </tr>
+
+ <!-- Add bug annotation elements: Class, Method, Field, SourceLine, Field -->
+ <tr class="detailrow{position() mod 2}">
+ <td/>
+ <td>
+ <p id="{$warningId}" style="display: none;">
+ <a href="#{@type}">Bug type <xsl:value-of select="@type"/> (click for details)</a>
+ <xsl:for-each select="./*/Message">
+ <br/><xsl:value-of select="text()" disable-output-escaping="no"/>
+ </xsl:for-each>
+ </p>
+ </td>
+ </tr>
+</xsl:template>
+
+<xsl:template match="BugPattern">
+ <h2><a name="{@type}"><xsl:value-of select="@type"/>: <xsl:value-of select="ShortDescription"/></a></h2>
+ <xsl:value-of select="Details" disable-output-escaping="yes"/>
+</xsl:template>
+
+<xsl:template name="generateWarningTable">
+ <xsl:param name="warningSet"/>
+ <xsl:param name="sectionTitle"/>
+ <xsl:param name="sectionId"/>
+
+ <h2><a name="{$sectionId}"><xsl:value-of select="$sectionTitle"/></a></h2>
+ <table class="warningtable" width="100%" cellspacing="0">
+ <xsl:copy-of select="$bugTableHeader"/>
+ <xsl:apply-templates select="$warningSet">
+ <xsl:sort select="@abbrev"/>
+ <xsl:sort select="Class/@classname"/>
+ </xsl:apply-templates>
+ </table>
+</xsl:template>
+
+<xsl:template match="FindBugsSummary">
+ <xsl:variable name="kloc" select="@total_size div 1000.0"/>
+ <xsl:variable name="format" select="'#######0.00'"/>
+
+ <p><xsl:value-of select="@total_size"/> lines of code analyzed,
+ in <xsl:value-of select="@total_classes"/> classes,
+ in <xsl:value-of select="@num_packages"/> packages.</p>
+ <table width="500" cellpadding="5" cellspacing="2">
+ <tr class="tableheader">
+ <th align="left">Metric</th>
+ <th align="right">Total</th>
+ <th align="right">Density*</th>
+ </tr>
+ <tr class="tablerow0">
+ <td>High Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_1"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_1 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+ <tr class="tablerow1">
+ <td>Medium Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_2"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_2 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+
+ <xsl:choose>
+ <xsl:when test="@priority_3">
+ <tr class="tablerow1">
+ <td>Low Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_3"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_3 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+ <xsl:variable name="totalClass" select="tablerow0"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:variable name="totalClass" select="tablerow1"/>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <tr class="$totalClass">
+ <td><b>Total Warnings</b></td>
+ <td align="right"><b><xsl:value-of select="@total_bugs"/></b></td>
+ <xsl:choose>
+ <xsl:when test="number($kloc) > 0.0">
+ <td align="right"><b><xsl:value-of select="format-number(@total_bugs div $kloc, $format)"/></b></td>
+ </xsl:when>
+ <xsl:otherwise>
+ <td align="right"><b><xsl:value-of select="format-number(0.0, $format)"/></b></td>
+ </xsl:otherwise>
+ </xsl:choose>
+ </tr>
+ </table>
+ <p><i>(* Defects per Thousand lines of non-commenting source statements)</i></p>
+ <p><br/><br/></p>
+
+</xsl:template>
+
+</xsl:stylesheet>
+
+<!-- vim:set ts=4: -->
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Copyright (C) 2005, 2006 Etienne Giraudy, InStranet Inc
+ Copyright (C) 2005, 2007 Etienne Giraudy
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+-->
+
+<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0" >
+ <xsl:output
+ method="xml" indent="yes"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
+ doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
+ encoding="UTF-8"/>
+
+ <xsl:variable name="apos" select=""'""/>
+ <xsl:key name="lbc-code-key" match="/BugCollection/BugInstance" use="concat(@category,@abbrev)" />
+ <xsl:key name="lbc-bug-key" match="/BugCollection/BugInstance" use="concat(@category,@abbrev,@type)" />
+ <xsl:key name="lbp-class-b-t" match="/BugCollection/BugInstance" use="concat(Class/@classname,@type)" />
+
+<xsl:template match="/" >
+
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>
+ FindBugs (<xsl:value-of select="/BugCollection/@version" />)
+ Analysis for
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </title>
+ <style type="text/css">
+ html, body, div, form {
+ margin:0px;
+ padding:0px;
+ }
+ body {
+ padding:3px;
+ }
+ a, a:link , a:active, a:visited, a:hover {
+ text-decoration: none; color: black;
+ }
+ #navlist {
+ padding: 3px 0;
+ margin-left: 0;
+ border-bottom: 1px solid #778;
+ font: bold 12px Verdana, sans-serif;
+ }
+ #navlist li {
+ list-style: none;
+ margin: 0;
+ display: inline;
+ }
+ #navlist li a {
+ padding: 3px 0.5em;
+ margin-left: 3px;
+ border: 1px solid #778;
+ border-bottom: none;
+ background: #DDE;
+ text-decoration: none;
+ }
+ #navlist li a:link { color: #448; }
+ #navlist li a:visited { color: #667; }
+ #navlist li a:hover {
+ color: #000;
+ background: #AAE;
+ border-color: #227;
+ }
+ #navlist li a.current {
+ background: white;
+ border-bottom: 1px solid white;
+ }
+ #filterWrapper {
+ margin-bottom:5px;
+ }
+ #displayWrapper {
+ margin-top:5px;
+ }
+ .message {
+ background:#BBBBBB;
+ border: 1px solid #778;
+ }
+ .displayContainer {
+ border:1px solid #555555;
+ margin-top:3px;
+ padding: 3px;
+ display:none;
+ }
+ #summaryContainer table,
+ #historyContainer table {
+ border:1px solid black;
+ }
+ #summaryContainer th,
+ #historyContainer th {
+ background: #aaaaaa;
+ color: white;
+ }
+ #summaryContainer th, #summaryContainer td,
+ #historyContainer th, #historyContainer td {
+ padding: 2px 4px 2px 4px;
+ }
+ .summary-name {
+ background: #eeeeee;
+ text-align:left;
+ }
+ .summary-size {
+ background: #eeeeee;
+ text-align:center;
+ }
+ .summary-priority-all {
+ background: #dddddd;
+ text-align:center;
+ }
+ .summary-priority-1 {
+ background: red;
+ text-align:center;
+ }
+ .summary-priority-2 {
+ background: orange;
+ text-align:center;
+ }
+ .summary-priority-3 {
+ background: green;
+ text-align:center;
+ }
+ .summary-priority-4 {
+ background: blue;
+ text-align:center;
+ }
+
+ .bugList-level1 {
+ margin-bottom:5px;
+ }
+ .bugList-level1, .bugList-level2, .bugList-level3, .bugList-level4 {
+ background-color: #ffffff;
+ margin-left:15px;
+ padding-left:10px;
+ }
+ .bugList-level1-label, .bugList-level2-label, .bugList-level3-label, .bugList-level4-label {
+ background-color: #bbbbbb;
+ border: 1px solid black;
+ padding: 1px 3px 1px 3px;;
+ }
+ .bugList-level2-label, .bugList-level3-label, .bugList-level4-label {
+ border-width: 0px 1px 1px 1px;
+ }
+ .bugList-level4-label {
+ background-color: #ffffff;
+ border: 0px 0px 1px 0px;
+ }
+ .bugList-level4 {
+ border: 0px 1px 1px 1px;
+ }
+
+ .bugList-level4-inner {
+ border-style: solid;
+ border-color: black;
+ border-width: 0px 1px 1px 1px;
+ }
+ .b-r {
+ font-size: 10pt; font-weight: bold; padding: 0 0 0 60px;
+ }
+ .b-d {
+ font-weight: normal; background: #ccccc0;
+ padding: 0 5px 0 5px; margin: 0px;
+ }
+ .b-1 {
+ background: red; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-2 {
+ background: orange; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-3 {
+ background: green; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-4 {
+ background: blue; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+
+ </style>
+ <script type='text/javascript'><xsl:text disable-output-escaping='yes'><![CDATA[
+ var menus = new Array('summary','info','history','listByCategories','listByPackages');
+ var selectedMenuId = "summary";
+ var selectedVersion = -1;
+ var selectedPriority = 4;
+ var lastVersion = 0;
+
+ var bPackageNamesPopulated = false;
+
+ var filterContainerId = "filterWrapper";
+ var messageContainerId = "messageContainer";
+ var summaryContainerId = "summaryContainer";
+ var infoContainerId = "infoContainer";
+ var historyContainerId = "historyContainer";
+ var listByCategoriesContainerId = "listByCategoriesContainer";
+ var listByPackagesContainerId = "listByPackagesContainer";
+
+ var idxCatKey = 0; var idxCatDescr = 1; var idxBugCat = 1;
+ var idxCodeKey = 0; var idxCodeDescr = 1; var idxBugCode = 2;
+ var idxPatternKey = 2; var idxPatternDescr = 3; var idxBugPattern = 3;
+ var idxBugKey = 0; var idxBugDescr = 6;
+ var idxBugClass = 6, idxBugPackage = 7;
+
+ // main init function
+ function init() {
+ loadFilter();
+ selectMenu(selectedMenuId);
+ lastVersion = versions.length - 1;
+ }
+
+ // menu callback function
+ function selectMenu(menuId) {
+ document.getElementById(selectedMenuId).className="none";
+ document.getElementById(menuId).className="current";
+ if (menuId!=selectedMenuId) {
+ hideMenu(selectedMenuId);
+ selectedMenuId = menuId;
+ }
+ if (menuId=="summary") displaySummary();
+ if (menuId=="info") displayInfo();
+ if (menuId=="history") displayHistory();
+ if (menuId=="listByCategories") displayListByCategories();
+ if (menuId=="listByPackages") displayListByPackages();
+ }
+
+ // display filter
+ function loadFilter() {
+ var versionsBox = document.findbugsForm.versions.options;
+ versionsBox[0] = new Option(" -- All Versions -- ","-1");
+ versionsBox.selectedIndex = 0;
+ if (versions.length>=1) {
+ for (x=0; versions.length>1 && x<versions.length; x++) {
+ versionsBox[x+1] = new Option(" Bugs at release: "+versions[versions.length-x-1][1], versions[versions.length-x-1][0]);
+ }
+ }
+
+ var prioritiesBox = document.findbugsForm.priorities.options;
+ prioritiesBox[0] = new Option(" -- All priorities -- ", "4");
+ prioritiesBox[1] = new Option(" P1 bugs ", "1");
+ prioritiesBox[2] = new Option(" P1 and P2 bugs ", "2");
+ prioritiesBox[3] = new Option(" P1, P2 and P3 bugs ", "3");
+ }
+
+ // display a message
+ function displayMessage(msg) {
+ var container = document.getElementById(messageContainerId);
+ container.innerHTML = "<div class='message'>"+msg+"</div>";
+ }
+
+ // reset displayed message
+ function resetMessage() {
+ var container = document.getElementById(messageContainerId);
+ container.innerHTML = "";
+ }
+
+ function hideMenu(menuId) {
+ var container = menuId+"Container";
+ document.getElementById(container).style.display="none";
+ }
+
+ // filter callback function
+ function filter() {
+ var versionsBox = document.findbugsForm.versions.options;
+ selectedVersion = versionsBox[versionsBox.selectedIndex].value;
+
+ var prioritiesBox = document.findbugsForm.priorities.options;
+ selectedPriority = prioritiesBox[prioritiesBox.selectedIndex].value;
+
+ selectMenu(selectedMenuId);
+ }
+
+ // display summary tab
+ function displaySummary() {
+ resetMessage();
+ hide(filterContainerId);
+ var container = document.getElementById(summaryContainerId);
+ container.style.display="block";
+ }
+
+ // display info tab
+ function displayInfo() {
+ resetMessage();
+ hide(filterContainerId);
+ var container = document.getElementById(infoContainerId);
+ container.style.display="block";
+ }
+
+ // display history tab
+ function displayHistory() {
+ displayMessage("Loading history...");
+ hide(filterContainerId);
+ var container = document.getElementById(historyContainerId);
+ var content = "";
+ var i=0;
+ var p = [0,0,0,0,0];
+ var f = [0,0,0,0,0];
+
+ content += "<table><tr><th>Release</th><th>Bugs</th><th>Bugs p1</th><th>Bugs p2</th><th>Bugs p3</th><th>Bugs Exp.</th></tr>";
+
+ for (i=(versions.length-1); i>0; i--) {
+ v = countBugsVersion(i, 4);
+ t = countTotalBugsVersion(i);
+ o = countFixedButActiveBugsVersion(i);
+ f = countFixedBugsInVersion(i);
+ content += "<tr>";
+ content += "<td class='summary-name'>" + versions[i][1] + "</td>";
+ content += "<td class='summary-priority-all'> " + (t[0] + o[0]) + " (+" + v[0] + " / -" + f[0] + ") </td>";
+ content += "<td class='summary-priority-1' > " + (t[1] + o[1]) + " (+" + v[1] + " / -" + f[1] + ") </td>";
+ content += "<td class='summary-priority-2' > " + (t[2] + o[2]) + " (+" + v[2] + " / -" + f[2] + ") </td>";
+ content += "<td class='summary-priority-3' > " + (t[3] + o[3]) + " (+" + v[3] + " / -" + f[3] + ") </td>";
+ content += "<td class='summary-priority-4' > " + (t[4] + o[4]) + " (+" + v[4] + " / -" + f[4] + ") </td>";
+ content += "</tr>";
+ }
+
+ t = countTotalBugsVersion(0);
+ o = countFixedButActiveBugsVersion(0);
+ content += "<tr>";
+ content += "<td class='summary-name'>" + versions[0][1] + "</td>";
+ content += "<td class='summary-priority-all'> " + (t[0] + o[0]) + " </td>";
+ content += "<td class='summary-priority-1' > " + (t[1] + o[1]) + " </td>";
+ content += "<td class='summary-priority-2' > " + (t[2] + o[2]) + " </td>";
+ content += "<td class='summary-priority-3' > " + (t[3] + o[3]) + " </td>";
+ content += "<td class='summary-priority-4' > " + (t[4] + o[4]) + " </td>";
+ content += "</tr>";
+
+ content += "</table>";
+ container.innerHTML = content;
+ container.style.display="block";
+ resetMessage();
+ }
+
+ // display list by cat tab
+ function displayListByCategories() {
+ show(filterContainerId);
+ var container = document.getElementById(listByCategoriesContainerId);
+ container.innerHTML = "";
+ container.style.display="block";
+ displayMessage("Loading stats (categories)...");
+ container.innerHTML = displayLevel1("lbc", "Stats by Bug Categories");
+ resetMessage();
+ }
+
+ // display list by package tab
+ function displayListByPackages() {
+ show(filterContainerId);
+ var container = document.getElementById(listByPackagesContainerId);
+ container.style.display="block";
+ if (!bPackageNamesPopulated) {
+ displayMessage("Initializing...");
+ populatePackageNames();
+ }
+ displayMessage("Loading stats (packages)...");
+ container.innerHTML = displayLevel1("lbp", "Stats by Bug Package");
+ resetMessage();
+ }
+
+ // callback function for list item click
+ function toggleList(listType, containerId, id1, id2, id3) {
+ var container = document.getElementById(containerId);
+ if (container.style.display=="block") {
+ container.style.display="none";
+ } else {
+ if (listType=="lbc") {
+ if (id1.length>0 && id2.length==0 && id3.length==0) {
+ displayCategoriesCodes(containerId, id1);
+ } else if (id1.length>0 && id2.length>0 && id3.length==0) {
+ displayCategoriesCodesPatterns(containerId, id1, id2);
+ } else if (id1.length>0 && id2.length>0 && id3.length>0) {
+ displayCategoriesCodesPatternsBugs(containerId, id1, id2, id3);
+ } else {
+ // ???
+ }
+ } else if (listType=="lbp") {
+ if (id1.length>0 && id2.length==0 && id3.length==0) {
+ displayPackageCodes(containerId, id1);
+ } else if (id1.length>0 && id2.length>0 && id3.length==0) {
+ displayPackageClassPatterns(containerId, id1, id2);
+ } else if (id1.length>0 && id2.length>0 && id3.length>0) {
+ displayPackageClassPatternsBugs(containerId, id1, id2, id3);
+ } else {
+ // ???
+ }
+ } else {
+ // ????
+ }
+ }
+ }
+
+ // list by categories, display bug cat>codes
+ function displayCategoriesCodes(containerId, catId) {
+ displayMessage("Loading stats (codes)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="") {
+ container.innerHTML = displayLevel2("lbc", catId);
+ }
+ resetMessage();
+ }
+
+ // list by categories, display bug package>codes
+ function displayPackageCodes(containerId, packageId) {
+ displayMessage("Loading stats (codes)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="") {
+ container.innerHTML = displayLevel2("lbp", packageId);
+ }
+ resetMessage();
+ }
+
+ // list by categories, display bug cat>codes>patterns
+ function displayCategoriesCodesPatterns(containerId, catId, codeId) {
+ displayMessage("Loading stats (patterns)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="")
+ container.innerHTML = displayLevel3("lbc", catId, codeId);
+ resetMessage();
+ }
+
+ // list by package, display bug package>class>patterns
+ function displayPackageClassPatterns(containerId, packageId, classId) {
+ displayMessage("Loading stats (patterns)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="")
+ container.innerHTML = displayLevel3("lbp", packageId, classId);
+ resetMessage();
+ }
+
+ // list by categories, display bug cat>codes>patterns>bugs
+ function displayCategoriesCodesPatternsBugs(containerId, catId, codeId, patternId) {
+ displayMessage("Loading stats (bugs)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="")
+ container.innerHTML = displayLevel4("lbc", catId, codeId, patternId);
+ resetMessage();
+ }
+
+ // list by package, display bug package>class>patterns>bugs
+ function displayPackageClassPatternsBugs(containerId, packageId, classId, patternId) {
+ displayMessage("Loading stats (bugs)...");
+ var container = document.getElementById(containerId);
+ container.style.display="block";
+ if (container.innerHTML=="Loading..." || container.innerHTML=="")
+ container.innerHTML = displayLevel4("lbp", packageId, classId, patternId);
+ resetMessage();
+ }
+
+ // generate level 1 list
+ function displayLevel1(list, title) {
+ var content = "";
+ var content2 = "";
+
+ content += "<h3>"+title+"</h3>";
+ content += getPriorityLegend();
+ content2 += "<div class='bugList'>";
+
+ var id = "";
+ var containerId = "";
+ var subContainerId = "";
+ var prefixSub = "";
+ var prefixId = "";
+ var p = [0,0,0,0,0];
+ var numberOfBugs = 0;
+ var label = "";
+ var max = 0;
+ if (list=="lbc") {
+ max = categories.length;
+ } else if (list=="lbp") {
+ max = packageStats.length;
+ }
+
+ for (var x=0; x<max -1; x++) {
+ if (list=="lbp" && packageStats[x][1]=="0") continue;
+
+ if (list=="lbc") {
+ id = categories[x][idxCatKey];
+ label = categories[x][idxCatDescr];
+ containerId = "categories-" + id;
+ subContainerId = "cat-"+id;
+ p = countBugsCat(selectedVersion, selectedPriority, id, idxBugCat);
+ }
+ if (list=="lbp") {
+ id = packageStats[x][0];
+ label = packageStats[x][0];
+ containerId = "packages-" + id;
+ subContainerId = "package-"+id;
+ p = countBugsPackage(selectedVersion, selectedPriority, id, idxBugPackage);
+ }
+
+ subContainerId = prefixSub+id;
+
+ var total = p[1]+p[2]+p[3]+p[4];
+ if (total > 0) {
+ content2 += addListItem( 1, containerId, label, total, p, subContainerId,
+ "toggleList('" + list + "', '" + subContainerId + "', '"+ id + "', '', '')"
+ );
+ }
+ numberOfBugs += total;
+ }
+ content2 += "</div>";
+ content += "<h4>Total number of bugs";
+ if (selectedVersion!=-1) {
+ content += " (introduced in release " + versions[selectedVersion][1] +")";
+ }
+ content += ": "+numberOfBugs+"</h4>";
+ return content+content2;
+ }
+
+ // generate level 2 list
+ function displayLevel2(list, id1) {
+ var content = "";
+ var code = "";
+ var containerId = "";
+ var subContainerId = "";
+ var p = [0,0,0,0,0];
+ var max = 0;
+ var id2 = "";
+ if (list=="lbc") {
+ max = codes.length;
+ } else if (list=="lbp") {
+ max = classStats.length;
+ }
+
+ for (var x=0; x<max -1; x++) {
+ if (list=="lbp" && classStats[x][3]=="0") continue;
+
+ if (list=="lbc") {
+ id2 = codes[x][idxCodeKey];
+ label = codes[x][idxCodeDescr];
+ containerId = "codes-"+id1;
+ subContainerId = "cat-" + id1 + "-code-" + id2;
+ p = countBugsCode(selectedVersion, selectedPriority, id1, idxBugCat, id2, idxBugCode);
+ }
+ if (list=="lbp") {
+ id2 = classStats[x][0];
+ label = classStats[x][0];
+ containerId = "packages-"+id1;
+ subContainerId = "package-" + id1 + "-class-" + id2;
+ p = countBugsClass(selectedVersion, selectedPriority, id1, idxBugPackage, id2, idxBugClass);
+ }
+
+ var total = p[1]+p[2]+p[3]+p[4];
+ if (total > 0) {
+ content += addListItem( 2, containerId, label, total, p, subContainerId,
+ "toggleList('"+ list + "', '" + subContainerId + "', '"+ id1 + "', '"+ id2 + "', '')"
+ );
+ }
+ }
+ return content;
+ }
+
+ // generate level 3 list
+ function displayLevel3(list, id1, id2) {
+ var content = "";
+ var containerId = "";
+ var subContainerId = "";
+ var p = [0,0,0,0,0];
+ var max = 0;
+ var label = "";
+ var id3 = "";
+
+ if (list=="lbc") {
+ max = patterns.length;
+ } else if (list=="lbp") {
+ max = patterns.length;
+ }
+
+ for (var x=0; x<max -1; x++) {
+ //if (list=="lbp" && (patterns[x][0]!=id1 || patterns[x][1]!=id2)) continue;
+ //if (list=="lbp" && classStats[x][3]=="0") continue;
+
+ if (list=="lbc") {
+ id3 = patterns[x][idxPatternKey];;
+ label = patterns[x][idxPatternDescr];
+ containerId = "patterns-"+id1;
+ subContainerId = "cat-" + id1 + "-code-" + id2 + "-pattern-" + id3;
+ p = countBugsPattern(selectedVersion, selectedPriority, id1, idxBugCat, id2, idxBugCode, id3, idxBugPattern);
+ }
+ if (list=="lbp") {
+ id3 = patterns[x][idxPatternKey];;
+ label = patterns[x][idxPatternDescr];
+ containerId = "classpatterns-"+id1;
+ subContainerId = "package-" + id1 + "-class-" + id2 + "-pattern-" + id3;
+ p = countBugsClassPattern(selectedVersion, selectedPriority, id2, idxBugClass, id3, idxBugPattern);
+ }
+
+ var total = p[1]+p[2]+p[3]+p[4];
+ if (total > 0) {
+ content += addListItem( 3, containerId, label, total, p, subContainerId,
+ "toggleList('" + list + "', '" + subContainerId + "', '"+ id1 + "', '"+ id2 + "', '"+ id3 + "')"
+ );
+ }
+ }
+ return content;
+ }
+
+ // generate level 4 list
+ function displayLevel4(list, id1, id2, id3) {
+ var content = "";
+ var bug = "";
+ var bugP = 0;
+ var containerId = "";
+ var subContainerId = "";
+ var bugId = "";
+ var label = "";
+ var p = [0,0,0,0,0];
+ for (var x=0; x<bugs.length -1; x++) {
+ bug = bugs[x];
+ if (list=="lbc") {
+ if ( bug[1]!=id1 || bug[2]!=id2 || bug[3]!=id3 ) continue;
+ if ( selectedVersion!=-1
+ && selectedVersion!=bug[5]) continue;
+ if ( selectedPriority!=4
+ && selectedPriority<bug[4]) continue;
+
+ subContainerId = "cat-" + id1 + "-code-" + id2 + "-pattern-" + id3 + "-bug-" + bug[0];
+ }
+ if (list=="lbp") {
+ if ( bug[7]!=id1 || bug[6]!=id2 || bug[3]!=id3 ) continue;
+ if ( selectedVersion!=-1
+ && selectedVersion!=bug[5]) continue;
+ if ( selectedPriority!=4
+ && selectedPriority<bug[4]) continue;
+
+ subContainerId = "package-" + id1 + "-class-" + id2 + "-pattern-" + id3 + "-bug-" + bug[0];
+ }
+
+ bugId = "b-uid-" + bug[0];
+ label = bug[idxBugDescr];
+ containerId = "bugs-"+bugId;
+ bugP = bug[4];
+ p[bugP]++;
+ var total = p[1]+p[2]+p[3]+p[4];
+ if (total > 0) {
+ content += addBug( 4, containerId, label, bugP, bug[5], subContainerId,
+ "showbug('" + bugId + "', '" + subContainerId + "', '"+id3+"')");
+ }
+ }
+ return content;
+ }
+
+
+ function addListItem(level, id, label, total, p, subId, onclick) {
+ var content = "";
+
+ content += "<div class='bugList-level"+level+"' >";
+ content += "<div class='bugList-level"+level+"-label' id='"+id+"' >";
+ content += "<a href='' onclick=\"" + onclick + ";return false;\" ";
+ content += ">";
+ content += "<strong>"+label+"</strong>";
+ content += " "+total+" bugs";
+ if (selectedPriority>1)
+ content += " <em>("+p[1];
+ if (selectedPriority>=2)
+ content += "/"+p[2];
+ if (selectedPriority>=3)
+ content += "/"+p[3];
+ if (selectedPriority>=4)
+ content += "/"+p[4];
+ if (selectedPriority>1)
+ content += ")</em>";
+ content += "</a>";
+ content += "</div>";
+ content += "<div class='bugList-level"+level+"-inner' id='"+subId+"' style='display:none;'>Loading...</div>";
+ content += "</div>";
+ return content;
+ }
+
+ function addBug( level, id, label, p, version, subId, onclick) {
+ var content = "";
+
+ content += "<div class='bugList-level" + level + "' id='" + id + "'>";
+ content += "<div class='bugList-level" + level + "-label' id='" + id + "'>";
+ content += "<span class='b-" + p + "'> </span>";
+ content += "<a href='' onclick=\"" + onclick + ";return false;\">";
+ if (version==lastVersion) {
+ content += "<span style='color:red;font-weight:bold;'>NEW!</span> ";
+ }
+ content += "<strong>" + label + "</strong>";
+ if (version==0) {
+ content += " <em>since release first historized release</em>";
+ } else {
+ content += " <em>since release " + versions[version][1] + "</em>";
+ }
+ content += "</a>";
+ content += "</div>";
+ content += "<div class='bugList-level" + level + "-inner' id='" + subId + "' style='display:none;'>Loading...</div>";
+ content += "</div>";
+ return content;
+ }
+
+ function countBugsVersion(version, priority) {
+ return countBugs(version, priority, "", -1, "", -1, "", -1, "", -1, "", -1);
+ }
+
+ function countBugsCat(version, priority, cat, idxCat) {
+ return countBugs(version, priority, cat, idxCat, "", -1, "", -1, "", -1, "", -1);
+ }
+
+ function countBugsPackage(version, priority, packageId, idxPackage) {
+ return countBugs(version, priority, "", -1, "", -1, "", -1, packageId, idxPackage, "", -1);
+ }
+
+ function countBugsCode(version, priority, cat, idxCat, code, idxCode) {
+ return countBugs(version, priority, cat, idxCat, code, idxCode, "", -1, "", -1, "", -1);
+ }
+
+ function countBugsPattern(version, priority, cat, idxCat, code, idxCode, packageId, idxPattern) {
+ return countBugs(version, priority, cat, idxCat, code, idxCode, packageId, idxPattern, "", -1, "", -1);
+ }
+
+ function countBugsClass(version, priority, id1, idxBugPackage, id2, idxBugClass) {
+ return countBugs(version, priority, "", -1, "", -1, "", -1, id1, idxBugPackage, id2, idxBugClass);
+ }
+
+ function countBugsClassPattern(version, priority, id2, idxBugClass, id3, idxBugPattern) {
+ return countBugs(version, priority, "", -1, "", -1, id3, idxBugPattern, "", -1, id2, idxBugClass);
+ }
+
+ function countBugs(version, priority, cat, idxCat, code, idxCode, pattern, idxPattern, packageId, idxPackage, classId, idxClass) {
+ var count = [0,0,0,0,0];
+ var last=1000000;
+ for (var x=0; x<bugs.length-1; x++) {
+ var bug = bugs[x];
+
+ var bugCat = bug[idxCat];
+ var bugP = bug[4];
+ var bugCode = bug[idxCode];
+ var bugPattern = bug[idxPattern];
+
+ if ( (version==-1 || version==bug[5])
+ && (priority==4 || priority>=bug[4])
+ && (idxCat==-1 || bug[idxCat]==cat)
+ && (idxCode==-1 || bug[idxCode]==code)
+ && (idxPattern==-1 || bug[idxPattern]==pattern)
+ && (idxPackage==-1 || bug[idxPackage]==packageId)
+ && (idxClass==-1 || bug[idxClass]==classId)
+ ) {
+ count[bug[4]]++;
+ }
+ }
+ count[0] = count[1] + count[2] + count[3] + count[4];
+ return count;
+ }
+
+ function countFixedBugsInVersion(version) {
+ var count = [0,0,0,0,0];
+ var last=1000000;
+ for (var x=0; x<fixedBugs.length-1; x++) {
+ var bug = fixedBugs[x];
+
+ var bugP = bug[4];
+
+ if ( version==-1 || version==(bug[6]+1)) {
+ count[bug[4]]++;
+ }
+ }
+ count[0] = count[1] + count[2] + count[3] + count[4];
+ return count;
+ }
+
+ function countFixedButActiveBugsVersion(version) {
+ var count = [0,0,0,0,0];
+ var last=1000000;
+ for (var x=0; x<fixedBugs.length-1; x++) {
+ var bug = fixedBugs[x];
+
+ var bugP = bug[4];
+
+ if ( version==-1 || (version >=bug[5] && version<=bug[6]) ) {
+ count[bug[4]]++;
+ }
+ }
+ count[0] = count[1] + count[2] + count[3] + count[4];
+ return count;
+ }
+
+ function countTotalBugsVersion(version) {
+ var count = [0,0,0,0,0];
+ var last=1000000;
+ for (var x=0; x<bugs.length-1; x++) {
+ var bug = bugs[x];
+
+ var bugP = bug[4];
+
+ if (version==-1 || version>=bug[5]) {
+ count[bug[4]]++;
+ }
+ }
+ count[0] = count[1] + count[2] + count[3] + count[4];
+ return count;
+ }
+
+ function getPriorityLegend() {
+ var content = "";
+ content += "<h5><span class='b-1'> </span> P1 ";
+ content += "<span class='b-2'> </span> P2 ";
+ content += "<span class='b-3'> </span> P3 ";
+ content += "<span class='b-4'> </span> Exp ";
+ content += "</h5>";
+ return content;
+ }
+
+ function populatePackageNames() {
+ for (var i=0; i<bugs.length; i++) {
+ var classId = bugs[i][6];
+ var idx = classId.lastIndexOf('.');
+ var packageId = "";
+
+ if (idx>0) {
+ packageId = classId.substring(0, idx);
+ }
+
+ bugs[i][7] = packageId;
+ }
+ }
+
+ function showbug(bugId, containerId, patternId) {
+ var bugplaceholder = document.getElementById(containerId);
+ var bug = document.getElementById(bugId);
+
+ if ( bugplaceholder==null) {
+ alert(buguid+'-ph-'+list+' - '+buguid+' - bugplaceholder==null');
+ return;
+ }
+ if ( bug==null) {
+ alert(buguid+'-ph-'+list+' - '+buguid+' - bug==null');
+ return;
+ }
+
+ var newBug = bug.innerHTML;
+ var pattern = document.getElementById('tip-'+patternId).innerHTML;
+ toggle(containerId);
+ bugplaceholder.innerHTML = newBug + pattern;
+ }
+ function toggle(foo) {
+ if( document.getElementById(foo).style.display == "none") {
+ show(foo);
+ } else {
+ if( document.getElementById(foo).style.display == "block") {
+ hide(foo);
+ } else {
+ show(foo);
+ }
+ }
+ }
+ function show(foo) {
+ document.getElementById(foo).style.display="block";
+ }
+ function hide(foo) {
+ document.getElementById(foo).style.display="none";
+ }
+
+ window.onload = function(){
+ init();
+ };
+ ]]></xsl:text></script>
+ <script type='text/javascript'>
+ // versions fields: release id, release label
+ var versions = new Array(
+ <xsl:for-each select="/BugCollection/History/AppVersion">
+ [ "<xsl:value-of select="@sequence" />", "<xsl:value-of select="@release" />" ],
+ </xsl:for-each>
+ [ "<xsl:value-of select="/BugCollection/@sequence" />", "<xsl:value-of select="/BugCollection/@release" />" ]
+ );
+
+ // categories fields: category id, category label
+ var categories = new Array(
+ <xsl:for-each select="/BugCollection/BugCategory">
+ <xsl:sort select="@category" order="ascending" />
+ [ "<xsl:value-of select="@category" />", "<xsl:value-of select="Description" />" ],
+ </xsl:for-each>
+ [ "", "" ]
+ );
+
+ // codes fields: code id, code label
+ var codes = new Array(
+ <xsl:for-each select="/BugCollection/BugCode">
+ <xsl:sort select="@abbrev" order="ascending" />
+ [ "<xsl:value-of select="@abbrev" />", "<xsl:value-of select="Description" />" ],
+ </xsl:for-each>
+ [ "", "" ]
+ );
+
+ // patterns fields: category id, code id, pattern id, pattern label
+ var patterns = new Array(
+ <xsl:for-each select="/BugCollection/BugPattern">
+ <xsl:sort select="@type" order="ascending" />
+ [ "<xsl:value-of select="@category" />", "<xsl:value-of select="@abbrev" />", "<xsl:value-of select="@type" />", "<xsl:value-of select="translate(ShortDescription, '"', $apos)" />" ],
+
+ </xsl:for-each>
+ [ "", "", "", "" ]
+ );
+
+ // class stats fields: class name, package name, isInterface, total bugs, bugs p1, bugs p2, bugs p3, bugs p4
+ var classStats = new Array(
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats/ClassStats">
+ <xsl:sort select="@class" order="ascending" />
+ [ "<xsl:value-of select="@class" />", "<xsl:value-of select="../@package" />", "<xsl:value-of select="@interface" />", "<xsl:value-of select="@bugs" />", "<xsl:value-of select="@priority_1" />", "<xsl:value-of select="@priority_2" />", "<xsl:value-of select="@priority_3" />", "<xsl:value-of select="@priority_4" />" ],
+ </xsl:for-each>
+ [ "", "", "", "", "", "", "", "" ]
+ );
+
+ // package stats fields: package name, total bugs, bugs p1, bugs p2, bugs p3, bugs p4
+ var packageStats = new Array(
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats">
+ <xsl:sort select="@package" order="ascending" />
+ [ "<xsl:value-of select="@package" />", "<xsl:value-of select="@total_bugs" />", "<xsl:value-of select="@priority_1" />", "<xsl:value-of select="@priority_2" />", "<xsl:value-of select="@priority_3" />", "<xsl:value-of select="@priority_4" />" ],
+ </xsl:for-each>
+ [ "", "", "", "", "", "" ]
+ );
+
+
+ // bugs fields: bug id, category id, code id, pattern id, priority, release id, class name, packagename (populated by javascript)
+ var bugs = new Array(
+ <xsl:for-each select="/BugCollection/BugInstance[string-length(@last)=0]">
+
+ [ "<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" />",
+ "<xsl:value-of select="@category" />",
+ "<xsl:value-of select="@abbrev" />",
+ "<xsl:value-of select="@type" />",
+ <xsl:value-of select="@priority" />,
+ <xsl:choose><xsl:when test='string-length(@first)=0'>0</xsl:when><xsl:otherwise><xsl:value-of select="@first" /></xsl:otherwise></xsl:choose>,
+ "<xsl:value-of select="Class/@classname" />",
+ ""],
+ </xsl:for-each>
+ [ "", "", "", "", 0, 0, "", "" ]
+ );
+
+ // bugs fields: bug id, category id, code id, pattern id, priority, first release id, fixed release id, class name
+ var fixedBugs = new Array(
+ <xsl:for-each select="/BugCollection/BugInstance[string-length(@last)>0]">
+
+ [ "<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" />",
+ "<xsl:value-of select="@category" />",
+ "<xsl:value-of select="@abbrev" />",
+ "<xsl:value-of select="@type" />",
+ <xsl:value-of select="@priority" />,
+ <xsl:choose><xsl:when test='string-length(@first)=0'>0</xsl:when><xsl:otherwise><xsl:value-of select="@first" /></xsl:otherwise></xsl:choose>,
+ <xsl:choose><xsl:when test='string-length(@last)>0'><xsl:value-of select="@last" /></xsl:when><xsl:otherwise>-42</xsl:otherwise></xsl:choose>,
+ "<xsl:value-of select="Class/@classname" />" ],
+ </xsl:for-each>
+ [ "", "", "", "", 0, 0, 0, "" ]
+ );
+
+ </script>
+ </head>
+ <body>
+ <h3>
+ <a href="http://findbugs.sourceforge.net">FindBugs</a> (<xsl:value-of select="/BugCollection/@version" />)
+ Analysis for
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </h3>
+
+ <div id='menuWrapper' style=''>
+ <div id="navcontainer">
+ <ul id="navlist">
+ <li><a id='summary' class="current" href="#" onclick="selectMenu('summary'); return false;" >Summary</a></li>
+ <li><a id='history' class="none" href="#" onclick="selectMenu('history'); return false;" >History</a></li>
+ <li><a id='listByCategories' class="none" href="#" onclick="selectMenu('listByCategories'); return false;">Browse By Categories</a></li>
+ <li><a id='listByPackages' class="none" href="#" onclick="selectMenu('listByPackages'); return false;" >Browse by Packages</a></li>
+ <li><a id='info' class="none" href="#" onclick="selectMenu('info'); return false;" >Info</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div id='displayWrapper'>
+
+ <div style='height:25px;'>
+ <div id='messageContainer' style='float:right;'>
+ Computing data...
+ </div>
+ <div id='filterWrapper' style='display:none;'>
+ <form name='findbugsForm'>
+ <div id='filterContainer' >
+ <select name='versions' onchange='filter()'>
+ <option value="loading">Loading filter...</option>
+ </select>
+ <select name='priorities' onchange='filter()'>
+ <option value="loading">Loading filter...</option>
+ </select>
+ </div>
+ </form>
+ </div>
+ </div>
+ <div id='summaryContainer' class='displayContainer'>
+ <h3>Package Summary</h3>
+ <table>
+ <tr>
+ <th>Package</th>
+ <th>Code Size</th>
+ <th>Bugs</th>
+ <th>Bugs p1</th>
+ <th>Bugs p2</th>
+ <th>Bugs p3</th>
+ <th>Bugs Exp.</th>
+ </tr>
+ <tr>
+ <td class='summary-name'>
+ Overall
+ (<xsl:value-of select="/BugCollection/FindBugsSummary/@num_packages" /> packages),
+ (<xsl:value-of select="/BugCollection/FindBugsSummary/@total_classes" /> classes)
+ </td>
+ <td class='summary-size'><xsl:value-of select="/BugCollection/FindBugsSummary/@total_size" /></td>
+ <td class='summary-priority-all'><xsl:value-of select="/BugCollection/FindBugsSummary/@total_bugs" /></td>
+ <td class='summary-priority-1'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_1" /></td>
+ <td class='summary-priority-2'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_2" /></td>
+ <td class='summary-priority-3'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_3" /></td>
+ <td class='summary-priority-4'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_4" /></td>
+ </tr>
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats">
+ <xsl:sort select="@package" order="ascending" />
+ <xsl:if test="@total_bugs!='0'" >
+ <tr>
+ <td class='summary-name'><xsl:value-of select="@package" /></td>
+ <td class='summary-size'><xsl:value-of select="@total_size" /></td>
+ <td class='summary-priority-all'><xsl:value-of select="@total_bugs" /></td>
+ <td class='summary-priority-1'><xsl:value-of select="@priority_1" /></td>
+ <td class='summary-priority-2'><xsl:value-of select="@priority_2" /></td>
+ <td class='summary-priority-3'><xsl:value-of select="@priority_3" /></td>
+ <td class='summary-priority-4'><xsl:value-of select="@priority_4" /></td>
+ </tr>
+ </xsl:if>
+ </xsl:for-each>
+ </table>
+ </div>
+
+ <div id='infoContainer' class='displayContainer'>
+ <div id='analyzed-files'>
+ <h3>Analyzed Files:</h3>
+ <ul>
+ <xsl:for-each select="/BugCollection/Project/Jar">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ </ul>
+ </div>
+ <div id='used-libraries'>
+ <h3>Used Libraries:</h3>
+ <ul>
+ <xsl:for-each select="/BugCollection/Project/AuxClasspathEntry">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ <xsl:if test="count(/BugCollection/Project/AuxClasspathEntry)=0" >
+ <li>None</li>
+ </xsl:if>
+ </ul>
+ </div>
+ <div id='analysis-error'>
+ <h3>Analysis Errors:</h3>
+ <ul>
+ <xsl:variable name="error-count"
+ select="count(/BugCollection/Errors/MissingClass)" />
+ <xsl:if test="$error-count=0" >
+ <li>None</li>
+ </xsl:if>
+ <xsl:if test="$error-count>0" >
+ <li>Missing ref classes for analysis:
+ <ul>
+ <xsl:for-each select="/BugCollection/Errors/MissingClass">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ </ul>
+ </li>
+ </xsl:if>
+ </ul>
+ </div>
+ </div>
+ <div id='historyContainer' class='displayContainer'>Loading...</div>
+ <div id='listByCategoriesContainer' class='displayContainer'>Loading...</div>
+ <div id='listByPackagesContainer' class='displayContainer'>Loading...</div>
+ </div>
+
+ <div id='bug-collection' style='display:none;'>
+ <!-- advanced tooltips -->
+ <xsl:for-each select="/BugCollection/BugPattern">
+ <xsl:variable name="b-t"><xsl:value-of select="@type" /></xsl:variable>
+ <div>
+ <xsl:attribute name="id">tip-<xsl:value-of select="$b-t" /></xsl:attribute>
+ <xsl:attribute name="class">tip</xsl:attribute>
+ <xsl:value-of select="/BugCollection/BugPattern[@type=$b-t]/Details" disable-output-escaping="yes" />
+ </div>
+ </xsl:for-each>
+
+ <!-- bug descriptions - hidden -->
+ <xsl:for-each select="/BugCollection/BugInstance">
+ <div style="display:none;" class='bug'>
+ <xsl:attribute name="id">b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" /></xsl:attribute>
+ <xsl:for-each select="*/Message">
+ <div class="b-r"><xsl:apply-templates /></div>
+ </xsl:for-each>
+ <div class="b-d">
+ <xsl:value-of select="LongMessage" disable-output-escaping="no" />
+ </div>
+ </div>
+ </xsl:for-each>
+ </div>
+ </body>
+</html>
+</xsl:template>
+
+
+</xsl:transform>
+
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Copyright (C) 2005, 2006 Etienne Giraudy, InStranet Inc
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+-->
+
+<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0" >
+ <xsl:output
+ method="xml" indent="yes"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ encoding="UTF-8"/>
+
+ <!--
+ Parameter for specifying HTMLized sources location; if current dir, use "./"
+ If not passed, no links to sources are generated.
+ because of back-compatibility reasons.
+ The source filename should be package.class.java.html
+ The source can have line no anchors like #11 -->
+ <xsl:param name="htmlsrcpath"></xsl:param>
+
+ <!--xsl:key name="lbc-category-key" match="/BugCollection/BugInstance" use="@category" /-->
+ <xsl:key name="lbc-code-key" match="/BugCollection/BugInstance" use="concat(@category,@abbrev)" />
+ <xsl:key name="lbc-bug-key" match="/BugCollection/BugInstance" use="concat(@category,@abbrev,@type)" />
+ <xsl:key name="lbp-class-b-t" match="/BugCollection/BugInstance" use="concat(Class/@classname,@type)" />
+
+<xsl:template match="/" >
+
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>
+ FindBugs (<xsl:value-of select="/BugCollection/@version" />)
+ Analysis for
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </title>
+ <script type="text/javascript">
+ function show(foo) {
+ document.getElementById(foo).style.display="block";
+ }
+ function hide(foo) {
+ document.getElementById(foo).style.display="none";
+ }
+ function toggle(foo) {
+ if( document.getElementById(foo).style.display == "none") {
+ show(foo);
+ } else {
+ if( document.getElementById(foo).style.display == "block") {
+ hide(foo);
+ } else {
+ show(foo);
+ }
+ }
+ }
+
+ function showmenu(foo) {
+ if( document.getElementById(foo).style.display == "none") {
+ hide("bug-summary");
+ document.getElementById("bug-summary-tab").className="menu-tab";
+ hide("analysis-data");
+ document.getElementById("analysis-data-tab").className="menu-tab";
+ //hide("list-by-b-t");
+ //document.getElementById("list-by-b-t-tab").className="menu-tab";
+ hide("list-by-package");
+ document.getElementById("list-by-package-tab").className="menu-tab";
+ hide("list-by-category");
+ document.getElementById("list-by-category-tab").className="menu-tab";
+ document.getElementById(foo+"-tab").className="menu-tab-selected";
+ show(foo);
+
+ }
+ // else menu already selected!
+ }
+ function showbug(buguid, list) {
+ var bugplaceholder = document.getElementById(buguid+'-ph-'+list);
+ var bug = document.getElementById(buguid);
+
+ if ( bugplaceholder==null) {
+ alert(buguid+'-ph-'+list+' - '+buguid+' - bugplaceholder==null');
+ return;
+ }
+ if ( bug==null) {
+ alert(buguid+'-ph-'+list+' - '+buguid+' - bug==null');
+ return;
+ }
+
+ var oldBug = bugplaceholder.innerHTML;
+ var newBug = bug.innerHTML;
+ //alert(oldBug);
+ //alert(newBug);
+ toggle(buguid+'-ph-'+list);
+ bugplaceholder.innerHTML = newBug;
+ }
+ </script>
+ <script type='text/javascript'><xsl:text disable-output-escaping='yes'><![CDATA[
+ // Extended Tooltip Javascript
+ // copyright 9th August 2002, 3rd July 2005
+ // by Stephen Chapman, Felgall Pty Ltd
+
+ // permission is granted to use this javascript provided that the below code is not altered
+ var DH = 0;var an = 0;var al = 0;var ai = 0;if (document.getElementById) {ai = 1; DH = 1;}else {if (document.all) {al = 1; DH = 1;} else { browserVersion = parseInt(navigator.appVersion); if (navigator.appName.indexOf('Netscape') != -1) if (browserVersion == 4) {an = 1; DH = 1;}}}
+ function fd(oi, wS) {if (ai) return wS ? document.getElementById(oi).style:document.getElementById(oi); if (al) return wS ? document.all[oi].style: document.all[oi]; if (an) return document.layers[oi];}
+ function pw() {return window.innerWidth != null? window.innerWidth: document.body.clientWidth != null? document.body.clientWidth:null;}
+ function mouseX(evt) {if (evt.pageX) return evt.pageX; else if (evt.clientX)return evt.clientX + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft); else return null;}
+ function mouseY(evt) {if (evt.pageY) return evt.pageY; else if (evt.clientY)return evt.clientY + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop); else return null;}
+ function popUp(evt,oi) {if (DH) {var wp = pw(); ds = fd(oi,1); dm = fd(oi,0); st = ds.visibility; if (dm.offsetWidth) ew = dm.offsetWidth; else if (dm.clip.width) ew = dm.clip.width; if (st == "visible" || st == "show") { ds.visibility = "hidden"; } else {tv = mouseY(evt) + 20; lv = mouseX(evt) - (ew/4); if (lv < 2) lv = 2; else if (lv + ew > wp) lv -= ew/2; if (!an) {lv += 'px';tv += 'px';} ds.left = lv; ds.top = tv; ds.visibility = "visible";}}}
+ ]]></xsl:text></script>
+ <style type='text/css'>
+ html, body {
+ background-color: #ffffff;
+ }
+ a, a:link , a:active, a:visited, a:hover {
+ text-decoration: none; color: black;
+ }
+ .b-r a {
+ text-decoration: underline; color: blue;
+ }
+ div, span {
+ vertical-align: top;
+ }
+ p {
+ margin: 0px;
+ }
+ h1 {
+ /*font-size: 14pt;*/
+ color: red;
+ }
+ #menu {
+ margin-bottom: 10px;
+ }
+ #menu ul {
+ margin-left: 0;
+ padding-left: 0;
+ display: inline;
+ }
+ #menu ul li {
+ margin-left: 0;
+ margin-bottom: 0;
+ padding: 2px 15px 5px;
+ border: 1px solid #000;
+ list-style: none;
+ display: inline;
+ }
+ #menu ul li.here {
+ border-bottom: 1px solid #ffc;
+ list-style: none;
+ display: inline;
+ }
+ .menu-tab {
+ background: white;
+ }
+ .menu-tab:hover {
+ background: grey;
+ }
+ .menu-tab-selected {
+ background: #aaaaaa;
+ }
+ #analysis-data ul {
+ margin-left: 15px;
+ }
+ #analyzed-files, #used-libraries, #analysis-error {
+ margin: 2px;
+ border: 1px black solid;
+ padding: 2px;
+ float: left;
+ overflow:auto;
+ }
+ #analyzed-files {
+ width: 25%;
+ }
+ #used-libraries {
+ width: 25%;
+ }
+ #analysis-error {
+ width: 40%;
+ }
+ div.summary {
+ width:100%;
+ text-align:left;
+ }
+ .summary table {
+ border:1px solid black;
+ }
+ .summary th {
+ background: #aaaaaa;
+ color: white;
+ }
+ .summary th, .summary td {
+ padding: 2px 4px 2px 4px;
+ }
+ .summary-name {
+ background: #eeeeee;
+ text-align:left;
+ }
+ .summary-size {
+ background: #eeeeee;
+ text-align:center;
+ }
+ .summary-ratio {
+ background: #eeeeee;
+ text-align:center;
+ }
+ .summary-priority-all {
+ background: #dddddd;
+ text-align:center;
+ }
+ .summary-priority-1 {
+ background: red;
+ text-align:center;
+ }
+ .summary-priority-2 {
+ background: orange;
+ text-align:center;
+ }
+ .summary-priority-3 {
+ background: green;
+ text-align:center;
+ }
+ .summary-priority-4 {
+ background: blue;
+ text-align:center;
+ }
+ .ob {
+ border: 1px solid black;
+ margin: 10px;
+ }
+ .ob-t {
+ border-bottom: 1px solid #000000; font-size: 12pt; font-weight: bold;
+ background: #cccccc; margin: 0; padding: 0 5px 0 5px;
+ }
+ .t-h {
+ font-weight: normal;
+ }
+ .ib-1, .ib-2 {
+ margin: 0 0 0 10px;
+ }
+ .ib-1-t, .ib-2-t {
+ border-bottom: 1px solid #000000; border-left: 1px solid #000000;
+ margin: 0; padding: 0 5px 0 5px;
+ font-size: 12pt; font-weight: bold; background: #cccccc;
+ }
+ .bb {
+ border-bottom: 1px solid #000000; border-left: 1px solid #000000;
+ }
+ .b-1 {
+ background: red; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-2 {
+ background: orange; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-3 {
+ background: green; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-4 {
+ background: blue; height: 0.5em; width: 1em;
+ margin-right: 0.5em;
+ }
+ .b-t {
+ }
+ .b-r {
+ font-size: 10pt; font-weight: bold; padding: 0 0 0 60px;
+ }
+ .b-d {
+ font-weight: normal; background: #eeeee0;
+ padding: 0 5px 0 5px; margin: 0px;
+ }
+ .bug-placeholder {
+ top:140px;
+ border:1px solid black;
+ display:none;
+ }
+ .tip {
+ border:solid 1px #666666;
+ width:600px;
+ padding:3px;
+ position:absolute;
+ z-index:100;
+ visibility:hidden;
+ color:#333333;
+ top:20px;
+ left:90px;
+ background-color:#ffffcc;
+ layer-background-color:#ffffcc;
+ }
+
+
+ </style>
+ </head>
+ <body>
+ <div id='content'>
+ <h1>
+ FindBugs (<xsl:value-of select="/BugCollection/@version" />)
+ Analysis for
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </h1>
+ <div id="menu">
+ <ul>
+ <li id='bug-summary-tab' class='menu-tab-selected'>
+ <xsl:attribute name="onclick">showmenu('bug-summary');return false;</xsl:attribute>
+ <a href='' onclick='return false;'>Bug Summary</a>
+ </li>
+ <li id='analysis-data-tab' class='menu-tab'>
+ <xsl:attribute name="onclick">showmenu('analysis-data');return false;</xsl:attribute>
+ <a href='' onclick='return false;'>Analysis Information</a>
+ </li>
+ <li id='list-by-category-tab' class='menu-tab'>
+ <xsl:attribute name="onclick">showmenu('list-by-category');return false;</xsl:attribute>
+ <a href='' onclick='return false;'>List bugs by bug category</a>
+ </li>
+ <li id='list-by-package-tab' class='menu-tab'>
+ <xsl:attribute name="onclick">showmenu('list-by-package');return false;</xsl:attribute>
+ <a href='' onclick='return false;'>List bugs by package</a>
+ </li>
+ </ul>
+ </div>
+ <xsl:call-template name="generateSummary" />
+ <xsl:call-template name="analysis-data" />
+ <xsl:call-template name="list-by-category" />
+ <xsl:call-template name="list-by-package" />
+
+
+ <!-- advanced tooltips -->
+ <xsl:for-each select="/BugCollection/BugPattern">
+ <xsl:variable name="b-t"><xsl:value-of select="@type" /></xsl:variable>
+ <div>
+ <xsl:attribute name="id">tip-<xsl:value-of select="$b-t" /></xsl:attribute>
+ <xsl:attribute name="class">tip</xsl:attribute>
+ <b><xsl:value-of select="@abbrev" /> / <xsl:value-of select="@type" /></b><br/>
+ <xsl:value-of select="/BugCollection/BugPattern[@type=$b-t]/Details" disable-output-escaping="yes" />
+ </div>
+ </xsl:for-each>
+
+ <!-- bug descriptions - hidden -->
+ <xsl:for-each select="/BugCollection/BugInstance">
+ <div style="display:none;">
+ <xsl:attribute name="id">b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" /></xsl:attribute>
+ <xsl:for-each select="*/Message">
+ <xsl:choose>
+ <xsl:when test="parent::SourceLine and $htmlsrcpath != '' ">
+ <div class="b-r"><a>
+ <xsl:attribute name="href"><xsl:value-of select="$htmlsrcpath"/><xsl:value-of select="../@sourcepath" />.html#<xsl:value-of select="../@start" /></xsl:attribute>
+ <xsl:apply-templates />
+ </a></div>
+ </xsl:when>
+ <xsl:otherwise>
+ <div class="b-r"><xsl:apply-templates /></div>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:for-each>
+ <div class="b-d">
+ <xsl:value-of select="LongMessage" disable-output-escaping="no" />
+ </div>
+ </div>
+ </xsl:for-each>
+ </div>
+ <div id='fixedbox'>
+ <div id='bug-placeholder'></div>
+ </div>
+ </body>
+</html>
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- generate summary report from stats -->
+<xsl:template name="generateSummary" >
+<div class='summary' id='bug-summary'>
+ <h2>FindBugs Analysis generated at: <xsl:value-of select="/BugCollection/FindBugsSummary/@timestamp" /></h2>
+ <table>
+ <tr>
+ <th>Package</th>
+ <th>Code Size</th>
+ <th>Bugs</th>
+ <th>Bugs p1</th>
+ <th>Bugs p2</th>
+ <th>Bugs p3</th>
+ <th>Bugs Exp.</th>
+ <th>Ratio</th>
+ </tr>
+ <tr>
+ <td class='summary-name'>
+ Overall
+ (<xsl:value-of select="/BugCollection/FindBugsSummary/@num_packages" /> packages),
+ (<xsl:value-of select="/BugCollection/FindBugsSummary/@total_classes" /> classes)
+ </td>
+ <td class='summary-size'><xsl:value-of select="/BugCollection/FindBugsSummary/@total_size" /></td>
+ <td class='summary-priority-all'><xsl:value-of select="/BugCollection/FindBugsSummary/@total_bugs" /></td>
+ <td class='summary-priority-1'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_1" /></td>
+ <td class='summary-priority-2'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_2" /></td>
+ <td class='summary-priority-3'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_3" /></td>
+ <td class='summary-priority-4'><xsl:value-of select="/BugCollection/FindBugsSummary/@priority_4" /></td>
+ <td class='summary-ratio'></td>
+ </tr>
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats">
+ <xsl:sort select="@package" />
+ <xsl:if test="@total_bugs!='0'" >
+ <tr>
+ <td class='summary-name'><xsl:value-of select="@package" /></td>
+ <td class='summary-size'><xsl:value-of select="@total_size" /></td>
+ <td class='summary-priority-all'><xsl:value-of select="@total_bugs" /></td>
+ <td class='summary-priority-1'><xsl:value-of select="@priority_1" /></td>
+ <td class='summary-priority-2'><xsl:value-of select="@priority_2" /></td>
+ <td class='summary-priority-3'><xsl:value-of select="@priority_3" /></td>
+ <td class='summary-priority-4'><xsl:value-of select="@priority_4" /></td>
+ <td class='summary-ratio'></td>
+<!--
+ <xsl:for-each select="ClassStats">
+ <xsl:if test="@bugs!='0'" >
+ <li>
+ <xsl:value-of select="@class" /> - total: <xsl:value-of select="@bugs" />
+ </li>
+ </xsl:if>
+ </xsl:for-each>
+-->
+ </tr>
+ </xsl:if>
+ </xsl:for-each>
+ </table>
+</div>
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- display analysis info -->
+<xsl:template name="analysis-data">
+ <div id='analysis-data' style='display:none;'>
+ <div id='analyzed-files'>
+ <h3>Analyzed Files:</h3>
+ <ul>
+ <xsl:for-each select="/BugCollection/Project/Jar">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ </ul>
+ </div>
+ <div id='used-libraries'>
+ <h3>Used Libraries:</h3>
+ <ul>
+ <xsl:for-each select="/BugCollection/Project/AuxClasspathEntry">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ <xsl:if test="count(/BugCollection/Project/AuxClasspathEntry)=0" >
+ <li>None</li>
+ </xsl:if>
+ </ul>
+ </div>
+ <div id='analysis-error'>
+ <h3>Analysis Errors:</h3>
+ <ul>
+ <xsl:variable name="error-count"
+ select="count(/BugCollection/Errors/MissingClass)" />
+ <xsl:if test="$error-count=0" >
+ <li>None</li>
+ </xsl:if>
+ <xsl:if test="$error-count>0" >
+ <li>Missing ref classes for analysis:
+ <ul>
+ <xsl:for-each select="/BugCollection/Errors/MissingClass">
+ <li><xsl:apply-templates /></li>
+ </xsl:for-each>
+ </ul>
+ </li>
+ </xsl:if>
+ </ul>
+ </div>
+ </div>
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- show priorities helper -->
+<xsl:template name="helpPriorities">
+ <span>
+ <xsl:attribute name="class">b-1</xsl:attribute>
+   
+ </span> P1
+ <span>
+ <xsl:attribute name="class">b-2</xsl:attribute>
+   
+ </span> P2
+ <span>
+ <xsl:attribute name="class">b-3</xsl:attribute>
+   
+ </span> P3
+ <span>
+ <xsl:attribute name="class">b-4</xsl:attribute>
+   
+ </span> Exp.
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- display the details of a bug -->
+<xsl:template name="display-bug" >
+ <xsl:param name="b-t" select="''" />
+ <xsl:param name="bug-id" select="''" />
+ <xsl:param name="which-list" select="''" />
+ <div class="bb">
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">showbug('b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" />','<xsl:value-of select="$which-list" />');return false;</xsl:attribute>
+ <span>
+ <xsl:attribute name="class">b-<xsl:value-of select="@priority"/></xsl:attribute>
+   
+ </span>
+ <span class="b-t"><xsl:value-of select="@abbrev" />: </span> <xsl:value-of select="Class/Message" />
+ </a>
+ <div style="display:none;">
+ <xsl:attribute name="id">b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" />-ph-<xsl:value-of select="$which-list" /></xsl:attribute>
+ loading...
+ </div>
+ </div>
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- main template for the list by category -->
+<xsl:template name="list-by-category" >
+ <div id='list-by-category' class='data-box' style='display:none;'>
+ <xsl:call-template name="helpPriorities" />
+ <xsl:variable name="unique-category" select="/BugCollection/BugCategory/@category"/>
+ <xsl:for-each select="$unique-category">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="categories">
+ <xsl:with-param name="category" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+ </div>
+</xsl:template>
+
+<xsl:template name="categories" >
+ <xsl:param name="category" select="''" />
+ <xsl:variable name="category-count"
+ select="count(/BugCollection/BugInstance[@category=$category])" />
+ <xsl:variable name="category-count-p1"
+ select="count(/BugCollection/BugInstance[@category=$category and @priority='1'])" />
+ <xsl:variable name="category-count-p2"
+ select="count(/BugCollection/BugInstance[@category=$category and @priority='2'])" />
+ <xsl:variable name="category-count-p3"
+ select="count(/BugCollection/BugInstance[@category=$category and @priority='3'])" />
+ <xsl:variable name="category-count-p4"
+ select="count(/BugCollection/BugInstance[@category=$category and @priority='4'])" />
+ <div class='ob'>
+ <div class='ob-t'>
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('category-<xsl:value-of select="$category" />');return false;</xsl:attribute>
+ <xsl:value-of select="/BugCollection/BugCategory[@category=$category]/Description" />
+ (<xsl:value-of select="$category-count" />:
+ <span class='t-h'><xsl:value-of select="$category-count-p1" />/<xsl:value-of select="$category-count-p2" />/<xsl:value-of select="$category-count-p3" />/<xsl:value-of select="$category-count-p4" /></span>)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">category-<xsl:value-of select="$category" /></xsl:attribute>
+ <xsl:call-template name="list-by-category-and-code">
+ <xsl:with-param name="category" select="$category" />
+ </xsl:call-template>
+ </div>
+ </div>
+</xsl:template>
+
+<xsl:template name="list-by-category-and-code" >
+ <xsl:param name="category" select="''" />
+ <xsl:variable name="unique-code" select="/BugCollection/BugInstance[@category=$category and generate-id()= generate-id(key('lbc-code-key',concat(@category,@abbrev)))]/@abbrev" />
+ <xsl:for-each select="$unique-code">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="codes">
+ <xsl:with-param name="category" select="$category" />
+ <xsl:with-param name="code" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+</xsl:template>
+
+<xsl:template name="codes" >
+ <xsl:param name="category" select="''" />
+ <xsl:param name="code" select="''" />
+ <xsl:variable name="code-count"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code])" />
+ <xsl:variable name="code-count-p1"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @priority='1'])" />
+ <xsl:variable name="code-count-p2"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @priority='2'])" />
+ <xsl:variable name="code-count-p3"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @priority='3'])" />
+ <xsl:variable name="code-count-p4"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @priority='4'])" />
+ <div class='ib-1'>
+ <div class="ib-1-t">
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('category-<xsl:value-of select="$category" />-and-code-<xsl:value-of select="$code" />');return false;</xsl:attribute>
+ <xsl:value-of select="$code" />: <xsl:value-of select="/BugCollection/BugCode[@abbrev=$code]/Description" />
+ (<xsl:value-of select="$code-count" />:
+ <span class='t-h'><xsl:value-of select="$code-count-p1" />/<xsl:value-of select="$code-count-p2" />/<xsl:value-of select="$code-count-p3" />/<xsl:value-of select="$code-count-p4" /></span>)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">category-<xsl:value-of select="$category" />-and-code-<xsl:value-of select="$code" /></xsl:attribute>
+ <xsl:call-template name="list-by-category-and-code-and-bug">
+ <xsl:with-param name="category" select="$category" />
+ <xsl:with-param name="code" select="$code" />
+ </xsl:call-template>
+ </div>
+ </div>
+</xsl:template>
+
+<xsl:template name="list-by-category-and-code-and-bug" >
+ <xsl:param name="category" select="''" />
+ <xsl:param name="code" select="''" />
+ <xsl:variable name="unique-bug" select="/BugCollection/BugInstance[@category=$category and @abbrev=$code and generate-id()= generate-id(key('lbc-bug-key',concat(@category,@abbrev,@type)))]/@type" />
+ <xsl:for-each select="$unique-bug">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="bugs">
+ <xsl:with-param name="category" select="$category" />
+ <xsl:with-param name="code" select="$code" />
+ <xsl:with-param name="bug" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+</xsl:template>
+
+<xsl:template name="bugs" >
+ <xsl:param name="category" select="''" />
+ <xsl:param name="code" select="''" />
+ <xsl:param name="bug" select="''" />
+ <xsl:variable name="bug-count"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug])" />
+ <xsl:variable name="bug-count-p1"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug and @priority='1'])" />
+ <xsl:variable name="bug-count-p2"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug and @priority='2'])" />
+ <xsl:variable name="bug-count-p3"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug and @priority='3'])" />
+ <xsl:variable name="bug-count-p4"
+ select="count(/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug and @priority='4'])" />
+ <div class='ib-2'>
+ <div class='ib-2-t'>
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('category-<xsl:value-of select="$category" />-and-code-<xsl:value-of select="$code" />-and-bug-<xsl:value-of select="$bug" />');return false;</xsl:attribute>
+ <xsl:attribute name="onmouseout">popUp(event,'tip-<xsl:value-of select="$bug" />');</xsl:attribute>
+ <xsl:attribute name="onmouseover">popUp(event,'tip-<xsl:value-of select="$bug" />');</xsl:attribute>
+ <xsl:value-of select="/BugCollection/BugPattern[@category=$category and @abbrev=$code and @type=$bug]/ShortDescription" />  
+ (<xsl:value-of select="$bug-count" />:
+ <span class='t-h'><xsl:value-of select="$bug-count-p1" />/<xsl:value-of select="$bug-count-p2" />/<xsl:value-of select="$bug-count-p3" />/<xsl:value-of select="$bug-count-p4" /></span>)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">category-<xsl:value-of select="$category" />-and-code-<xsl:value-of select="$code" />-and-bug-<xsl:value-of select="$bug" /></xsl:attribute>
+ <xsl:variable name="cat-code-type">category-<xsl:value-of select="$category" />-and-code-<xsl:value-of select="$code" />-and-bug-<xsl:value-of select="$bug" /></xsl:variable>
+ <xsl:variable name="bug-id">b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" /></xsl:variable>
+ <xsl:for-each select="/BugCollection/BugInstance[@category=$category and @abbrev=$code and @type=$bug]">
+ <xsl:call-template name="display-bug">
+ <xsl:with-param name="b-t" select="@type" />
+ <xsl:with-param name="bug-id" select="$bug-id" />
+ <xsl:with-param name="which-list" select="'c'" />
+ </xsl:call-template>
+ </xsl:for-each>
+ </div>
+ </div>
+</xsl:template>
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+<!-- main template for the list by package -->
+<xsl:template name="list-by-package" >
+ <div id='list-by-package' class='data-box' style='display:none;'>
+ <xsl:call-template name="helpPriorities" />
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats[@total_bugs != '0']/@package">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="packages">
+ <xsl:with-param name="package" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+ </div>
+</xsl:template>
+
+<xsl:template name="packages" >
+ <xsl:param name="package" select="''" />
+ <xsl:variable name="package-count-p1">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_1 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_1 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_1" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="package-count-p2">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_2 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_2 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_2" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="package-count-p3">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_3 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_3 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_3" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="package-count-p4">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_4 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_4 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@priority_4" />
+ </xsl:if>
+ </xsl:variable>
+
+ <div class='ob'>
+ <div class='ob-t'>
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('package-<xsl:value-of select="$package" />');return false;</xsl:attribute>
+ <xsl:value-of select="$package" />
+ (<xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/@total_bugs" />:
+ <span class='t-h'><xsl:value-of select="$package-count-p1" />/<xsl:value-of select="$package-count-p2" />/<xsl:value-of select="$package-count-p3" />/<xsl:value-of select="$package-count-p4" /></span>)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">package-<xsl:value-of select="$package" /></xsl:attribute>
+ <xsl:call-template name="list-by-package-and-class">
+ <xsl:with-param name="package" select="$package" />
+ </xsl:call-template>
+ </div>
+ </div>
+</xsl:template>
+
+<xsl:template name="list-by-package-and-class" >
+ <xsl:param name="package" select="''" />
+ <xsl:for-each select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@bugs != '0']/@class">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="classes">
+ <xsl:with-param name="package" select="$package" />
+ <xsl:with-param name="class" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+</xsl:template>
+
+<xsl:template name="classes" >
+ <xsl:param name="package" select="''" />
+ <xsl:param name="class" select="''" />
+ <xsl:variable name="class-count"
+ select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@bugs" />
+
+ <xsl:variable name="class-count-p1">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_1 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_1 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_1" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="class-count-p2">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_2 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_2 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_2" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="class-count-p3">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_3 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_3 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_3" />
+ </xsl:if>
+ </xsl:variable>
+ <xsl:variable name="class-count-p4">
+ <xsl:if test="not(/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_4 != '')">0</xsl:if>
+ <xsl:if test="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_4 != ''">
+ <xsl:value-of select="/BugCollection/FindBugsSummary/PackageStats[@package=$package]/ClassStats[@class=$class and @bugs != '0']/@priority_4" />
+ </xsl:if>
+ </xsl:variable>
+
+ <div class='ib-1'>
+ <div class="ib-1-t">
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('package-<xsl:value-of select="$package" />-and-class-<xsl:value-of select="$class" />');return false;</xsl:attribute>
+ <xsl:value-of select="$class" /> (<xsl:value-of select="$class-count" />:
+ <span class='t-h'><xsl:value-of select="$class-count-p1" />/<xsl:value-of select="$class-count-p2" />/<xsl:value-of select="$class-count-p3" />/<xsl:value-of select="$class-count-p4" /></span>)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">package-<xsl:value-of select="$package" />-and-class-<xsl:value-of select="$class" /></xsl:attribute>
+ <xsl:call-template name="list-by-package-and-class-and-bug">
+ <xsl:with-param name="package" select="$package" />
+ <xsl:with-param name="class" select="$class" />
+ </xsl:call-template>
+ </div>
+ </div>
+</xsl:template>
+
+<xsl:template name="list-by-package-and-class-and-bug" >
+ <xsl:param name="package" select="''" />
+ <xsl:param name="class" select="''" />
+ <xsl:variable name="unique-class-bugs" select="/BugCollection/BugInstance[Class[position()=1 and @classname=$class] and generate-id() = generate-id(key('lbp-class-b-t',concat(Class/@classname,@type)))]/@type" />
+
+ <xsl:for-each select="$unique-class-bugs">
+ <xsl:sort select="." order="ascending" />
+ <xsl:call-template name="class-bugs">
+ <xsl:with-param name="package" select="$package" />
+ <xsl:with-param name="class" select="$class" />
+ <xsl:with-param name="type" select="." />
+ </xsl:call-template>
+ </xsl:for-each>
+</xsl:template>
+
+<xsl:template name="class-bugs" >
+ <xsl:param name="package" select="''" />
+ <xsl:param name="class" select="''" />
+ <xsl:param name="type" select="''" />
+ <xsl:variable name="bug-count"
+ select="count(/BugCollection/BugInstance[@type=$type and Class[position()=1 and @classname=$class]])" />
+ <div class='ib-2'>
+ <div class='ib-2-t'>
+ <a>
+ <xsl:attribute name="href"></xsl:attribute>
+ <xsl:attribute name="onclick">toggle('package-<xsl:value-of select="$package" />-and-class-<xsl:value-of select="$class" />-and-type-<xsl:value-of select="$type" />');return false;</xsl:attribute>
+ <xsl:attribute name="onmouseout">popUp(event,'tip-<xsl:value-of select="$type" />')</xsl:attribute>
+ <xsl:attribute name="onmouseover">popUp(event,'tip-<xsl:value-of select="$type" />')</xsl:attribute>
+ <xsl:value-of select="/BugCollection/BugPattern[@type=$type]/ShortDescription" />  
+ (<xsl:value-of select="$bug-count" />)
+ </a>
+ </div>
+ <div style="display:none;">
+ <xsl:attribute name="id">package-<xsl:value-of select="$package" />-and-class-<xsl:value-of select="$class" />-and-type-<xsl:value-of select="$type" /></xsl:attribute>
+ <xsl:variable name="package-class-type">package-<xsl:value-of select="$package" />-and-class-<xsl:value-of select="$class" />-and-type-<xsl:value-of select="$type" /></xsl:variable>
+ <xsl:variable name="bug-id">b-uid-<xsl:value-of select="@instanceHash" />-<xsl:value-of select="@instanceOccurrenceNum" /></xsl:variable>
+ <xsl:for-each select="/BugCollection/BugInstance[@type=$type and Class[position()=1 and @classname=$class]]">
+ <xsl:call-template name="display-bug">
+ <xsl:with-param name="b-t" select="@type" />
+ <xsl:with-param name="bug-id" select="$bug-id" />
+ <xsl:with-param name="which-list" select="'p'" />
+ </xsl:call-template>
+ </xsl:for-each>
+ </div>
+ </div>
+</xsl:template>
+
+</xsl:transform>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ FindBugs - Find bugs in Java programs
+ Copyright (C) 2004,2005 University of Maryland
+ Copyright (C) 2005, Chris Nappin
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+-->
+<xsl:stylesheet version="1.0"
+ xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+<xsl:output
+ method="xml"
+ omit-xml-declaration="yes"
+ standalone="yes"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
+ indent="yes"
+ encoding="UTF-8"/>
+
+<!--xsl:key name="bug-category-key" match="/BugCollection/BugInstance" use="@category"/-->
+
+<xsl:variable name="bugTableHeader">
+ <tr class="tableheader">
+ <th align="left">Warning</th>
+ <th align="left">Priority</th>
+ <th align="left">Details</th>
+ </tr>
+</xsl:variable>
+
+<xsl:template match="/">
+ <html>
+ <head>
+ <title>FindBugs Report</title>
+ <style type="text/css">
+ .tablerow0 {
+ background: #EEEEEE;
+ }
+
+ .tablerow1 {
+ background: white;
+ }
+
+ .detailrow0 {
+ background: #EEEEEE;
+ }
+
+ .detailrow1 {
+ background: white;
+ }
+
+ .tableheader {
+ background: #b9b9fe;
+ font-size: larger;
+ }
+ </style>
+ </head>
+
+ <xsl:variable name="unique-catkey" select="/BugCollection/BugCategory/@category"/>
+ <!--xsl:variable name="unique-catkey" select="/BugCollection/BugInstance[generate-id() = generate-id(key('bug-category-key',@category))]/@category"/-->
+
+ <body>
+
+ <h1>FindBugs Report</h1>
+ <p>Produced using <a href="http://findbugs.sourceforge.net">FindBugs</a> <xsl:value-of select="/BugCollection/@version"/>.</p>
+ <p>Project:
+ <xsl:choose>
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'><xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>
+ </xsl:choose>
+ </p>
+ <h2>Metrics</h2>
+ <xsl:apply-templates select="/BugCollection/FindBugsSummary"/>
+
+ <h2>Summary</h2>
+ <table width="500" cellpadding="5" cellspacing="2">
+ <tr class="tableheader">
+ <th align="left">Warning Type</th>
+ <th align="right">Number</th>
+ </tr>
+
+ <xsl:for-each select="$unique-catkey">
+ <xsl:sort select="." order="ascending"/>
+ <xsl:variable name="catkey" select="."/>
+ <xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
+ <xsl:variable name="styleclass">
+ <xsl:choose><xsl:when test="position() mod 2 = 1">tablerow0</xsl:when>
+ <xsl:otherwise>tablerow1</xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <tr class="{$styleclass}">
+ <td><a href="#Warnings_{$catkey}"><xsl:value-of select="$catdesc"/> Warnings</a></td>
+ <td align="right"><xsl:value-of select="count(/BugCollection/BugInstance[@category=$catkey])"/></td>
+ </tr>
+ </xsl:for-each>
+
+ <xsl:variable name="styleclass">
+ <xsl:choose><xsl:when test="count($unique-catkey) mod 2 = 0">tablerow0</xsl:when>
+ <xsl:otherwise>tablerow1</xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+ <tr class="{$styleclass}">
+ <td><b>Total</b></td>
+ <td align="right"><b><xsl:value-of select="count(/BugCollection/BugInstance)"/></b></td>
+ </tr>
+ </table>
+ <p><br/><br/></p>
+
+ <h1>Warnings</h1>
+
+ <p>Click on each warning link to see a full description of the issue, and
+ details of how to resolve it.</p>
+
+ <xsl:for-each select="$unique-catkey">
+ <xsl:sort select="." order="ascending"/>
+ <xsl:variable name="catkey" select="."/>
+ <xsl:variable name="catdesc" select="/BugCollection/BugCategory[@category=$catkey]/Description"/>
+
+ <xsl:call-template name="generateWarningTable">
+ <xsl:with-param name="warningSet" select="/BugCollection/BugInstance[@category=$catkey]"/>
+ <xsl:with-param name="sectionTitle"><xsl:value-of select="$catdesc"/> Warnings</xsl:with-param>
+ <xsl:with-param name="sectionId">Warnings_<xsl:value-of select="$catkey"/></xsl:with-param>
+ </xsl:call-template>
+ </xsl:for-each>
+
+ <p><br/><br/></p>
+ <h1><a name="Details">Warning Types</a></h1>
+
+ <xsl:apply-templates select="/BugCollection/BugPattern">
+ <xsl:sort select="@abbrev"/>
+ <xsl:sort select="ShortDescription"/>
+ </xsl:apply-templates>
+
+ </body>
+ </html>
+</xsl:template>
+
+<xsl:template match="BugInstance">
+ <xsl:variable name="warningId"><xsl:value-of select="generate-id()"/></xsl:variable>
+
+ <tr class="tablerow{position() mod 2}">
+ <td width="20%" valign="top">
+ <a href="#{@type}"><xsl:value-of select="ShortMessage"/></a>
+ </td>
+ <td width="10%" valign="top">
+ <xsl:choose>
+ <xsl:when test="@priority = 1">High</xsl:when>
+ <xsl:when test="@priority = 2">Medium</xsl:when>
+ <xsl:when test="@priority = 3">Low</xsl:when>
+ <xsl:otherwise>Unknown</xsl:otherwise>
+ </xsl:choose>
+ </td>
+ <td width="70%">
+ <p><xsl:value-of select="LongMessage"/><br/><br/>
+
+ <!-- add source filename and line number(s), if any -->
+ <xsl:if test="SourceLine">
+ <br/>In file <xsl:value-of select="SourceLine/@sourcefile"/>,
+ <xsl:choose>
+ <xsl:when test="SourceLine/@start = SourceLine/@end">
+ line <xsl:value-of select="SourceLine/@start"/>
+ </xsl:when>
+ <xsl:otherwise>
+ lines <xsl:value-of select="SourceLine/@start"/>
+ to <xsl:value-of select="SourceLine/@end"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:if>
+
+ <xsl:for-each select="./*/Message">
+ <br/><xsl:value-of select="text()"/>
+ </xsl:for-each>
+ </p>
+ </td>
+ </tr>
+</xsl:template>
+
+<xsl:template match="BugPattern">
+ <h2><a name="{@type}"><xsl:value-of select="ShortDescription"/></a></h2>
+ <xsl:value-of select="Details" disable-output-escaping="yes"/>
+ <p><br/><br/></p>
+</xsl:template>
+
+<xsl:template name="generateWarningTable">
+ <xsl:param name="warningSet"/>
+ <xsl:param name="sectionTitle"/>
+ <xsl:param name="sectionId"/>
+
+ <h2><a name="{$sectionId}"><xsl:value-of select="$sectionTitle"/></a></h2>
+ <table class="warningtable" width="100%" cellspacing="2" cellpadding="5">
+ <xsl:copy-of select="$bugTableHeader"/>
+ <xsl:choose>
+ <xsl:when test="count($warningSet) > 0">
+ <xsl:apply-templates select="$warningSet">
+ <xsl:sort select="@priority"/>
+ <xsl:sort select="@abbrev"/>
+ <xsl:sort select="Class/@classname"/>
+ </xsl:apply-templates>
+ </xsl:when>
+ <xsl:otherwise>
+ <tr><td colspan="2"><p><i>None</i></p></td></tr>
+ </xsl:otherwise>
+ </xsl:choose>
+ </table>
+ <p><br/><br/></p>
+</xsl:template>
+
+<xsl:template match="FindBugsSummary">
+ <xsl:variable name="kloc" select="@total_size div 1000.0"/>
+ <xsl:variable name="format" select="'#######0.00'"/>
+
+ <p><xsl:value-of select="@total_size"/> lines of code analyzed,
+ in <xsl:value-of select="@total_classes"/> classes,
+ in <xsl:value-of select="@num_packages"/> packages.</p>
+ <table width="500" cellpadding="5" cellspacing="2">
+ <tr class="tableheader">
+ <th align="left">Metric</th>
+ <th align="right">Total</th>
+ <th align="right">Density*</th>
+ </tr>
+ <tr class="tablerow0">
+ <td>High Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_1"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_1 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+ <tr class="tablerow1">
+ <td>Medium Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_2"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_2 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+
+ <xsl:choose>
+ <xsl:when test="@priority_3">
+ <tr class="tablerow1">
+ <td>Low Priority Warnings</td>
+ <td align="right"><xsl:value-of select="@priority_3"/></td>
+ <td align="right">
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@priority_3 div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </td>
+ </tr>
+ <xsl:variable name="totalClass" select="tablerow0"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:variable name="totalClass" select="tablerow1"/>
+ </xsl:otherwise>
+ </xsl:choose>
+
+ <tr class="$totalClass">
+ <td><b>Total Warnings</b></td>
+ <td align="right"><b><xsl:value-of select="@total_bugs"/></b></td>
+ <td align="right">
+ <b>
+ <xsl:choose>
+ <xsl:when test= "number($kloc) > 0.0">
+ <xsl:value-of select="format-number(@total_bugs div $kloc, $format)"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="format-number(0.0, $format)"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </b>
+ </td>
+ </tr>
+ </table>
+ <p><i>(* Defects per Thousand lines of non-commenting source statements)</i></p>
+ <p><br/><br/></p>
+
+</xsl:template>
+
+</xsl:stylesheet>
--- /dev/null
+<?xml version="1.0"?>\r
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0" >\r
+\r
+<xsl:output\r
+ method="xml" indent="yes"\r
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"\r
+ doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"\r
+ encoding="UTF-8"/>\r
+\r
+<xsl:param name="PAGE.TITLE" select="'Findbugs Summary Statistics'" />\r
+<xsl:param name="PAGE.FONT" select="'Arial'" />\r
+<xsl:param name="SUMMARY.HEADER" select="'Findbugs Summary Report'" />\r
+<xsl:param name="SUMMARY.LABEL" select="'Summary Analysis Generated at: '" />\r
+<xsl:param name="PACKAGE.HEADER" select="'Bugs By Package'" />\r
+<xsl:param name="PACKAGE.SORT.LABEL" select="'Sorted by Total Bugs'" />\r
+<xsl:param name="PACKAGE.LABEL" select="'Analysis of Package: '" />\r
+<xsl:param name="DEFAULT.PACKAGE.NAME" select="'default package'" />\r
+<xsl:param name="PACKAGE.BUGCLASS.LABEL" select="'Most Buggy Class in Package with #1 $1:'" />\r
+<xsl:param name="TOTAL.PACKAGES.LABEL" select="'#1 $1 Analyzed'" />\r
+\r
+<xsl:param name="BUGS.SINGLE.LABEL" select="'Bug'" />\r
+<xsl:param name="BUGS.PULURAL.LABEL" select="'Bugs'" />\r
+<xsl:param name="PACKAGE.SINGLE.LABEL" select="'Package'" />\r
+<xsl:param name="PACKAGE.PULURAL.LABEL" select="'Packages'" />\r
+\r
+\r
+<xsl:param name="TABLE.HEADING.TYPE" select="'Type Checked'" />\r
+<xsl:param name="TABLE.HEADING.COUNT" select="'Count'" />\r
+<xsl:param name="TABLE.HEADING.BUGS" select="'Bugs'" />\r
+<xsl:param name="TABLE.HEADING.PERCENT" select="'Percentage'" />\r
+<xsl:param name="TABLE.ROW.OUTER" select="'Outer Classes'" />\r
+<xsl:param name="TABLE.ROW.INNER" select="'Inner Classes'" />\r
+<xsl:param name="TABLE.ROW.INTERFACE" select="'Interfaces'" />\r
+<xsl:param name="TABLE.ROW.TOTAL" select="'Total'" />\r
+<xsl:param name="TABLE.WIDTH" select="'90%'" />\r
+\r
+<xsl:param name="PERCENTAGE.FORMAT" select="'#0.00%'" />\r
+\r
+<!-- This template drives the rest of the output -->\r
+<xsl:template match="/" >\r
+ <html>\r
+ <!-- JEditorPane gets really angry if it sees this\r
+ WWP: Sorry, this needs to be explained better. Not a valid HTML document without a head.\r
+ -->\r
+ <head><title><xsl:value-of select="$PAGE.TITLE" /></title></head>\r
+ <body>\r
+ <h1 align="center"><a href="http://findbugs.sourceforge.net"><xsl:value-of select="$SUMMARY.HEADER" /></a></h1>\r
+ <h2 align="center"> Analysis for \r
+ <xsl:choose>\r
+ <xsl:when test='string-length(/BugCollection/Project/@projectName)>0'>\r
+ <xsl:value-of select="/BugCollection/Project/@projectName" /></xsl:when>\r
+ <xsl:otherwise><xsl:value-of select="/BugCollection/Project/@filename" /></xsl:otherwise>\r
+ </xsl:choose>\r
+ </h2>\r
+ <h2 align="center"><xsl:value-of select="$SUMMARY.LABEL" /> \r
+ <i><xsl:value-of select="//FindBugsSummary/@timestamp" /></i></h2>\r
+ <xsl:apply-templates select="//FindBugsSummary" />\r
+ <br/>\r
+ <p align="center">\r
+ <font face="{$PAGE.FONT}" size="6"><xsl:value-of select="$PACKAGE.HEADER" /></font>\r
+ <br/><font face="{$PAGE.FONT}" size="4"><i>(<xsl:value-of select="$PACKAGE.SORT.LABEL"/>)</i></font>\r
+ </p>\r
+ <xsl:for-each select="//FindBugsSummary/PackageStats">\r
+ <xsl:sort select="@total_bugs" data-type="number" order="descending" />\r
+ <xsl:apply-templates select="." />\r
+ </xsl:for-each>\r
+ </body>\r
+ </html>\r
+</xsl:template>\r
+\r
+<xsl:template name="status_table_row" >\r
+ <xsl:param name="LABEL" select="''" />\r
+ <xsl:param name="COUNT" select="1" />\r
+ <xsl:param name="BUGS" select="0" />\r
+ <xsl:param name="FONT_SIZE" select="4" />\r
+ <tr>\r
+ <td align="left"><font face="{$PAGE.FONT}" size="{$FONT_SIZE}"><xsl:value-of select="$LABEL" /></font></td>\r
+ <td align="center"><font face="{$PAGE.FONT}" color="green" size="{$FONT_SIZE}"><xsl:value-of select="$COUNT" /></font></td>\r
+ <td align="center"><font face="{$PAGE.FONT}" color="red" size="{$FONT_SIZE}"><xsl:value-of select="$BUGS" /></font></td>\r
+ <td align="center"><font face="{$PAGE.FONT}" color="blue" size="{$FONT_SIZE}">\r
+ <xsl:choose>\r
+ <xsl:when test="$COUNT > 0">\r
+ <xsl:value-of select="format-number(number($BUGS div $COUNT), $PERCENTAGE.FORMAT)"/>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:value-of select="format-number(0, $PERCENTAGE.FORMAT)"/>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+ </font>\r
+ </td>\r
+ </tr>\r
+</xsl:template>\r
+\r
+<xsl:template name="table_header" >\r
+ <tr>\r
+ <th><font face="{$PAGE.FONT}" size="4"><xsl:value-of select="$TABLE.HEADING.TYPE"/></font></th>\r
+ <th><font face="{$PAGE.FONT}" size="4"><xsl:value-of select="$TABLE.HEADING.COUNT"/></font></th>\r
+ <th><font face="{$PAGE.FONT}" size="4"><xsl:value-of select="$TABLE.HEADING.BUGS"/></font></th>\r
+ <th><font face="{$PAGE.FONT}" size="4"><xsl:value-of select="$TABLE.HEADING.PERCENT"/></font></th>\r
+ </tr>\r
+</xsl:template>\r
+\r
+<xsl:template match="FindBugsSummary" >\r
+ <table width="{$TABLE.WIDTH}" border="1" align="center">\r
+ <xsl:call-template name="table_header" />\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.OUTER" />\r
+ <xsl:with-param name="COUNT" select="count(PackageStats/ClassStats[@interface='false' and substring-after(@class,'$')=''])" />\r
+ <xsl:with-param name="BUGS" select="sum(PackageStats/ClassStats[@interface='false' and substring-after(@class,'$')='']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.INNER" />\r
+ <xsl:with-param name="COUNT" select="count(PackageStats/ClassStats[@interface='false' and substring-after(@class,'$')!=''])" />\r
+ <xsl:with-param name="BUGS" select="sum(PackageStats/ClassStats[@interface='false' and substring-after(@class,'$')!='']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.INTERFACE" />\r
+ <xsl:with-param name="COUNT" select="count(PackageStats/ClassStats[@interface='true'])" />\r
+ <xsl:with-param name="BUGS" select="sum(PackageStats/ClassStats[@interface='true']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.TOTAL" />\r
+ <xsl:with-param name="COUNT" select="@total_classes" />\r
+ <xsl:with-param name="BUGS" select="@total_bugs"/>\r
+ <xsl:with-param name="FONT_SIZE" select="5"/>\r
+ </xsl:call-template>\r
+ <xsl:variable name="num_packages" select="count(PackageStats)" />\r
+ <tr><td align="center" colspan="4"><font face="{$PAGE.FONT}" size="4">\r
+ <xsl:call-template name='string_format'>\r
+ <xsl:with-param name="COUNT" select="$num_packages"/>\r
+ <xsl:with-param name="STRING" select="$TOTAL.PACKAGES.LABEL"/>\r
+ <xsl:with-param name="SINGLE" select="$PACKAGE.SINGLE.LABEL"/>\r
+ <xsl:with-param name="PULURAL" select="$PACKAGE.PULURAL.LABEL"/>\r
+ </xsl:call-template>\r
+ </font></td>\r
+ </tr>\r
+ </table>\r
+</xsl:template>\r
+\r
+\r
+<xsl:template name='string_format'>\r
+ <xsl:param name="COUNT" select="1"/>\r
+ <xsl:param name="STRING" select="''"/>\r
+ <xsl:param name="SINGLE" select="''"/>\r
+ <xsl:param name="PULURAL" select="''"/>\r
+ <xsl:variable name="count_str" select="concat(substring-before($STRING,'#1'), $COUNT, substring-after($STRING,'#1'))" />\r
+\r
+ <xsl:choose>\r
+ <xsl:when test="$COUNT > 1">\r
+ <xsl:value-of select="concat(substring-before($count_str,'$1'), $PULURAL, substring-after($count_str,'$1'))" />\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:value-of select="concat(substring-before($count_str,'$1'), $SINGLE, substring-after($count_str,'$1'))" />\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+</xsl:template>\r
+\r
+\r
+<xsl:template match="PackageStats" >\r
+ <xsl:variable name="package-name">\r
+ <xsl:choose>\r
+ <xsl:when test="@package = ''">\r
+ <xsl:value-of select="$DEFAULT.PACKAGE.NAME"/>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:value-of select="@package"/>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+ </xsl:variable>\r
+ <xsl:variable name="package-prefix">\r
+ <xsl:choose>\r
+ <xsl:when test="@package = ''">\r
+ <xsl:text></xsl:text>\r
+ </xsl:when>\r
+ <xsl:otherwise>\r
+ <xsl:value-of select="concat(@package,'.')"/>\r
+ </xsl:otherwise>\r
+ </xsl:choose>\r
+ </xsl:variable>\r
+ <h2 align="center"><xsl:value-of select="$PACKAGE.LABEL"/><i><font color='green'><xsl:value-of select="$package-name" /></font></i></h2>\r
+ <table width="{$TABLE.WIDTH}" border="1" align="center">\r
+ <xsl:call-template name="table_header" />\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.OUTER" />\r
+ <xsl:with-param name="COUNT" select="count(ClassStats[@interface='false' and substring-after(@class,'$')=''])" />\r
+ <xsl:with-param name="BUGS" select="sum(ClassStats[@interface='false' and substring-after(@class,'$')='']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.INNER" />\r
+ <xsl:with-param name="COUNT" select="count(ClassStats[@interface='false' and substring-after(@class,'$')!=''])" />\r
+ <xsl:with-param name="BUGS" select="sum(ClassStats[@interface='false' and substring-after(@class,'$')!='']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.INTERFACE" />\r
+ <xsl:with-param name="COUNT" select="count(ClassStats[@interface='true'])" />\r
+ <xsl:with-param name="BUGS" select="sum(ClassStats[@interface='true']/@bugs)" />\r
+ </xsl:call-template>\r
+\r
+ <xsl:call-template name="status_table_row">\r
+ <xsl:with-param name="LABEL" select="$TABLE.ROW.TOTAL" />\r
+ <xsl:with-param name="COUNT" select="@total_types" />\r
+ <xsl:with-param name="BUGS" select="@total_bugs" />\r
+ <xsl:with-param name="FONT_SIZE" select="5"/>\r
+ </xsl:call-template>\r
+\r
+ </table>\r
+ <xsl:if test="@total_bugs > 0">\r
+ <table width="{$TABLE.WIDTH}" border="0" align="center">\r
+ <xsl:variable name="max_bugs">\r
+ <xsl:for-each select="ClassStats">\r
+ <xsl:sort select="@bugs" data-type="number" order="descending"/>\r
+ <xsl:if test="position()=1">\r
+ <xsl:value-of select="@bugs"/>\r
+ </xsl:if>\r
+ </xsl:for-each>\r
+ </xsl:variable>\r
+\r
+ <tr>\r
+ <td align="left" colspan="2">\r
+ <font face="{$PAGE.FONT}" size="4">\r
+ <xsl:call-template name='string_format'>\r
+ <xsl:with-param name="COUNT" select="$max_bugs"/>\r
+ <xsl:with-param name="STRING" select="$PACKAGE.BUGCLASS.LABEL"/>\r
+ <xsl:with-param name="SINGLE" select="$BUGS.SINGLE.LABEL"/>\r
+ <xsl:with-param name="PULURAL" select="$BUGS.PULURAL.LABEL"/>\r
+ </xsl:call-template>\r
+ </font>\r
+ </td>\r
+ </tr>\r
+\r
+ <xsl:for-each select="ClassStats">\r
+ <xsl:if test="@bugs = $max_bugs">\r
+ <tr>\r
+ <td>       </td>\r
+ <td align="left"><font face="{$PAGE.FONT}" color="red" size="4"><i><xsl:value-of select="$package-prefix"/><xsl:value-of select="@class" /></i></font></td>\r
+ </tr>\r
+ </xsl:if>\r
+ </xsl:for-each>\r
+\r
+ </table>\r
+ </xsl:if>\r
+ <br/>\r
+</xsl:template>\r
+\r
+</xsl:stylesheet>\r
OSDN Git Service
