#165870 - [67cat] ClassNotFoundException: org.netbeans.modules.hudsonfindbugs.FindBugsProjectLookupProvider - removing plugin
1.1 --- a/hudsonfindbugs/build.xml Sat Aug 10 14:03:03 2013 +0200
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,5 +0,0 @@
1.4 -<?xml version="1.0" encoding="UTF-8"?>
1.5 -<project basedir="." default="netbeans" name="contrib/hudsonfindbugs">
1.6 - <description>Builds, tests, and runs the project org.netbeans.modules.hudsonfindbugs</description>
1.7 - <import file="../../nbbuild/templates/projectized.xml"/>
1.8 -</project>
2.1 --- a/hudsonfindbugs/manifest.mf Sat Aug 10 14:03:03 2013 +0200
2.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
2.3 @@ -1,6 +0,0 @@
2.4 -Manifest-Version: 1.0
2.5 -OpenIDE-Module: org.netbeans.modules.hudsonfindbugs
2.6 -OpenIDE-Module-Layer: org/netbeans/modules/hudsonfindbugs/layer.xml
2.7 -OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/hudsonfindbugs/Bundle.properties
2.8 -OpenIDE-Module-Specification-Version: 1.10
2.9 -
3.1 --- a/hudsonfindbugs/nbproject/project.properties Sat Aug 10 14:03:03 2013 +0200
3.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
3.3 @@ -1,2 +0,0 @@
3.4 -javac.compilerargs=-Xlint -Xlint:-serial
3.5 -javac.source=1.5
4.1 --- a/hudsonfindbugs/nbproject/project.xml Sat Aug 10 14:03:03 2013 +0200
4.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
4.3 @@ -1,104 +0,0 @@
4.4 -<?xml version="1.0" encoding="UTF-8"?>
4.5 -<project xmlns="http://www.netbeans.org/ns/project/1">
4.6 - <type>org.netbeans.modules.apisupport.project</type>
4.7 - <configuration>
4.8 - <data xmlns="http://www.netbeans.org/ns/nb-module-project/3">
4.9 - <code-name-base>org.netbeans.modules.hudsonfindbugs</code-name-base>
4.10 - <module-dependencies>
4.11 - <dependency>
4.12 - <code-name-base>org.netbeans.api.annotations.common</code-name-base>
4.13 - <build-prerequisite/>
4.14 - <compile-dependency/>
4.15 - <run-dependency>
4.16 - <release-version>1</release-version>
4.17 - <specification-version>1.1</specification-version>
4.18 - </run-dependency>
4.19 - </dependency>
4.20 - <dependency>
4.21 - <code-name-base>org.netbeans.modules.apisupport.project</code-name-base>
4.22 - <build-prerequisite/>
4.23 - <compile-dependency/>
4.24 - <run-dependency>
4.25 - <release-version>1</release-version>
4.26 - <specification-version>1.33</specification-version>
4.27 - </run-dependency>
4.28 - </dependency>
4.29 - <dependency>
4.30 - <code-name-base>org.netbeans.modules.java.j2seproject</code-name-base>
4.31 - <build-prerequisite/>
4.32 - <compile-dependency/>
4.33 - <run-dependency>
4.34 - <release-version>1</release-version>
4.35 - <specification-version>1.34</specification-version>
4.36 - </run-dependency>
4.37 - </dependency>
4.38 - <dependency>
4.39 - <code-name-base>org.netbeans.modules.project.ant</code-name-base>
4.40 - <build-prerequisite/>
4.41 - <compile-dependency/>
4.42 - <run-dependency>
4.43 - <release-version>1</release-version>
4.44 - <specification-version>1.17</specification-version>
4.45 - </run-dependency>
4.46 - </dependency>
4.47 - <dependency>
4.48 - <code-name-base>org.netbeans.modules.projectapi</code-name-base>
4.49 - <build-prerequisite/>
4.50 - <compile-dependency/>
4.51 - <run-dependency>
4.52 - <release-version>1</release-version>
4.53 - <specification-version>1.23</specification-version>
4.54 - </run-dependency>
4.55 - </dependency>
4.56 - <dependency>
4.57 - <code-name-base>org.netbeans.spi.tasklist</code-name-base>
4.58 - <build-prerequisite/>
4.59 - <compile-dependency/>
4.60 - <run-dependency>
4.61 - <release-version>1</release-version>
4.62 - <specification-version>1.0</specification-version>
4.63 - </run-dependency>
4.64 - </dependency>
4.65 - <dependency>
4.66 - <code-name-base>org.openide.filesystems</code-name-base>
4.67 - <build-prerequisite/>
4.68 - <compile-dependency/>
4.69 - <run-dependency>
4.70 - <specification-version>7.3</specification-version>
4.71 - </run-dependency>
4.72 - </dependency>
4.73 - <dependency>
4.74 - <code-name-base>org.openide.util</code-name-base>
4.75 - <build-prerequisite/>
4.76 - <compile-dependency/>
4.77 - <run-dependency>
4.78 - <specification-version>8.0</specification-version>
4.79 - </run-dependency>
4.80 - </dependency>
4.81 - <dependency>
4.82 - <code-name-base>org.openide.util.lookup</code-name-base>
4.83 - <build-prerequisite/>
4.84 - <compile-dependency/>
4.85 - <run-dependency>
4.86 - <specification-version>8.0</specification-version>
4.87 - </run-dependency>
4.88 - </dependency>
4.89 - </module-dependencies>
4.90 - <test-dependencies>
4.91 - <test-type>
4.92 - <name>unit</name>
4.93 - <test-dependency>
4.94 - <code-name-base>org.netbeans.libs.junit4</code-name-base>
4.95 - <compile-dependency/>
4.96 - </test-dependency>
4.97 - <test-dependency>
4.98 - <code-name-base>org.netbeans.modules.nbjunit</code-name-base>
4.99 - <recursive/>
4.100 - <compile-dependency/>
4.101 - </test-dependency>
4.102 - </test-type>
4.103 - </test-dependencies>
4.104 - <public-packages/>
4.105 - </data>
4.106 - </configuration>
4.107 -</project>
5.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/Bundle.properties Sat Aug 10 14:03:03 2013 +0200
5.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
5.3 @@ -1,8 +0,0 @@
5.4 -MSG_NbFindBugs=FindBugs Tasks for NetBeans.org
5.5 -dOpenIDE-Module-Display-Category=Developing NetBeans
5.6 -OpenIDE-Module-Display-Category=Quality
5.7 -OpenIDE-Module-Long-Description=\
5.8 - Searches for FindBugs results for netbeans.org standard modules from a daily builder and displays them in the task list for opened module projects. \
5.9 - See: http://wiki.netbeans.org/wiki/view/FindBugsTest
5.10 -OpenIDE-Module-Name=FindBugs Tasks for NetBeans.org
5.11 -OpenIDE-Module-Short-Description=Show FindBugs results in task list.
6.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/FindBugsTaskScanner.java Sat Aug 10 14:03:03 2013 +0200
6.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
6.3 @@ -1,331 +0,0 @@
6.4 -/*
6.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
6.6 - *
6.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
6.8 - *
6.9 - * The contents of this file are subject to the terms of either the GNU
6.10 - * General Public License Version 2 only ("GPL") or the Common
6.11 - * Development and Distribution License("CDDL") (collectively, the
6.12 - * "License"). You may not use this file except in compliance with the
6.13 - * License. You can obtain a copy of the License at
6.14 - * http://www.netbeans.org/cddl-gplv2.html
6.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
6.16 - * specific language governing permissions and limitations under the
6.17 - * License. When distributing the software, include this License Header
6.18 - * Notice in each file and include the License file at
6.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
6.20 - * particular file as subject to the "Classpath" exception as provided
6.21 - * by Sun in the GPL Version 2 section of the License file that
6.22 - * accompanied this code. If applicable, add the following below the
6.23 - * License Header, with the fields enclosed by brackets [] replaced by
6.24 - * your own identifying information:
6.25 - * "Portions Copyrighted [year] [name of copyright owner]"
6.26 - *
6.27 - * If you wish your version of this file to be governed by only the CDDL
6.28 - * or only the GPL Version 2, indicate your decision by adding
6.29 - * "[Contributor] elects to include this software in this distribution
6.30 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
6.31 - * single choice of license, a recipient has the option to distribute
6.32 - * your version of this file under either the CDDL, the GPL Version 2 or
6.33 - * to extend the choice of license to its licensees as provided above.
6.34 - * However, if you add GPL Version 2 code and therefore, elected the GPL
6.35 - * Version 2 license, then the option applies only if the new code is
6.36 - * made subject to such option by the copyright holder.
6.37 - *
6.38 - * Contributor(s):
6.39 - *
6.40 - * Portions Copyrighted 2007 Sun Microsystems, Inc.
6.41 - */
6.42 -
6.43 -package org.netbeans.modules.hudsonfindbugs;
6.44 -
6.45 -import java.io.File;
6.46 -import java.io.IOException;
6.47 -import java.io.InputStream;
6.48 -import java.lang.ref.Reference;
6.49 -import java.lang.ref.SoftReference;
6.50 -import java.net.URL;
6.51 -import java.util.ArrayList;
6.52 -import java.util.Collection;
6.53 -import java.util.HashMap;
6.54 -import java.util.List;
6.55 -import java.util.Map;
6.56 -import java.util.logging.Level;
6.57 -import java.util.logging.Logger;
6.58 -import javax.xml.parsers.ParserConfigurationException;
6.59 -import javax.xml.parsers.SAXParser;
6.60 -import javax.xml.parsers.SAXParserFactory;
6.61 -import org.netbeans.api.project.FileOwnerQuery;
6.62 -import org.netbeans.api.project.Project;
6.63 -import org.netbeans.modules.hudsonfindbugs.api.FindBugsQuery;
6.64 -import org.netbeans.spi.tasklist.PushTaskScanner;
6.65 -import org.netbeans.spi.tasklist.Task;
6.66 -import org.netbeans.spi.tasklist.TaskScanningScope;
6.67 -import org.openide.filesystems.FileObject;
6.68 -import org.openide.filesystems.FileUtil;
6.69 -import org.openide.util.Exceptions;
6.70 -import org.openide.util.NbBundle;
6.71 -import org.openide.util.RequestProcessor;
6.72 -import org.xml.sax.Attributes;
6.73 -import org.xml.sax.SAXException;
6.74 -import org.xml.sax.helpers.DefaultHandler;
6.75 -
6.76 -/**
6.77 - *
6.78 - * @author Jaroslav Tulach <jtulach@netbeans.org>
6.79 - */
6.80 -final class FindBugsTaskScanner extends PushTaskScanner {
6.81 - private static final RequestProcessor RP = new RequestProcessor("Hudson FindBugs for NetBeans"); // NOI18N
6.82 - private static final Logger LOG = Logger.getLogger(FindBugsTaskScanner.class.getName());
6.83 -
6.84 - FindBugsTaskScanner() {
6.85 - super(
6.86 - NbBundle.getMessage(FindBugsTaskScanner.class, "MSG_NbFindBugs"),
6.87 - "description",
6.88 - "huh"
6.89 - );
6.90 - }
6.91 -
6.92 - public static FindBugsTaskScanner create() {
6.93 - return new FindBugsTaskScanner();
6.94 - }
6.95 -
6.96 -
6.97 - @Override
6.98 - public void setScope(TaskScanningScope scope, Callback callback) {
6.99 - if (scope == null) {
6.100 - ParseRequest req = new ParseRequest();
6.101 - req.callback = callback;
6.102 - RP.post(req);
6.103 - return;
6.104 - } else {
6.105 - Collection<Project> projects = (Collection<Project>) scope.getLookup().lookupAll(Project.class);
6.106 - if ((projects == null) || (projects.isEmpty())) {
6.107 - FileObject file = scope.getLookup().lookup(FileObject.class);
6.108 - if (file != null) {
6.109 - ParseRequest req = new ParseRequest();
6.110 - Project project = FileOwnerQuery.getOwner(file);
6.111 - URL url = FindBugsQuery.getFindBugsUrl(project);
6.112 - if (url != null) {
6.113 - req.projectRoot = file;
6.114 - req.url = url;
6.115 - req.callback = callback;
6.116 - req.scanner = this;
6.117 - RP.post(req);
6.118 - }
6.119 - }
6.120 - } else {
6.121 - for (Project project : projects) {
6.122 - ParseRequest req = new ParseRequest();
6.123 - URL url = FindBugsQuery.getFindBugsUrl(project);
6.124 - if (url == null) {
6.125 - continue;
6.126 - }
6.127 - req.projectRoot = project.getProjectDirectory();
6.128 - req.url = url;
6.129 - req.callback = callback;
6.130 - req.scanner = this;
6.131 - RP.post(req);
6.132 - }
6.133 - }
6.134 - }
6.135 - }
6.136 -
6.137 -
6.138 -
6.139 - final void parse(URL errors, FileObject project, Map<FileObject,List<Task>> cummulate)
6.140 - throws IOException, SAXException, ParserConfigurationException {
6.141 - SAXParser sax = SAXParserFactory.newInstance().newSAXParser();
6.142 - InputStream is = errors.openStream();
6.143 - try {
6.144 - Parse p = new Parse(project, cummulate);
6.145 - sax.parse(is, p);
6.146 - } finally {
6.147 - is.close();
6.148 - }
6.149 -
6.150 - }
6.151 -
6.152 - private static final class ParseRequest implements Runnable {
6.153 - FindBugsTaskScanner scanner;
6.154 - FileObject projectRoot;
6.155 - Callback callback;
6.156 - URL url;
6.157 -
6.158 - public void run() {
6.159 - if (url == null) {
6.160 - if (callback != null) {
6.161 - callback.clearAllTasks();
6.162 - }
6.163 - return;
6.164 - }
6.165 -
6.166 - callback.started();
6.167 - Map<FileObject, List<Task>> map = new HashMap<FileObject, List<Task>>();
6.168 - try {
6.169 - scanner.parse(url, projectRoot, map);
6.170 - for (Map.Entry<FileObject, List<Task>> entry : map.entrySet()) {
6.171 - callback.setTasks(entry.getKey(), entry.getValue());
6.172 - }
6.173 - } catch (IOException ex) {
6.174 - LOG.info(ex.getMessage());
6.175 - LOG.log(Level.FINE, ex.getMessage(), ex);
6.176 - } catch (SAXException ex) {
6.177 - Exceptions.printStackTrace(ex);
6.178 - } catch (ParserConfigurationException ex) {
6.179 - Exceptions.printStackTrace(ex);
6.180 - } finally {
6.181 - callback.finished();
6.182 - }
6.183 - }
6.184 - }
6.185 -
6.186 - private static final class Parse extends DefaultHandler {
6.187 - private final FileObject scope;
6.188 - private final Map<FileObject,List<Task>> cummulate;
6.189 -
6.190 - private String type;
6.191 - private int priority;
6.192 - private String category;
6.193 - private int line;
6.194 - private FileObject src;
6.195 - private Project project;
6.196 -
6.197 - public Parse(FileObject scope, Map<FileObject,List<Task>> cummulate) {
6.198 - this.scope = scope;
6.199 - this.cummulate = cummulate;
6.200 - if (!scope.isFolder()) {
6.201 - this.project = FileOwnerQuery.getOwner(scope);
6.202 - }
6.203 - }
6.204 -
6.205 - @Override
6.206 - public void startDocument () {
6.207 - this.line = -1;
6.208 - this.src = null;
6.209 - }
6.210 -
6.211 - @Override
6.212 - public void startElement(String uri, String localName, String name, Attributes attributes) throws SAXException {
6.213 - if ("BugInstance".equals(name)) {
6.214 - type = attributes.getValue("type");
6.215 - priority = Integer.valueOf(attributes.getValue("priority"));
6.216 - category = attributes.getValue("category");
6.217 - return;
6.218 - }
6.219 - if ("SourceLine".equals(name)) {
6.220 - String lineNumberStr = attributes.getValue("start");
6.221 - if (lineNumberStr != null) {
6.222 - line = Integer.valueOf(attributes.getValue("start"));
6.223 - }
6.224 - String sourcePath = attributes.getValue("sourcepath");
6.225 - if (scope.isFolder()) {
6.226 - src = scope.getFileObject("src/" + sourcePath);
6.227 - } else {
6.228 - File sourceFile = FileUtil.toFile(scope);
6.229 - if (sourceFile.getAbsolutePath().indexOf(sourcePath) > -1) {
6.230 - src = scope;
6.231 - }
6.232 - }
6.233 - }
6.234 - }
6.235 -
6.236 - @Override
6.237 - public void endElement(String uri, String localName, String name) throws SAXException {
6.238 - if ("BugInstance".equals(name)) {
6.239 - if (src != null) {
6.240 - Task t = Task.create(src, "warning", Msgs.getLocalizedMessage(type), line);
6.241 - List<Task> arr = cummulate.get(src);
6.242 - if (arr == null) {
6.243 - arr = new ArrayList<Task>();
6.244 - cummulate.put(src, arr);
6.245 - }
6.246 - arr.add(t);
6.247 - }
6.248 - type = null;
6.249 - priority = -1;
6.250 - category = null;
6.251 - src = null;
6.252 - line = -1;
6.253 - return;
6.254 - }
6.255 - }
6.256 - } // end of Parse
6.257 -
6.258 - private static final class Msgs extends DefaultHandler {
6.259 - private static Reference<Map<String,String>> map;
6.260 - static {
6.261 - map = new SoftReference<Map<String, String>>(null);
6.262 - }
6.263 -
6.264 -
6.265 -
6.266 - public static String getLocalizedMessage(String msg) {
6.267 - Map<String,String> m = map.get();
6.268 - if (m == null) {
6.269 - m = new HashMap<String, String>();
6.270 -
6.271 - InputStream is = Msgs.class.getResourceAsStream("messages.xml");
6.272 - try {
6.273 - SAXParser sax = SAXParserFactory.newInstance().newSAXParser();
6.274 - Msgs p = new Msgs(m);
6.275 - sax.parse(is, p);
6.276 - } catch (SAXException ex) {
6.277 - Exceptions.printStackTrace(ex);
6.278 - } catch (ParserConfigurationException ex) {
6.279 - Exceptions.printStackTrace(ex);
6.280 - } catch (IOException ex) {
6.281 - Exceptions.printStackTrace(ex);
6.282 - } finally {
6.283 - try {
6.284 - is.close();
6.285 - } catch (IOException ex) {
6.286 - Exceptions.printStackTrace(ex);
6.287 - }
6.288 - }
6.289 - map = new SoftReference<Map<String, String>>(m);
6.290 - }
6.291 -
6.292 -
6.293 - String r = m.get(msg);
6.294 - return r != null ? r : msg;
6.295 - }
6.296 -
6.297 -
6.298 - private String type;
6.299 - private StringBuilder text;
6.300 - private Map<String,String> push;
6.301 -
6.302 - private Msgs(Map<String,String> map) {
6.303 - this.push = map;
6.304 - }
6.305 -
6.306 - @Override
6.307 - public void startElement(String uri, String localName, String name, Attributes attributes) throws SAXException {
6.308 - if ("BugPattern".equals(name)) {
6.309 - type = attributes.getValue("type");
6.310 - return;
6.311 - }
6.312 - text = new StringBuilder();
6.313 - }
6.314 -
6.315 - @Override
6.316 - public void endElement(String uri, String localName, String name) throws SAXException {
6.317 - if ("BugPattern".equals(name)) {
6.318 - type = null;
6.319 - return;
6.320 - }
6.321 - if ("ShortDescription".equals(name) && type != null) {
6.322 - push.put(type, text.toString());
6.323 - return;
6.324 - }
6.325 - }
6.326 -
6.327 - @Override
6.328 - public void characters(char[] ch, int start, int length) throws SAXException {
6.329 - if (text != null) {
6.330 - text.append(ch, start, length);
6.331 - }
6.332 - }
6.333 - } // end of Msgs
6.334 -}
7.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/J2seFindBugsQueryProvider.java Sat Aug 10 14:03:03 2013 +0200
7.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
7.3 @@ -1,90 +0,0 @@
7.4 -/*
7.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
7.6 - *
7.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
7.8 - *
7.9 - * The contents of this file are subject to the terms of either the GNU
7.10 - * General Public License Version 2 only ("GPL") or the Common
7.11 - * Development and Distribution License("CDDL") (collectively, the
7.12 - * "License"). You may not use this file except in compliance with the
7.13 - * License. You can obtain a copy of the License at
7.14 - * http://www.netbeans.org/cddl-gplv2.html
7.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
7.16 - * specific language governing permissions and limitations under the
7.17 - * License. When distributing the software, include this License Header
7.18 - * Notice in each file and include the License file at
7.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
7.20 - * particular file as subject to the "Classpath" exception as provided
7.21 - * by Sun in the GPL Version 2 section of the License file that
7.22 - * accompanied this code. If applicable, add the following below the
7.23 - * License Header, with the fields enclosed by brackets [] replaced by
7.24 - * your own identifying information:
7.25 - * "Portions Copyrighted [year] [name of copyright owner]"
7.26 - *
7.27 - * If you wish your version of this file to be governed by only the CDDL
7.28 - * or only the GPL Version 2, indicate your decision by adding
7.29 - * "[Contributor] elects to include this software in this distribution
7.30 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
7.31 - * single choice of license, a recipient has the option to distribute
7.32 - * your version of this file under either the CDDL, the GPL Version 2 or
7.33 - * to extend the choice of license to its licensees as provided above.
7.34 - * However, if you add GPL Version 2 code and therefore, elected the GPL
7.35 - * Version 2 license, then the option applies only if the new code is
7.36 - * made subject to such option by the copyright holder.
7.37 - *
7.38 - * Contributor(s):
7.39 - *
7.40 - * Portions Copyrighted 2007 Sun Microsystems, Inc.
7.41 - */
7.42 -
7.43 -package org.netbeans.modules.hudsonfindbugs;
7.44 -
7.45 -import java.net.MalformedURLException;
7.46 -import java.net.URL;
7.47 -import java.util.logging.Level;
7.48 -import java.util.logging.Logger;
7.49 -import org.netbeans.api.annotations.common.CheckForNull;
7.50 -import org.netbeans.api.project.Project;
7.51 -import org.netbeans.modules.hudsonfindbugs.spi.FindBugsQueryImplementation;
7.52 -import org.netbeans.modules.java.j2seproject.api.J2SEPropertyEvaluator;
7.53 -import org.netbeans.spi.project.ProjectServiceProvider;
7.54 -
7.55 -/**
7.56 - *
7.57 - * @author Martin Grebac
7.58 - */
7.59 -@ProjectServiceProvider(service=FindBugsQueryImplementation.class, projectType="org-netbeans-modules-java-j2seproject")
7.60 -public final class J2seFindBugsQueryProvider implements FindBugsQueryImplementation {
7.61 -
7.62 - private static final Logger LOG = Logger.getLogger(J2seFindBugsQueryProvider.class.getName());
7.63 -
7.64 - private final Project project;
7.65 -
7.66 - public J2seFindBugsQueryProvider(Project project) {
7.67 - this.project = project;
7.68 - }
7.69 -
7.70 - @CheckForNull
7.71 - public URL getFindBugsUrl(boolean remote) {
7.72 - if (!remote) {
7.73 - return null;
7.74 - }
7.75 -
7.76 - URL url = null;
7.77 - String urlValue = null;
7.78 - // TODO when the provider is only in project's lookup this condition is not necessary.
7.79 - J2SEPropertyEvaluator eval = project.getLookup().lookup(J2SEPropertyEvaluator.class);
7.80 - if (eval != null) {
7.81 - try {
7.82 - urlValue = eval.evaluator().getProperty(FINDBUGS_PROJECT_PROPERTY);
7.83 - if (urlValue != null) {
7.84 - url = new URL(urlValue);
7.85 - }
7.86 - } catch (MalformedURLException ex) {
7.87 - LOG.log(Level.INFO, "URL incorrect: {0} {1}", new Object[] {urlValue, ex.getLocalizedMessage()});
7.88 - }
7.89 - }
7.90 - return url;
7.91 - }
7.92 -
7.93 -}
7.94 \ No newline at end of file
8.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/NBMFindBugsQueryProvider.java Sat Aug 10 14:03:03 2013 +0200
8.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
8.3 @@ -1,99 +0,0 @@
8.4 -/*
8.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8.6 - *
8.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
8.8 - *
8.9 - * The contents of this file are subject to the terms of either the GNU
8.10 - * General Public License Version 2 only ("GPL") or the Common
8.11 - * Development and Distribution License("CDDL") (collectively, the
8.12 - * "License"). You may not use this file except in compliance with the
8.13 - * License. You can obtain a copy of the License at
8.14 - * http://www.netbeans.org/cddl-gplv2.html
8.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
8.16 - * specific language governing permissions and limitations under the
8.17 - * License. When distributing the software, include this License Header
8.18 - * Notice in each file and include the License file at
8.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
8.20 - * particular file as subject to the "Classpath" exception as provided
8.21 - * by Sun in the GPL Version 2 section of the License file that
8.22 - * accompanied this code. If applicable, add the following below the
8.23 - * License Header, with the fields enclosed by brackets [] replaced by
8.24 - * your own identifying information:
8.25 - * "Portions Copyrighted [year] [name of copyright owner]"
8.26 - *
8.27 - * If you wish your version of this file to be governed by only the CDDL
8.28 - * or only the GPL Version 2, indicate your decision by adding
8.29 - * "[Contributor] elects to include this software in this distribution
8.30 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
8.31 - * single choice of license, a recipient has the option to distribute
8.32 - * your version of this file under either the CDDL, the GPL Version 2 or
8.33 - * to extend the choice of license to its licensees as provided above.
8.34 - * However, if you add GPL Version 2 code and therefore, elected the GPL
8.35 - * Version 2 license, then the option applies only if the new code is
8.36 - * made subject to such option by the copyright holder.
8.37 - *
8.38 - * Contributor(s):
8.39 - *
8.40 - * Portions Copyrighted 2007 Sun Microsystems, Inc.
8.41 - */
8.42 -
8.43 -package org.netbeans.modules.hudsonfindbugs;
8.44 -
8.45 -import java.io.File;
8.46 -import java.net.MalformedURLException;
8.47 -import java.net.URL;
8.48 -import org.netbeans.api.annotations.common.CheckForNull;
8.49 -import org.netbeans.api.project.Project;
8.50 -import org.netbeans.modules.apisupport.project.spi.NbModuleProvider;
8.51 -import org.netbeans.modules.hudsonfindbugs.spi.FindBugsQueryImplementation;
8.52 -import org.netbeans.spi.project.ProjectServiceProvider;
8.53 -import org.openide.filesystems.FileUtil;
8.54 -import org.openide.util.Exceptions;
8.55 -
8.56 -/**
8.57 - *
8.58 - * @author Martin Grebac
8.59 - */
8.60 -@ProjectServiceProvider(service=FindBugsQueryImplementation.class, projectType="org-netbeans-modules-apisupport-project")
8.61 -public final class NBMFindBugsQueryProvider implements FindBugsQueryImplementation {
8.62 -
8.63 - private final static String NB_HUDSON_FBUGS_URLROOT =
8.64 - "http://qa-findbugs.netbeans.org/job/FindBugsResults/lastSuccessfulBuild/artifact/";
8.65 -
8.66 - private final Project project;
8.67 -
8.68 - public NBMFindBugsQueryProvider(Project project) {
8.69 - this.project = project;
8.70 - }
8.71 -
8.72 - @CheckForNull
8.73 - public URL getFindBugsUrl(boolean remote) {
8.74 - URL url = null;
8.75 - NbModuleProvider prov = project.getLookup().lookup(NbModuleProvider.class);
8.76 - if (prov != null) {
8.77 - if (!remote) {
8.78 - File nbbuild = new File(FileUtil.toFile(project.getProjectDirectory()).getParentFile(), "nbbuild");
8.79 - if (nbbuild.isDirectory()) {
8.80 - File findbugsFile = new File(nbbuild, "build" + File.separator + "findbugs" + File.separator
8.81 - + prov.getCodeNameBase().replace('.', '-') + ".xml");
8.82 - if (findbugsFile.exists() && findbugsFile.isFile() && findbugsFile.canRead()) {
8.83 - try {
8.84 - return findbugsFile.toURI().toURL();
8.85 - } catch (MalformedURLException ex) {
8.86 - Exceptions.printStackTrace(ex);
8.87 - }
8.88 - }
8.89 - }
8.90 - }
8.91 -
8.92 - try {
8.93 - String urlStr = NB_HUDSON_FBUGS_URLROOT + prov.getCodeNameBase().replace('.', '-') + ".xml";
8.94 - url = new URL(urlStr);
8.95 - } catch (MalformedURLException ex) {
8.96 - Exceptions.printStackTrace(ex);
8.97 - }
8.98 - }
8.99 - return url;
8.100 - }
8.101 -
8.102 -}
8.103 \ No newline at end of file
9.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/api/FindBugsQuery.java Sat Aug 10 14:03:03 2013 +0200
9.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
9.3 @@ -1,107 +0,0 @@
9.4 -/*
9.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
9.6 - *
9.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
9.8 - *
9.9 - * The contents of this file are subject to the terms of either the GNU
9.10 - * General Public License Version 2 only ("GPL") or the Common
9.11 - * Development and Distribution License("CDDL") (collectively, the
9.12 - * "License"). You may not use this file except in compliance with the
9.13 - * License. You can obtain a copy of the License at
9.14 - * http://www.netbeans.org/cddl-gplv2.html
9.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
9.16 - * specific language governing permissions and limitations under the
9.17 - * License. When distributing the software, include this License Header
9.18 - * Notice in each file and include the License file at
9.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
9.20 - * particular file as subject to the "Classpath" exception as provided
9.21 - * by Sun in the GPL Version 2 section of the License file that
9.22 - * accompanied this code. If applicable, add the following below the
9.23 - * License Header, with the fields enclosed by brackets [] replaced by
9.24 - * your own identifying information:
9.25 - * "Portions Copyrighted [year] [name of copyright owner]"
9.26 - *
9.27 - * Contributor(s):
9.28 - *
9.29 - * The Original Software is NetBeans. The Initial Developer of the Original
9.30 - * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
9.31 - * Microsystems, Inc. All Rights Reserved.
9.32 - *
9.33 - * If you wish your version of this file to be governed by only the CDDL
9.34 - * or only the GPL Version 2, indicate your decision by adding
9.35 - * "[Contributor] elects to include this software in this distribution
9.36 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
9.37 - * single choice of license, a recipient has the option to distribute
9.38 - * your version of this file under either the CDDL, the GPL Version 2 or
9.39 - * to extend the choice of license to its licensees as provided above.
9.40 - * However, if you add GPL Version 2 code and therefore, elected the GPL
9.41 - * Version 2 license, then the option applies only if the new code is
9.42 - * made subject to such option by the copyright holder.
9.43 - */
9.44 -
9.45 -package org.netbeans.modules.hudsonfindbugs.api;
9.46 -
9.47 -import java.net.URL;
9.48 -import java.util.logging.Level;
9.49 -import java.util.logging.Logger;
9.50 -import org.netbeans.api.annotations.common.CheckForNull;
9.51 -import org.netbeans.api.annotations.common.NonNull;
9.52 -import org.netbeans.api.project.Project;
9.53 -import org.netbeans.modules.hudsonfindbugs.spi.FindBugsQueryImplementation;
9.54 -import org.openide.util.Parameters;
9.55 -
9.56 -/**
9.57 - * Find the Hudson FindBugs scan result files for projects. Files may be located either on
9.58 - * remote server or built locally. IDE-wide proxy settings are used to fetch the remote resource.
9.59 - *
9.60 - * @author Martin Grebac
9.61 - */
9.62 -public class FindBugsQuery {
9.63 -
9.64 - private static final Logger LOG = Logger.getLogger(FindBugsQuery.class.getName());
9.65 -
9.66 - private FindBugsQuery() {}
9.67 -
9.68 - /**
9.69 - * Find the URL for FindBugs Hudson plugin
9.70 - * @param project The project for which FindBugs URL is requested
9.71 - * @param remote Whether remote server URL is requested, or URL for local copy
9.72 - * @return URL to findbugs file for project 'project' or null if the url is not defined. Note the physical resource
9.73 - * itself might not exist.
9.74 - */
9.75 - @CheckForNull
9.76 - public static URL getFindBugsUrl(@NonNull Project project, boolean remote) {
9.77 - Parameters.notNull("project", project);
9.78 - FindBugsQueryImplementation query = project.getLookup().lookup(FindBugsQueryImplementation.class);
9.79 - if (query != null) {
9.80 - URL url = query.getFindBugsUrl(remote);
9.81 - LOG.log(Level.FINE, "getFindBugsUrl({0}, {1}) -> {2}", new Object[] {project.getProjectDirectory(), remote, url});
9.82 - return url;
9.83 - }
9.84 - LOG.log(Level.FINE, "No FBugs query implementation found, returning null for: ", project.getProjectDirectory());
9.85 - return null;
9.86 - }
9.87 -
9.88 - /**
9.89 - * Find the fastest access URL for FindBugs results.
9.90 - * @param project The project for which FindBugs URL is requested
9.91 - * @return Local file if present, otherwise remote file. Null if the url is not defined. Note the physical resource
9.92 - * itself might not exist.
9.93 - */
9.94 - @CheckForNull
9.95 - public static URL getFindBugsUrl(@NonNull Project project) {
9.96 - Parameters.notNull("project", project);
9.97 - FindBugsQueryImplementation query = project.getLookup().lookup(FindBugsQueryImplementation.class);
9.98 - if (query != null) {
9.99 - URL url = query.getFindBugsUrl(false);
9.100 - if (url == null) {
9.101 - url = query.getFindBugsUrl(true);
9.102 - }
9.103 - LOG.log(Level.FINE, "getFindBugsUrl({0}) -> {1}", new Object[] {project.getProjectDirectory(), url});
9.104 - return url;
9.105 - }
9.106 - LOG.log(Level.FINE, "No FBugs query implementation found, returning null for: ", project.getProjectDirectory());
9.107 - return null;
9.108 - }
9.109 -
9.110 -}
10.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/layer.xml Sat Aug 10 14:03:03 2013 +0200
10.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
10.3 @@ -1,12 +0,0 @@
10.4 -<?xml version="1.0" encoding="UTF-8"?>
10.5 -<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.1//EN" "http://www.netbeans.org/dtds/filesystem-1_1.dtd">
10.6 -<filesystem>
10.7 - <folder name="TaskList">
10.8 - <folder name="Scanners">
10.9 - <file name="NetBeansFindBugs.instance">
10.10 - <attr name="instanceOf" stringvalue="org.netbeans.spi.tasklist.FileTaskScanner"/>
10.11 - <attr name="instanceCreate" methodvalue="org.netbeans.modules.hudsonfindbugs.FindBugsTaskScanner.create"/>
10.12 - </file>
10.13 - </folder>
10.14 - </folder>
10.15 -</filesystem>
11.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/messages.xml Sat Aug 10 14:03:03 2013 +0200
11.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
11.3 @@ -1,6095 +0,0 @@
11.4 -<?xml version="1.0" encoding="UTF-8"?>
11.5 -
11.6 -<MessageCollection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
11.7 - xsi:noNamespaceSchemaLocation="messagecollection.xsd">
11.8 -
11.9 - <!--
11.10 - **********************************************************************
11.11 - Plugin information
11.12 - **********************************************************************
11.13 - -->
11.14 - <Plugin>
11.15 - <ShortDescription>Default FindBugs plugin</ShortDescription>
11.16 - <Details>
11.17 -<![CDATA[
11.18 -<p>
11.19 -This plugin contains all of the standard FindBugs detectors.
11.20 -</p>
11.21 -]]>
11.22 - </Details>
11.23 - </Plugin>
11.24 -
11.25 - <!--
11.26 - **********************************************************************
11.27 - Categories (replacing the BugCategoryDescriptions.properties file)
11.28 - **********************************************************************
11.29 - -->
11.30 -
11.31 - <BugCategory category="CORRECTNESS">
11.32 - <Description>Correctness</Description>
11.33 - <Abbreviation>C</Abbreviation>
11.34 - <Details>Probable bug - an apparent coding mistake
11.35 - resulting in code that was probably not what the
11.36 - developer intended. We strive for a low false positive rate.</Details>
11.37 - </BugCategory>
11.38 -
11.39 - <BugCategory category="BAD_PRACTICE">
11.40 - <Description>Bad practice</Description>
11.41 - <Abbreviation>B</Abbreviation>
11.42 - <Details>Violations of recommended and essential
11.43 - coding practice. Examples include hash code and equals
11.44 - problems, cloneable idiom, dropped exceptions,
11.45 - Serializable problems, and misuse of finalize.
11.46 - We strive to make this analysis accurate,
11.47 - although some groups may
11.48 - not care about some of the bad practices.</Details>
11.49 - </BugCategory>
11.50 -
11.51 - <BugCategory category="STYLE">
11.52 - <Description>Dodgy</Description>
11.53 - <Abbreviation>D</Abbreviation>
11.54 - <Details>code that is confusing, anomalous, or
11.55 - written in a way that leads itself to errors.
11.56 - Examples include dead local stores, switch fall through,
11.57 - unconfirmed casts, and redundant null check of value
11.58 - known to be null.
11.59 - More false positives accepted.
11.60 - In previous versions of FindBugs, this category was known as Style.
11.61 -</Details>
11.62 - </BugCategory>
11.63 -
11.64 - <BugCategory category="PERFORMANCE">
11.65 - <Description>Performance</Description>
11.66 - <Abbreviation>P</Abbreviation>
11.67 - <Details>code that is not necessarily incorrect but may be inefficient</Details>
11.68 - </BugCategory>
11.69 -
11.70 - <BugCategory category="MALICIOUS_CODE">
11.71 - <Description>Malicious code vulnerability</Description>
11.72 - <Abbreviation>V</Abbreviation>
11.73 - <Details>code that is vulnerable to attacks from untrusted code</Details>
11.74 - </BugCategory>
11.75 -
11.76 - <BugCategory category="MT_CORRECTNESS">
11.77 - <Description>Multithreaded correctness</Description>
11.78 - <Abbreviation>M</Abbreviation>
11.79 - <Details>code flaws having to do with threads, locks, and volatiles</Details>
11.80 - </BugCategory>
11.81 -
11.82 - <BugCategory category="I18N">
11.83 - <Description>Internationalization</Description>
11.84 - <Abbreviation>I</Abbreviation>
11.85 - <Details>code flaws having to do with internationalization and locale</Details>
11.86 - <!-- DM_CONVERT_CASE is the only core bug pattern in this category -->
11.87 - </BugCategory>
11.88 -
11.89 -
11.90 - <!--
11.91 - **********************************************************************
11.92 - Detectors
11.93 - **********************************************************************
11.94 - -->
11.95 -
11.96 - <Detector class="edu.umd.cs.findbugs.detect.SynchronizeAndNullCheckField">
11.97 - <Details>
11.98 -<![CDATA[
11.99 -<p> This detector looks for a field that is synchronized on and then null checked.</p>
11.100 -]]>
11.101 - </Details>
11.102 - </Detector>
11.103 -
11.104 -
11.105 - <Detector class="edu.umd.cs.findbugs.detect.CheckImmutableAnnotation">
11.106 - <Details>
11.107 -<![CDATA[
11.108 -<p> Looks for violations of the rules for classes annotated as net.jcip.annotations.Immutable.</p>
11.109 -]]>
11.110 - </Details>
11.111 - </Detector>
11.112 - <Detector class="edu.umd.cs.findbugs.detect.VarArgsProblems">
11.113 - <Details>
11.114 -<![CDATA[
11.115 -<p> Looks for problems with arising from Java 1.5 var args.</p>
11.116 -]]>
11.117 - </Details>
11.118 - </Detector>
11.119 - <Detector class="edu.umd.cs.findbugs.detect.NoteJCIPAnnotation">
11.120 - <Details>
11.121 -<![CDATA[
11.122 -<p> Record annotations from the net.jcip.annotations package.</p>
11.123 -]]>
11.124 - </Details>
11.125 - </Detector>
11.126 - <Detector class="edu.umd.cs.findbugs.detect.NoteSuppressedWarnings">
11.127 - <Details>
11.128 -<![CDATA[
11.129 -<p> Suppresses warnings based on use of the edu.umd.cs.findbugs.annotations.NoteSuppressWarnings annotation.</p>
11.130 -]]>
11.131 - </Details>
11.132 - </Detector>
11.133 - <Detector class="edu.umd.cs.findbugs.detect.NoteAnnotationRetention">
11.134 - <Details>
11.135 -<![CDATA[
11.136 -<p> Records annotation retention.</p>
11.137 -]]>
11.138 - </Details>
11.139 - </Detector>
11.140 - <Detector class="edu.umd.cs.findbugs.detect.Methods">
11.141 - <Details>
11.142 -<![CDATA[
11.143 -<p> Builds of database of all methods defined in analyzed classes, for use
11.144 -by other detectors.</p>
11.145 -]]>
11.146 - </Details>
11.147 - </Detector>
11.148 - <Detector class="edu.umd.cs.findbugs.detect.CalledMethods">
11.149 - <Details>
11.150 -<![CDATA[
11.151 -<p> Builds of database of all methods invoked in analyzed classes, for use
11.152 -by other detectors.</p>
11.153 -]]>
11.154 - </Details>
11.155 - </Detector>
11.156 - <Detector class="edu.umd.cs.findbugs.detect.ConfusionBetweenInheritedAndOuterMethod">
11.157 - <Details>
11.158 -<![CDATA[
11.159 -<p> Looks for potential confusion between inherited and outer methods.</p>
11.160 -]]>
11.161 - </Details>
11.162 - </Detector>
11.163 -
11.164 - <Detector class="edu.umd.cs.findbugs.detect.NoteCheckReturnValue">
11.165 - <Details>
11.166 -<![CDATA[
11.167 -<p> Looks for annotations to check return values of a method.
11.168 -</p>
11.169 -]]>
11.170 - </Details>
11.171 - </Detector>
11.172 -
11.173 - <Detector class="edu.umd.cs.findbugs.detect.NoteCheckReturnValueAnnotations">
11.174 - <Details>
11.175 -<![CDATA[
11.176 -<p> Looks for annotations to check return values of a method.
11.177 -</p>
11.178 -]]>
11.179 - </Details>
11.180 - </Detector>
11.181 -
11.182 - <Detector class="edu.umd.cs.findbugs.detect.NoteNonNullAnnotations">
11.183 - <Details>
11.184 - <![CDATA[
11.185 - <p>
11.186 - Looks for @NonNull annotations on methods, fields, and parameters.
11.187 - These can be used by the FindNullDeref detector to generate warnings
11.188 - when a possibly-null value is used in a context where only
11.189 - non-null values should be used.
11.190 - </p>
11.191 - ]]>
11.192 - </Details>
11.193 - </Detector>
11.194 -
11.195 - <Detector class="edu.umd.cs.findbugs.detect.NoteUnconditionalParamDerefs">
11.196 - <Details>
11.197 - <![CDATA[
11.198 - <p>
11.199 - Analyze all methods in the application to determine which
11.200 - dereference parameters unconditionally. This information is used in
11.201 - a later analysis pass to find call sites where null values may
11.202 - be passed to those methods.
11.203 - </p>
11.204 - <p>
11.205 - This is a slow detector.
11.206 - </p>
11.207 - ]]>
11.208 - </Details>
11.209 - </Detector>
11.210 -
11.211 - <Detector class="edu.umd.cs.findbugs.detect.NoteNonnullReturnValues">
11.212 - <Details>
11.213 - <![CDATA[
11.214 - <p>
11.215 - Analyze all methods in the application to determine which
11.216 - methods always return nonnull values.
11.217 - </p>
11.218 - ]]>
11.219 - </Details>
11.220 - </Detector>
11.221 -
11.222 - <Detector class="edu.umd.cs.findbugs.detect.BadUseOfReturnValue">
11.223 - <Details>
11.224 -<![CDATA[
11.225 -<p> Looks for cases where the return value of a function is discarded
11.226 -after being checked for non-null. </p>
11.227 -
11.228 -]]>
11.229 - </Details>
11.230 - </Detector>
11.231 - <Detector class="edu.umd.cs.findbugs.detect.InheritanceUnsafeGetResource">
11.232 - <Details>
11.233 -<![CDATA[
11.234 -<p> Looks for uses of this.getClass().getResource(...), which can give
11.235 -unexpected results if the class is extended by a class in
11.236 -another package. It is a fast detector</p>
11.237 -
11.238 -]]>
11.239 - </Details>
11.240 - </Detector>
11.241 - <Detector class="edu.umd.cs.findbugs.detect.InfiniteRecursiveLoop">
11.242 - <Details>
11.243 -<![CDATA[
11.244 -<p> Looks for an infinite recursive loop. It is a fast detector.</p>
11.245 -]]>
11.246 - </Details>
11.247 - </Detector>
11.248 - <Detector class="edu.umd.cs.findbugs.detect.InfiniteLoop">
11.249 - <Details>
11.250 -<![CDATA[
11.251 -<p> Looks for an infinite loop. It is a fast detector.</p>
11.252 -]]>
11.253 - </Details>
11.254 - </Detector>
11.255 -
11.256 - <Detector class="edu.umd.cs.findbugs.detect.InfiniteRecursiveLoop2">
11.257 - <Details>
11.258 -<![CDATA[
11.259 -<p>Looks for an infinite recursive loop. It is a slow detector.</p>
11.260 -]]>
11.261 - </Details>
11.262 - </Detector>
11.263 -
11.264 - <Detector class="edu.umd.cs.findbugs.detect.VolatileUsage">
11.265 - <Details>
11.266 -<![CDATA[
11.267 -<p> Looks for bug patterns in the usage of volatile fields. It is a fast detector.</p>
11.268 -]]>
11.269 - </Details>
11.270 - </Detector>
11.271 -
11.272 - <Detector class="edu.umd.cs.findbugs.detect.EmptyZipFileEntry">
11.273 - <Details>
11.274 -<![CDATA[
11.275 -<p> This looks for creation of empty zip file entries. It is a moderately fast detector.</p>
11.276 -]]>
11.277 - </Details>
11.278 - </Detector>
11.279 -
11.280 - <Detector class="edu.umd.cs.findbugs.detect.UncallableMethodOfAnonymousClass">
11.281 - <Details>
11.282 -<![CDATA[
11.283 -<p> This detector looks for anonymous inner classes that define methods
11.284 -that are probably intended to but do not override methods in a superclass.
11.285 -</p>
11.286 -]]>
11.287 - </Details>
11.288 - </Detector>
11.289 -
11.290 - <Detector class="edu.umd.cs.findbugs.detect.DontUseEnum">
11.291 - <Details>
11.292 -<![CDATA[
11.293 -<p>Checks that fields and methods don't use the name assert or enum as they are keywords in Java 5.</p>
11.294 -]]>
11.295 - </Details>
11.296 - </Detector>
11.297 -
11.298 - <Detector class="edu.umd.cs.findbugs.detect.URLProblems">
11.299 - <Details>
11.300 -<![CDATA[
11.301 -<p> The equals and hashCode method on <code>java.net.URL</code> resolve
11.302 -the domain name. As a result, these operations can be very expensive, and this
11.303 -detector looks for places where those methods might be invoked.
11.304 -</p>
11.305 -]]>
11.306 - </Details>
11.307 - </Detector>
11.308 -
11.309 - <Detector class="edu.umd.cs.findbugs.detect.FinalizerNullsFields">
11.310 - <Details>
11.311 -<![CDATA[
11.312 -<p> This detector looks for finalizers that null out fields of a class.
11.313 -This does not help the garbage collector in any way, the nulling out of fields has no effect.
11.314 -</p>
11.315 -]]>
11.316 - </Details>
11.317 - </Detector>
11.318 -
11.319 - <Detector class="edu.umd.cs.findbugs.detect.TestingGround">
11.320 - <Details>
11.321 -<![CDATA[
11.322 -<p> This detector is just a hook for testing new detectors.
11.323 -Normally, this detector does nothing.</p>
11.324 -]]>
11.325 - </Details>
11.326 - </Detector>
11.327 -
11.328 -
11.329 - <Detector class="edu.umd.cs.findbugs.detect.HugeSharedStringConstants">
11.330 - <Details>
11.331 -<![CDATA[
11.332 -<p> This detector looks for string constants that are duplicated across multiple classfiles.
11.333 -</p>
11.334 -]]>
11.335 - </Details>
11.336 - </Detector>
11.337 -
11.338 -
11.339 -
11.340 - <Detector class="edu.umd.cs.findbugs.detect.DoInsideDoPrivileged">
11.341 - <Details>
11.342 -<![CDATA[
11.343 -<p> Look for code that should be executed inside doPrivileged blocks.</p>
11.344 -]]>
11.345 - </Details>
11.346 - </Detector>
11.347 -
11.348 - <Detector class="edu.umd.cs.findbugs.detect.ResolveAllReferences">
11.349 - <Details>
11.350 -<![CDATA[
11.351 -<p> Checks that all references call be resolved. </p>
11.352 -]]>
11.353 - </Details>
11.354 - </Detector>
11.355 -
11.356 -
11.357 - <Detector class="edu.umd.cs.findbugs.detect.SwitchFallthrough">
11.358 - <Details>
11.359 -<![CDATA[
11.360 -<p> This detector looks for switch statements containing fall through.
11.361 -It is a fast detector.</p>
11.362 -]]>
11.363 - </Details>
11.364 - </Detector>
11.365 -
11.366 - <Detector class="edu.umd.cs.findbugs.detect.FindFieldSelfAssignment">
11.367 - <Details>
11.368 -<![CDATA[
11.369 -<p> This detector looks for places where a field is assigned
11.370 -by reading the value of the same field. It is a fast detector.</p>
11.371 -]]>
11.372 - </Details>
11.373 - </Detector>
11.374 -
11.375 - <Detector class="edu.umd.cs.findbugs.detect.FindSelfComparison">
11.376 - <Details>
11.377 -<![CDATA[
11.378 -<p> This detector looks for places where a value is compared with itself.</p>
11.379 -]]>
11.380 - </Details>
11.381 - </Detector>
11.382 -
11.383 - <Detector class="edu.umd.cs.findbugs.detect.FindSelfComparison2">
11.384 - <Details>
11.385 -<![CDATA[
11.386 -<p> This detector looks for places where a value is compared with itself.</p>
11.387 -]]>
11.388 - </Details>
11.389 - </Detector>
11.390 -
11.391 - <Detector class="edu.umd.cs.findbugs.detect.FindNonShortCircuit">
11.392 - <Details>
11.393 -<![CDATA[
11.394 -<p> This detector looks for suspicious uses of non-short-circuiting
11.395 -boolean operators (<code>|</code> and <code>&</code> instead of
11.396 -<code>||</code> and <code>&&</code>).</p>
11.397 -]]>
11.398 - </Details>
11.399 - </Detector>
11.400 -
11.401 - <Detector class="edu.umd.cs.findbugs.detect.DontCatchIllegalMonitorStateException">
11.402 - <Details>
11.403 -<![CDATA[
11.404 -<p> This detector looks for try-catch blocks that catch an IllegalMonitorStateException.</p>
11.405 -]]>
11.406 - </Details>
11.407 - </Detector>
11.408 -
11.409 - <Detector class="edu.umd.cs.findbugs.detect.FindFloatMath">
11.410 - <Details>
11.411 -<![CDATA[
11.412 -<p> This detector looks for uses of floating point math. It is a moderately fast detector.</p>
11.413 -]]>
11.414 - </Details>
11.415 - </Detector>
11.416 - <Detector class="edu.umd.cs.findbugs.detect.CloneIdiom">
11.417 - <Details>
11.418 -<![CDATA[
11.419 -<p> This detector looks for violations of the idioms for writing
11.420 -cloneable classes. It is a fast detector.</p>
11.421 -]]>
11.422 - </Details>
11.423 - </Detector>
11.424 - <Detector class="edu.umd.cs.findbugs.detect.ComparatorIdiom">
11.425 - <Details>
11.426 -<![CDATA[
11.427 -<p> This detector looks for violations of the idioms for writing
11.428 -classes that implement <code>Comparator</code>. It is a fast detector.</p>
11.429 -]]>
11.430 - </Details>
11.431 - </Detector>
11.432 - <Detector class="edu.umd.cs.findbugs.detect.DroppedException">
11.433 - <Details>
11.434 -<![CDATA[
11.435 -<p> This detector looks for code where an exception is caught,
11.436 -but nothing is done to handle the exception. It is a fast detector.</p>
11.437 -]]>
11.438 - </Details>
11.439 - </Detector>
11.440 - <Detector class="edu.umd.cs.findbugs.detect.LoadOfKnownNullValue">
11.441 - <Details>
11.442 -<![CDATA[
11.443 -<p> Looks for loads of values known to be null.
11.444 -</p>
11.445 -]]>
11.446 - </Details>
11.447 - </Detector>
11.448 - <Detector class="edu.umd.cs.findbugs.detect.DumbMethodInvocations">
11.449 - <Details>
11.450 -<![CDATA[
11.451 -<p> This detector looks for bad arguments being passed to methods
11.452 -(e.g., substring(0)).
11.453 -</p>
11.454 -]]>
11.455 - </Details>
11.456 - </Detector>
11.457 - <Detector class="edu.umd.cs.findbugs.detect.DumbMethods">
11.458 - <Details>
11.459 -<![CDATA[
11.460 -<p> This detector looks for calls to pointless methods,
11.461 -such as the no-argument String constructor.
11.462 -It is a fast detector.</p>
11.463 -]]>
11.464 - </Details>
11.465 - </Detector>
11.466 -
11.467 - <Detector class="edu.umd.cs.findbugs.detect.NumberConstructor">
11.468 - <Details>
11.469 -<![CDATA[
11.470 -<p> Looks for calls to Number constructors with primitive arguments.
11.471 -It is a fast detector</p>
11.472 -]]>
11.473 - </Details>
11.474 - </Detector>
11.475 -
11.476 - <Detector class="edu.umd.cs.findbugs.detect.FindDoubleCheck" >
11.477 - <Details>
11.478 -<![CDATA[
11.479 -<p> This detector looks for instances of double checked locking.
11.480 -It is a fast detector.</p>
11.481 -]]>
11.482 - </Details>
11.483 - </Detector>
11.484 -
11.485 - <Detector class="edu.umd.cs.findbugs.detect.FindFinalizeInvocations" >
11.486 - <Details>
11.487 -<![CDATA[
11.488 -<p> This detector looks for calls to finalize() and other finalizer-related
11.489 -issues. It is a fast detector.</p>
11.490 -]]>
11.491 - </Details>
11.492 - </Detector>
11.493 -
11.494 - <Detector class="edu.umd.cs.findbugs.detect.FindHEmismatch" >
11.495 - <Details>
11.496 -<![CDATA[
11.497 -<p> This detector looks for problems in the definition of the hashCode() and equals()
11.498 -methods. It is a fast detector.</p>
11.499 -]]>
11.500 - </Details>
11.501 - </Detector>
11.502 -
11.503 - <Detector class="edu.umd.cs.findbugs.detect.FindNakedNotify" >
11.504 - <Details>
11.505 -<![CDATA[
11.506 -<p> This detector looks for calls to notify() that don't seem
11.507 -to modify mutable object state. It is a fast detector.</p>
11.508 -]]>
11.509 - </Details>
11.510 - </Detector>
11.511 -
11.512 - <Detector class="edu.umd.cs.findbugs.detect.FindReturnRef" >
11.513 - <Details>
11.514 -<![CDATA[
11.515 -<p> This detector looks for methods that return mutable static data.
11.516 -It is a fast detector.</p>
11.517 -]]>
11.518 - </Details>
11.519 - </Detector>
11.520 -
11.521 - <Detector class="edu.umd.cs.findbugs.detect.FindRunInvocations" >
11.522 - <Details>
11.523 -<![CDATA[
11.524 -<p> This detector looks for calls to Thread.run(). It is a fast
11.525 -detector.</p>
11.526 -]]>
11.527 - </Details>
11.528 - </Detector>
11.529 -
11.530 - <Detector class="edu.umd.cs.findbugs.detect.FindSpinLoop" >
11.531 - <Details>
11.532 -<![CDATA[
11.533 -<p> This detector looks for loops that spin reading from a field.
11.534 -It is a fast detector.</p>
11.535 -]]>
11.536 - </Details>
11.537 - </Detector>
11.538 -
11.539 - <Detector class="edu.umd.cs.findbugs.detect.FindTwoLockWait" >
11.540 - <Details>
11.541 -<![CDATA[
11.542 -<p> This detector looks for calls to wait() with two (or more) locks held.
11.543 -It is a slow detector.</p>
11.544 -]]>
11.545 - </Details>
11.546 - </Detector>
11.547 -
11.548 - <Detector class="edu.umd.cs.findbugs.detect.FindUnconditionalWait" >
11.549 - <Details>
11.550 -<![CDATA[
11.551 -<p> This detector looks for calls to wait() not in a conditional or loop.
11.552 -It is a fast detector.</p>
11.553 -]]>
11.554 - </Details>
11.555 - </Detector>
11.556 -
11.557 - <Detector class="edu.umd.cs.findbugs.detect.FindUninitializedGet" >
11.558 - <Details>
11.559 -<![CDATA[
11.560 -<p> This detector looks for reads of uninitialized fields in constructors.
11.561 -It is a fast detector.</p>
11.562 -]]>
11.563 - </Details>
11.564 - </Detector>
11.565 -
11.566 - <Detector class="edu.umd.cs.findbugs.detect.FindUnsyncGet" >
11.567 - <Details>
11.568 -<![CDATA[
11.569 -<p> This detector looks for get and set methods where the get is unsynchronized
11.570 -while the set is synchronized. It is a fast detector.</p>
11.571 -]]>
11.572 - </Details>
11.573 - </Detector>
11.574 -
11.575 - <Detector class="edu.umd.cs.findbugs.detect.InitializationChain" >
11.576 - <Details>
11.577 -<![CDATA[
11.578 -<p> This detector looks for potentially circular class initialization
11.579 -dependencies. It is a fast detector.</p>
11.580 -]]>
11.581 - </Details>
11.582 - </Detector>
11.583 -
11.584 - <Detector class="edu.umd.cs.findbugs.detect.IteratorIdioms" >
11.585 - <Details>
11.586 -<![CDATA[
11.587 -<p> This iterator looks for problems in how Iterator classes are defined.
11.588 -It is a fast detector.</p>
11.589 -]]>
11.590 - </Details>
11.591 - </Detector>
11.592 -
11.593 - <Detector class="edu.umd.cs.findbugs.detect.LockedFields" >
11.594 - <Details>
11.595 -<![CDATA[
11.596 -<p> This detector looks for fields that are accessed in an inconsistent manner
11.597 -with respect to locking. It is a fast detector.</p>
11.598 -]]>
11.599 - </Details>
11.600 - </Detector>
11.601 -
11.602 - <Detector class="edu.umd.cs.findbugs.detect.EqStringTest" >
11.603 - <Details>
11.604 -<![CDATA[
11.605 -<p> This detector looks for comparisons of String objects using the == or !=
11.606 -operators.
11.607 - It is a fast detector.</p>
11.608 -]]>
11.609 - </Details>
11.610 - </Detector>
11.611 -
11.612 - <Detector class="edu.umd.cs.findbugs.detect.MutableLock" >
11.613 - <Details>
11.614 -<![CDATA[
11.615 -<p> This detector looks for synchronization on objects read from
11.616 -modified fields. It is a fast detector.</p>
11.617 -]]>
11.618 - </Details>
11.619 - </Detector>
11.620 -
11.621 - <Detector class="edu.umd.cs.findbugs.detect.MutableStaticFields" >
11.622 - <Details>
11.623 -<![CDATA[
11.624 -<p> This detector looks for static fields that may be modified by
11.625 -malicious code. It is a fast detector.</p>
11.626 -]]>
11.627 - </Details>
11.628 - </Detector>
11.629 -
11.630 - <Detector class="edu.umd.cs.findbugs.detect.Naming" >
11.631 - <Details>
11.632 -<![CDATA[
11.633 -<p> This detector looks for suspiciously-named methods. It is a fast detector.</p>
11.634 -]]>
11.635 - </Details>
11.636 - </Detector>
11.637 -
11.638 - <Detector class="edu.umd.cs.findbugs.detect.ReadReturnShouldBeChecked" >
11.639 - <Details>
11.640 -<![CDATA[
11.641 -<p> This detector looks for calls to InputStream.read() or InputStream.skip() where the
11.642 -return value is ignored. It is a fast detector.</p>
11.643 -]]>
11.644 - </Details>
11.645 - </Detector>
11.646 -
11.647 - <Detector class="edu.umd.cs.findbugs.detect.SerializableIdiom" >
11.648 - <Details>
11.649 -<![CDATA[
11.650 -<p> This detector looks for potential problems in the implementation
11.651 -of Serializable classes. It is a fast detector.</p>
11.652 -]]>
11.653 - </Details>
11.654 - </Detector>
11.655 -
11.656 - <Detector class="edu.umd.cs.findbugs.detect.StartInConstructor" >
11.657 - <Details>
11.658 -<![CDATA[
11.659 -<p> This detector looks for constructors that start threads. It is a fast detector.</p>
11.660 -]]>
11.661 - </Details>
11.662 - </Detector>
11.663 -
11.664 - <Detector class="edu.umd.cs.findbugs.detect.FindBadForLoop" >
11.665 - <Details>
11.666 -<![CDATA[
11.667 -<p> This detector looks for incorrect for loops.
11.668 -</p>
11.669 -]]>
11.670 - </Details>
11.671 - </Detector>
11.672 - <Detector class="edu.umd.cs.findbugs.detect.UnreadFields" >
11.673 - <Details>
11.674 -<![CDATA[
11.675 -<p> This detector looks for fields whose value is never read. It is a fast detector.</p>
11.676 -]]>
11.677 - </Details>
11.678 - </Detector>
11.679 -
11.680 - <Detector class="edu.umd.cs.findbugs.detect.WaitInLoop" >
11.681 - <Details>
11.682 -<![CDATA[
11.683 -<p> This detector looks for calls to wait() that are not in a loop.
11.684 -It is a fast detector.</p>
11.685 -]]>
11.686 - </Details>
11.687 - </Detector>
11.688 -
11.689 - <Detector class="edu.umd.cs.findbugs.detect.BCPMethodReturnCheck" >
11.690 - <Details>
11.691 -<![CDATA[
11.692 -<p> This detector looks for calls to methods where the return value
11.693 -is suspiciously ignored. It is a slow detector.</p>
11.694 -]]>
11.695 - </Details>
11.696 - </Detector>
11.697 -
11.698 - <Detector class="edu.umd.cs.findbugs.detect.FindNullDeref">
11.699 - <Details>
11.700 -<![CDATA[
11.701 -<p> This detector looks for places where a null pointer exception might
11.702 -occur. It also looks for redundant comparisons of reference values against
11.703 -null. It is a slow detector.</p>
11.704 -]]>
11.705 - </Details>
11.706 - </Detector>
11.707 -
11.708 - <Detector class="edu.umd.cs.findbugs.detect.FindOpenStream">
11.709 - <Details>
11.710 -<![CDATA[
11.711 -<p> This detector looks for IO stream objects which do not escape the
11.712 -method and do not appear to be closed on all paths out of the method.
11.713 -It is a slow detector.</p>
11.714 -]]>
11.715 - </Details>
11.716 - </Detector>
11.717 -
11.718 - <Detector class="edu.umd.cs.findbugs.detect.PreferZeroLengthArrays">
11.719 - <Details>
11.720 -<![CDATA[
11.721 -<p> This detector looks for methods that return either arrays or an explicit null reference.
11.722 -Returning a zero length array is generally preferred in this context to returning a null reference.
11.723 -It is a fast detector.</p>
11.724 -]]>
11.725 - </Details>
11.726 - </Detector>
11.727 -
11.728 - <Detector class="edu.umd.cs.findbugs.detect.FindUselessControlFlow">
11.729 - <Details>
11.730 -<![CDATA[
11.731 -<p> This detector looks for control flow statements which have no effect.
11.732 -It is a fast detector.</p>
11.733 -]]>
11.734 - </Details>
11.735 - </Detector>
11.736 -
11.737 - <Detector class="edu.umd.cs.findbugs.detect.FindUnreleasedLock">
11.738 - <Details>
11.739 -<![CDATA[
11.740 -<p> This detector looks for JSR-166 (<code>java.util.concurrent</code>)
11.741 -locks which are acquired, but not released on all paths out of the method.
11.742 -It is a moderately fast detector. Note that in order to use this
11.743 -detector, you need to have the <code>java.util.concurrent</code> package
11.744 -in the auxiliary classpath (or be analyzing the package itself).</p>
11.745 -]]>
11.746 - </Details>
11.747 - </Detector>
11.748 -
11.749 - <Detector class="edu.umd.cs.findbugs.detect.FindRefComparison">
11.750 - <Details>
11.751 -<![CDATA[
11.752 -<p> This detector looks for places where two reference values are compared
11.753 -with the == or != operator, and the class is of a type (such as <code>java.lang.String</code>)
11.754 -where comparing reference values is generally an error. It is a slow detector.</p>
11.755 -]]>
11.756 - </Details>
11.757 - </Detector>
11.758 -
11.759 - <Detector class="edu.umd.cs.findbugs.detect.FindMismatchedWaitOrNotify">
11.760 - <Details>
11.761 -<![CDATA[
11.762 -<p> This detector looks for calls to wait(), notify(), or notifyAll()
11.763 -which do not appear to be made on an object which is currently locked.
11.764 -It is a moderately fast detector. <b>This detector is disabled because
11.765 -it is still under development, and produces too many false positives.</b></p>
11.766 -]]>
11.767 - </Details>
11.768 - </Detector>
11.769 -
11.770 - <Detector class="edu.umd.cs.findbugs.detect.FindEmptySynchronizedBlock" >
11.771 - <Details>
11.772 -<![CDATA[
11.773 -<p> This detector looks for empty synchronized blocks.</p>
11.774 -]]>
11.775 - </Details>
11.776 - </Detector>
11.777 -
11.778 - <Detector class="edu.umd.cs.findbugs.detect.FindInconsistentSync2" >
11.779 - <Details>
11.780 -<![CDATA[
11.781 -<p> This detector looks for fields that are accessed in an inconsistent manner
11.782 -with respect to locking. It is a slow detector.</p>
11.783 -]]>
11.784 - </Details>
11.785 - </Detector>
11.786 -
11.787 - <Detector class="edu.umd.cs.findbugs.detect.FindLocalSelfAssignment2">
11.788 - <Details>
11.789 -<![CDATA[
11.790 -<p> This detector looks for self assignments of local variables.
11.791 -It is a fast detector.</p>
11.792 -]]>
11.793 - </Details>
11.794 - </Detector>
11.795 -
11.796 - <Detector class="edu.umd.cs.findbugs.detect.IncompatMask">
11.797 - <Details>
11.798 -<![CDATA[
11.799 -<p> This detector looks for suspicious bitwise logical expressions.
11.800 -It is a fast detector.</p>
11.801 -]]>
11.802 - </Details>
11.803 - </Detector>
11.804 -
11.805 - <Detector class="edu.umd.cs.findbugs.detect.LazyInit">
11.806 - <Details>
11.807 -<![CDATA[
11.808 -<p> This detector looks for lazy field initialization where the
11.809 -field is not volatile. It is a moderately fast detector.</p>
11.810 -]]>
11.811 - </Details>
11.812 - </Detector>
11.813 -
11.814 - <Detector class="edu.umd.cs.findbugs.detect.FindJSR166LockMonitorenter">
11.815 - <Details>
11.816 -<![CDATA[
11.817 -<p> This detector looks for ordinary synchronization performed
11.818 -on JSR166 locks. It is a moderately fast detector.</p>
11.819 -]]>
11.820 - </Details>
11.821 - </Detector>
11.822 -
11.823 - <Detector class="edu.umd.cs.findbugs.detect.FindUncalledPrivateMethods">
11.824 - <Details>
11.825 -<![CDATA[
11.826 -<p> This detector looks for private methods that are never called.
11.827 -It is a fast detector.</p>
11.828 -]]>
11.829 - </Details>
11.830 - </Detector>
11.831 -
11.832 - <Detector class="edu.umd.cs.findbugs.detect.StringConcatenation">
11.833 - <Details>
11.834 -<![CDATA[
11.835 -<p> This detector looks for String concatenation in loops using +.
11.836 -It is a fast detector.</p>
11.837 -]]>
11.838 - </Details>
11.839 - </Detector>
11.840 -
11.841 - <Detector class="edu.umd.cs.findbugs.detect.InefficientToArray">
11.842 - <Details>
11.843 -<![CDATA[
11.844 -<p> This detector looks for code that converts Collections to arrays
11.845 -using the toArray() method that takes a prototype array, passing
11.846 -an array argument which is zero-length.
11.847 -It is a fast detector.</p>
11.848 -]]>
11.849 - </Details>
11.850 - </Detector>
11.851 -
11.852 - <Detector class="edu.umd.cs.findbugs.detect.InvalidJUnitTest">
11.853 - <Details>
11.854 -<![CDATA[
11.855 -<p> This detector looks for JUnit tests that are malformed.
11.856 -It is a fast detector.</p>
11.857 -]]>
11.858 - </Details>
11.859 - </Detector>
11.860 -
11.861 - <Detector class="edu.umd.cs.findbugs.detect.BadlyOverriddenAdapter">
11.862 - <Details>
11.863 -<![CDATA[
11.864 -<p> This detector looks for code that extends an Adapter class and overrides a Listener
11.865 -method with the wrong signature. It is a fast detector.</p>
11.866 -]]>
11.867 - </Details>
11.868 - </Detector>
11.869 -
11.870 - <Detector class="edu.umd.cs.findbugs.detect.BadResultSetAccess">
11.871 - <Details>
11.872 -<![CDATA[
11.873 -<p> This detector looks for calls to getXXX or setXXX methods of a result set where the
11.874 -field index is 0. As ResultSet fields start at index 1, this is always a mistake.
11.875 -It is a fast detector.</p>
11.876 -]]>
11.877 - </Details>
11.878 - </Detector>
11.879 -
11.880 - <Detector class="edu.umd.cs.findbugs.detect.SuperfluousInstanceOf">
11.881 - <Details>
11.882 -<![CDATA[
11.883 -<p> This detector looks for type checks using the instanceof operator where the determination
11.884 -can be done statically. It is a fast detector.</p>
11.885 -]]>
11.886 - </Details>
11.887 - </Detector>
11.888 -
11.889 - <Detector class="edu.umd.cs.findbugs.detect.BadAppletConstructor">
11.890 - <Details>
11.891 -<![CDATA[
11.892 -<p>
11.893 -This detector looks for Applet constructors that call methods in the parent
11.894 -Applet that rely on the Applet stub. Since this stub isn't initialized until just
11.895 -before the init() method, these methods will fail in the constructor. It is a fast detector.
11.896 -</p>
11.897 -]]>
11.898 - </Details>
11.899 - </Detector>
11.900 -
11.901 - <Detector class="edu.umd.cs.findbugs.detect.UseObjectEquals">
11.902 - <Details>
11.903 -<![CDATA[
11.904 -<p>
11.905 -This detector looks calls to equals(java.lang.Object) on arrays, or final classes that do not
11.906 -override the equals method in the Object class. This means that equals semantics is the same as
11.907 -==, and probably a mistake.
11.908 -</p>
11.909 -]]>
11.910 - </Details>
11.911 - </Detector>
11.912 - <Detector class="edu.umd.cs.findbugs.detect.SuspiciousThreadInterrupted">
11.913 - <Details>
11.914 -<![CDATA[
11.915 -<p>
11.916 -This detector looks for calls to Thread.interrupted() from a non static context. If it is called from
11.917 -Thread.currentThread().interrupted(), then it is just a useless exercise, just use Thread.interrupted().
11.918 -However if it is called on an arbitrary thread object, it is most probably an error, as interrupted()
11.919 -is always called on the current thread.
11.920 -</p>
11.921 -]]>
11.922 - </Details>
11.923 - </Detector>
11.924 -
11.925 -<Detector class="edu.umd.cs.findbugs.detect.FindSqlInjection">
11.926 -<Details>
11.927 -<![CDATA[
11.928 -<p>
11.929 -This detector uses data flow analysis to look for invocations of execute methods
11.930 -on SQL statements in switch something other than a constant string is passed as an argument.
11.931 -</p>
11.932 -]]>
11.933 - </Details>
11.934 - </Detector>
11.935 -
11.936 -<Detector class="edu.umd.cs.findbugs.detect.FindDeadLocalStores">
11.937 -<Details>
11.938 -<![CDATA[
11.939 -<p>
11.940 -This detector looks for assignments to local variables that
11.941 -are never subsequently read. It is a moderately fast detector.
11.942 -</p>
11.943 -]]>
11.944 - </Details>
11.945 - </Detector>
11.946 -
11.947 - <Detector class="edu.umd.cs.findbugs.detect.FindMaskedFields">
11.948 - <Details>
11.949 -<![CDATA[
11.950 -<p> This detector looks for class level fields that are masked by
11.951 -local fields defined in methods.
11.952 -It is a fast detector.</p>
11.953 -]]>
11.954 - </Details>
11.955 - </Detector>
11.956 -
11.957 - <Detector class="edu.umd.cs.findbugs.detect.WrongMapIterator">
11.958 - <Details>
11.959 -<![CDATA[
11.960 -<p> This detector looks for accessing the value of a Map entry, using a key that was retrieved from
11.961 -a keySet iterator. It is a fast detector.</p>
11.962 -]]>
11.963 - </Details>
11.964 - </Detector>
11.965 -
11.966 - <Detector class="edu.umd.cs.findbugs.detect.InstantiateStaticClass">
11.967 - <Details>
11.968 -<![CDATA[
11.969 -<p> This detector looks for code that creates objects based on classes that only define static methods.
11.970 -It is a fast detector.</p>
11.971 -]]>
11.972 - </Details>
11.973 - </Detector>
11.974 -
11.975 - <Detector class="edu.umd.cs.findbugs.detect.RuntimeExceptionCapture">
11.976 - <Details>
11.977 -<![CDATA[
11.978 -<p> This detector looks for catch clauses that catch Exception,
11.979 -when no code in the block throws Exception. </p>
11.980 -]]>
11.981 - </Details>
11.982 - </Detector>
11.983 -
11.984 - <Detector class="edu.umd.cs.findbugs.detect.FindFloatEquality">
11.985 - <Details>
11.986 -<![CDATA[
11.987 -<p> Looks for floating point equality expressions. A fast detector. </p>
11.988 -]]>
11.989 - </Details>
11.990 - </Detector>
11.991 -
11.992 - <Detector class="edu.umd.cs.findbugs.detect.FindUnsatisfiedObligation">
11.993 - <Details>
11.994 -<![CDATA[
11.995 -<p>This detector looks for I/O streams and database resources that
11.996 -are not cleaned up on all paths out of a method. This is a slow detector.</p>
11.997 -]]>
11.998 - </Details>
11.999 - </Detector>
11.1000 -
11.1001 - <Detector class="edu.umd.cs.findbugs.detect.UnnecessaryMath">
11.1002 - <Details>
11.1003 -<![CDATA[
11.1004 -<p>This detector looks for code that calls java.lang.Math static methods on constant values,
11.1005 -where the resultant value is a statically known constant. It is faster, and sometimes more
11.1006 -accurate, to use the constant instead.</p>
11.1007 -]]>
11.1008 - </Details>
11.1009 - </Detector>
11.1010 -
11.1011 - <Detector class="edu.umd.cs.findbugs.detect.FindCircularDependencies">
11.1012 - <Details>
11.1013 -<![CDATA[
11.1014 -<p>This detector looks circular dependencies among classes. It is a fast detector.</p>
11.1015 -]]>
11.1016 - </Details>
11.1017 - </Detector>
11.1018 -
11.1019 - <Detector class="edu.umd.cs.findbugs.detect.RedundantInterfaces">
11.1020 - <Details>
11.1021 -<![CDATA[
11.1022 -<p>This detector looks for classes that declare they implement the same interface
11.1023 -as a super class. This is redundant, if a superclass implements an interface, so does
11.1024 -the subclass.</p>
11.1025 -]]>
11.1026 - </Details>
11.1027 - </Detector>
11.1028 -
11.1029 - <Detector class="edu.umd.cs.findbugs.detect.MultithreadedInstanceAccess">
11.1030 - <Details>
11.1031 -<![CDATA[
11.1032 -<p>This detector looks for potential problems in implementing the Struts framework.
11.1033 -It is a fast detector.</p>
11.1034 -]]>
11.1035 - </Details>
11.1036 - </Detector>
11.1037 -
11.1038 - <Detector class="edu.umd.cs.findbugs.detect.PublicSemaphores">
11.1039 - <Details>
11.1040 -<![CDATA[
11.1041 -<p>This detector looks for public classes that synchronize and use wait(), notify() or notifyAll()
11.1042 -on <b>this</b>. This exposes a synchronization implementation as a public artifact of the class.
11.1043 -Clients of the class may use an instance of the class as it's own synchronizing object, and cause
11.1044 -havoc to the base implementation.
11.1045 -It is a fast detector.</p>
11.1046 -]]>
11.1047 - </Details>
11.1048 - </Detector>
11.1049 -
11.1050 - <Detector class="edu.umd.cs.findbugs.detect.MethodReturnCheck">
11.1051 - <Details>
11.1052 -<![CDATA[
11.1053 -<p> This detector looks for calls to methods where the return value
11.1054 -is suspiciously ignored. It is a fast detector.</p>
11.1055 -]]>
11.1056 - </Details>
11.1057 - </Detector>
11.1058 -
11.1059 - <Detector class="edu.umd.cs.findbugs.detect.IDivResultCastToDouble">
11.1060 - <Details>
11.1061 -<![CDATA[
11.1062 -<p>
11.1063 -This detector looks for places where the result of integer division is
11.1064 -cast to double. Often, what was meant was to cast the integer operands
11.1065 -to double and then perform the division. It is a fast detector.
11.1066 -</p>
11.1067 -]]>
11.1068 - </Details>
11.1069 - </Detector>
11.1070 - <Detector class="edu.umd.cs.findbugs.detect.FindBadCast">
11.1071 - <Details>
11.1072 -<![CDATA[
11.1073 -<p>
11.1074 -This detector looks for bad casts of object references.
11.1075 -</p>
11.1076 -]]>
11.1077 - </Details>
11.1078 - </Detector>
11.1079 -
11.1080 - <Detector class="edu.umd.cs.findbugs.detect.FindBadCast2">
11.1081 - <Details>
11.1082 -<![CDATA[
11.1083 -<p>
11.1084 -This detector looks for bad casts of object references using data flow analysis.
11.1085 -</p>
11.1086 -]]>
11.1087 - </Details>
11.1088 - </Detector>
11.1089 -
11.1090 - <Detector class="edu.umd.cs.findbugs.detect.FindNonSerializableStoreIntoSession">
11.1091 - <Details>
11.1092 -<![CDATA[
11.1093 -<p>
11.1094 -This detector looks for stores of non Serializable objects into Http sessions.
11.1095 -</p>
11.1096 -]]>
11.1097 - </Details>
11.1098 - </Detector>
11.1099 - <Detector class="edu.umd.cs.findbugs.detect.FindNonSerializableValuePassedToWriteObject">
11.1100 - <Details>
11.1101 -<![CDATA[
11.1102 -<p>
11.1103 -This detector looks for stores of non Serializable objects passed to the writeObject method of
11.1104 -an ObjectOutput.
11.1105 -</p>
11.1106 -]]>
11.1107 - </Details>
11.1108 - </Detector>
11.1109 -
11.1110 -
11.1111 -
11.1112 -
11.1113 - <Detector class="edu.umd.cs.findbugs.detect.BadSyntaxForRegularExpression">
11.1114 - <Details>
11.1115 -<![CDATA[
11.1116 -<p> This detector looks for regular expressions that have invalid syntax. </p>
11.1117 -]]>
11.1118 - </Details>
11.1119 - </Detector>
11.1120 - <Detector class="edu.umd.cs.findbugs.detect.FindPuzzlers">
11.1121 - <Details>
11.1122 -<![CDATA[
11.1123 -<p> This detector problems looks for miscellaneous small errors
11.1124 -mentioned by Joshua Bloch and Neal Gafter in
11.1125 -their work on Programming Puzzlers.
11.1126 - </p>
11.1127 -]]>
11.1128 - </Details>
11.1129 - </Detector>
11.1130 -
11.1131 - <Detector class="edu.umd.cs.findbugs.detect.FindSleepWithLockHeld">
11.1132 - <Details>
11.1133 - <![CDATA[
11.1134 - <p>
11.1135 - This detector looks for calls to Thread.sleep() made with
11.1136 - a lock held. It is a slow detector.
11.1137 - </p>
11.1138 - ]]>
11.1139 - </Details>
11.1140 - </Detector>
11.1141 -
11.1142 - <Detector class="edu.umd.cs.findbugs.detect.DuplicateBranches">
11.1143 - <Details>
11.1144 -<![CDATA[
11.1145 -<p> This detector looks for if/else or switch statements that have the
11.1146 -same code for two branches, thus rendering the test useless. This often
11.1147 -is caused by copying and pasting the two branches, causing incorrect logic
11.1148 -for the one branch.</p><p>It is a fast detector.</p>
11.1149 -]]>
11.1150 - </Details>
11.1151 - </Detector>
11.1152 -
11.1153 - <Detector class="edu.umd.cs.findbugs.detect.InefficientMemberAccess">
11.1154 - <Details>
11.1155 -<![CDATA[
11.1156 -<p> This detector looks for internal classes that write to member variables of the
11.1157 -owning class, when that member variable is private. In this case, a special compiler
11.1158 -generated accessor method needs to be used to write to this variable. Relaxing the
11.1159 -visibility to protected will allow the field to be directly written.</p>
11.1160 -<p>It is a fast detector.</p>
11.1161 -]]>
11.1162 - </Details>
11.1163 - </Detector>
11.1164 -
11.1165 - <Detector class="edu.umd.cs.findbugs.detect.XMLFactoryBypass">
11.1166 - <Details>
11.1167 -<![CDATA[
11.1168 -<p> This detector looks for direct allocations of implementations of XML interfaces.
11.1169 -This ties the code to a specific implementation, rather than using the supplied
11.1170 -factory pattern to create these objects.</p>
11.1171 -<p>It is a fast detector.</p>
11.1172 -]]>
11.1173 - </Details>
11.1174 - </Detector>
11.1175 -
11.1176 - <Detector class="edu.umd.cs.findbugs.detect.FindBadEqualsImplementation">
11.1177 - <Details>
11.1178 - <![CDATA[
11.1179 - <p>
11.1180 - This detector looks for equals(Object) method implementations which
11.1181 - unconditionally dereference their parameter. This violates the contract
11.1182 - defined by java.lang.Object.equals(), which states that if the parameter
11.1183 - is null, the method must return null.
11.1184 - </p>
11.1185 - <p>It is a slow detector.</p>
11.1186 - ]]>
11.1187 - </Details>
11.1188 - </Detector>
11.1189 -
11.1190 - <Detector class="edu.umd.cs.findbugs.detect.UselessSubclassMethod">
11.1191 - <Details>
11.1192 - <![CDATA[
11.1193 - <p>
11.1194 - This detector looks for subclasses that implement methods defined in the super
11.1195 - class, that only pass the parameters untouched to the parent class method.
11.1196 - These methods can just be removed.
11.1197 - </p>
11.1198 - <p>It is a fast detector.</p>
11.1199 - ]]>
11.1200 - </Details>
11.1201 - </Detector>
11.1202 -
11.1203 - <Detector class="edu.umd.cs.findbugs.detect.ConfusedInheritance">
11.1204 - <Details>
11.1205 - <![CDATA[
11.1206 - <p>
11.1207 - This detector for final classes that declare protected members. As this
11.1208 - class can not be derived from, the use of protected access for members is
11.1209 - incorrect. The access should be changed to public or private to represent
11.1210 - the correct intention of the field. This was probably caused by a change in
11.1211 - use for this class, without completely changing all of the class to the new
11.1212 - paradigm.
11.1213 - </p>
11.1214 - <p>It is a fast detector.</p>
11.1215 - ]]>
11.1216 - </Details>
11.1217 - </Detector>
11.1218 -
11.1219 - <Detector class="edu.umd.cs.findbugs.detect.QuestionableBooleanAssignment">
11.1220 - <Details>
11.1221 - <![CDATA[
11.1222 - <p>
11.1223 - This detector looks for simple assignments of literal boolean values to variables in
11.1224 - conditional expressions.
11.1225 - </p>
11.1226 - <p>It is a fast detector.</p>
11.1227 - ]]>
11.1228 - </Details>
11.1229 - </Detector>
11.1230 -
11.1231 - <Detector class="edu.umd.cs.findbugs.detect.TrainNullReturnValues">
11.1232 - <Details>
11.1233 - <![CDATA[
11.1234 - <p>
11.1235 - TrainNullReturnValues determines which methods may return null and saves
11.1236 - them to a file. The resulting file may be used in a subsequent
11.1237 - pass to improve the precision of the null-dereference detector.
11.1238 - Since this is just a training pass, no warnings are reported.
11.1239 - </p>
11.1240 - <p>
11.1241 - This is a slow detector.
11.1242 - </p>
11.1243 - ]]>
11.1244 - </Details>
11.1245 - </Detector>
11.1246 -
11.1247 - <Detector class="edu.umd.cs.findbugs.detect.TrainUnconditionalDerefParams">
11.1248 - <Details>
11.1249 - <![CDATA[
11.1250 - <p>
11.1251 - TrainUnconditionalParamDerefs determines which methods may
11.1252 - unconditionally dereference parameters and saves them to a file.
11.1253 - The resulting file may be used in a subsequent
11.1254 - pass to improve the precision of the null-dereference detector.
11.1255 - Since this is just a training pass, no warnings are reported.
11.1256 - </p>
11.1257 - <p>
11.1258 - This is a slow detector.
11.1259 - </p>
11.1260 - ]]>
11.1261 - </Details>
11.1262 - </Detector>
11.1263 -
11.1264 - <Detector class="edu.umd.cs.findbugs.detect.TrainFieldStoreTypes">
11.1265 - <Details>
11.1266 - <![CDATA[
11.1267 - <p>
11.1268 - TrainFieldStoreTypes analyzes the types stored into fields
11.1269 - and stores them to a database. The database may be used in a later
11.1270 - pass to make type analysis more precise.
11.1271 - </p>
11.1272 - <p>
11.1273 - This is a slow detector.
11.1274 - </p>
11.1275 - ]]>
11.1276 - </Details>
11.1277 - </Detector>
11.1278 -
11.1279 - <Detector class="edu.umd.cs.findbugs.detect.TrainNonNullAnnotations">
11.1280 - <Details>
11.1281 - <![CDATA[
11.1282 - <p>
11.1283 - TrainNonNullAnnotations collects @NonNull and @PossiblyNull annotations
11.1284 - and stores them to database files. This is a fast detector.
11.1285 - </p>
11.1286 - ]]>
11.1287 - </Details>
11.1288 - </Detector>
11.1289 -
11.1290 - <Detector class="edu.umd.cs.findbugs.detect.CheckCalls">
11.1291 - <Details>
11.1292 - <![CDATA[
11.1293 - <p>This detector is just for debugging method call resolution in FindBugs.
11.1294 - Don't enable it.</p>
11.1295 - ]]>
11.1296 - </Details>
11.1297 - </Detector>
11.1298 -
11.1299 - <Detector class="edu.umd.cs.findbugs.detect.FindBugsSummaryStats">
11.1300 - <Details>
11.1301 -<![CDATA[
11.1302 -<p> This detector just collects summary statistics information about the analysis process. </p>
11.1303 -]]>
11.1304 - </Details>
11.1305 - </Detector>
11.1306 -
11.1307 - <Detector class="edu.umd.cs.findbugs.detect.TestASM">
11.1308 - <Details>
11.1309 - <![CDATA[
11.1310 - <p>
11.1311 - This detector is a code example showing how to write a FindBugs
11.1312 - detector using the ASM bytecode analysis framework.
11.1313 - </p>
11.1314 - ]]>
11.1315 - </Details>
11.1316 - </Detector>
11.1317 -
11.1318 - <Detector class="edu.umd.cs.findbugs.detect.FindUnrelatedTypesInGenericContainer">
11.1319 - <Details>
11.1320 - <![CDATA[
11.1321 - <p> This detector looks at the arguments of calls to generic
11.1322 - container methods that receive a <code>java.lang.Object</code>
11.1323 - to see if the argument's type is related to the container's
11.1324 - parameter. Arguments with unrelated class types are never going
11.1325 - to be in the container. For example, if <code>foo</code> is a
11.1326 - <code>List<String></code> and <code>bar</code> is a
11.1327 - <code>StringBuffer</code>, the call <code>foo.contains(bar)</code>
11.1328 - will always return false. This is a fast detector.
11.1329 - </p>
11.1330 - ]]>
11.1331 - </Details>
11.1332 - </Detector>
11.1333 -
11.1334 -<Detector class="edu.umd.cs.findbugs.detect.StaticCalendarDetector">
11.1335 -<Details>
11.1336 -<![CDATA[
11.1337 -<p>This detector warns about static fields of type java.util.Calendar or java.text.DateFormat (and subclasses) because
11.1338 - Calendars are inherently unsafe for multithreaded use.
11.1339 -It is a fast detector.</p>
11.1340 -]]>
11.1341 -</Details>
11.1342 -</Detector>
11.1343 -
11.1344 - <!--
11.1345 - **********************************************************************
11.1346 - BugPatterns
11.1347 - **********************************************************************
11.1348 - -->
11.1349 -
11.1350 - <BugPattern type="SW_SWING_METHODS_INVOKED_IN_SWING_THREAD">
11.1351 - <ShortDescription>Certain swing methods needs to be invoked in Swing thread</ShortDescription>
11.1352 - <LongDescription>Call to swing method in {1} needs to be performed in Swing event thread</LongDescription>
11.1353 - <Details>
11.1354 -<![CDATA[
11.1355 -<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods
11.1356 -show(), setVisible(), and pack() will create the associated peer for the frame.
11.1357 -With the creation of the peer, the system creates the event dispatch thread.
11.1358 -This makes things problematic because the event dispatch thread could be notifying
11.1359 -listeners while pack and validate are still processing. This situation could result in
11.1360 -two threads going through the Swing component-based GUI -- it's a serious flaw that
11.1361 -could result in deadlocks or other related threading issues. A pack call causes
11.1362 -components to be realized. As they are being realized (that is, not necessarily
11.1363 -visible), they could trigger listener notification on the event dispatch thread.</p>
11.1364 -
11.1365 -]]>
11.1366 - </Details>
11.1367 - </BugPattern>
11.1368 -
11.1369 -
11.1370 - <BugPattern type="IL_INFINITE_LOOP">
11.1371 - <ShortDescription>An apparent infinite loop</ShortDescription>
11.1372 - <LongDescription>There is an apparent infinite loop in {1}</LongDescription>
11.1373 - <Details>
11.1374 -<![CDATA[
11.1375 -<p>This loop doesn't seem to have a way to terminate (other than by perhaps
11.1376 -throwing an exception).</p>
11.1377 -]]>
11.1378 - </Details>
11.1379 - </BugPattern>
11.1380 -
11.1381 - <BugPattern type="IL_INFINITE_RECURSIVE_LOOP">
11.1382 - <ShortDescription>An apparent infinite recursive loop</ShortDescription>
11.1383 - <LongDescription>There is an apparent infinite recursive loop in {1}</LongDescription>
11.1384 - <Details>
11.1385 -<![CDATA[
11.1386 -<p>This method unconditionally invokes itself. This would seem to indicate
11.1387 -an infinite recursive loop that will result in a stack overflow.</p>
11.1388 -]]>
11.1389 - </Details>
11.1390 - </BugPattern>
11.1391 -
11.1392 -
11.1393 - <BugPattern type="IL_CONTAINER_ADDED_TO_ITSELF">
11.1394 - <ShortDescription>A container is added to itself</ShortDescription>
11.1395 - <LongDescription>A container is added to itself in {1}</LongDescription>
11.1396 - <Details>
11.1397 -<![CDATA[
11.1398 -<p>A container is added to itself. As a result, computing the hashCode of this
11.1399 -set will throw a StackOverflowException.
11.1400 -</p>
11.1401 -]]>
11.1402 - </Details>
11.1403 - </BugPattern>
11.1404 -
11.1405 -
11.1406 -
11.1407 -
11.1408 - <BugPattern type="VO_VOLATILE_REFERENCE_TO_ARRAY">
11.1409 - <ShortDescription>A volatile reference to an array doesn't treat the array elements as volatile</ShortDescription>
11.1410 - <LongDescription>{1} is a volatile reference to an array; the array elements are non-volatile</LongDescription>
11.1411 - <Details>
11.1412 -<![CDATA[
11.1413 -<p>This declares a volatile reference to an array, which might not be what
11.1414 -you want. With a volatile reference to an array, reads and writes of
11.1415 -the reference to the array are treated as volatile, but the array elements
11.1416 -are non-volatile. To get volatile array elements, you will need to use
11.1417 -one of the atomic array classes in java.util.concurrent (provided
11.1418 -in Java 5.0).</p>
11.1419 -]]>
11.1420 - </Details>
11.1421 - </BugPattern>
11.1422 -
11.1423 - <BugPattern type="UI_INHERITANCE_UNSAFE_GETRESOURCE">
11.1424 - <ShortDescription>Usage of GetResource may be unsafe if class is extended</ShortDescription>
11.1425 - <LongDescription>Usage of GetResource in {1} may be unsafe if class is extended</LongDescription>
11.1426 - <Details>
11.1427 -<![CDATA[
11.1428 -<p>Calling <code>this.getClass().getResource(...)</code> could give
11.1429 -results other than expected if this class is extended by a class in
11.1430 -another package.</p>
11.1431 -]]>
11.1432 - </Details>
11.1433 - </BugPattern>
11.1434 -
11.1435 - <BugPattern type="NP_SYNC_AND_NULL_CHECK_FIELD">
11.1436 - <ShortDescription>Synchronize and null check on the same field.</ShortDescription>
11.1437 - <LongDescription>In {1} the field {2.givenClass} is synchronized on and then checked if null.</LongDescription>
11.1438 - <Details>
11.1439 -<![CDATA[
11.1440 -<p>Since field is synchronized on, it seems not likely to be null.
11.1441 -If it is null and then synchronized on a NullPointerException will be
11.1442 -thrown and the check would be pointless. Better to synchronize on
11.1443 -another field.</p>
11.1444 -
11.1445 -]]>
11.1446 - </Details>
11.1447 - </BugPattern>
11.1448 -
11.1449 -
11.1450 - <BugPattern type="TESTING">
11.1451 - <ShortDescription>Testing</ShortDescription>
11.1452 - <LongDescription>Test warning generated in {1}</LongDescription>
11.1453 - <Details>
11.1454 -<![CDATA[
11.1455 -<p>This bug pattern is only generated by new, incompletely implemented
11.1456 -bug detectors.</p>
11.1457 -]]>
11.1458 - </Details>
11.1459 - </BugPattern>
11.1460 - <BugPattern type="UNKNOWN">
11.1461 - <ShortDescription>Unknown bug pattern</ShortDescription>
11.1462 - <LongDescription>Unknown bug pattern BUG_PATTERN in {1}</LongDescription>
11.1463 - <Details>
11.1464 -<![CDATA[
11.1465 -<p>A warning was recorded, but findbugs can't find the description of this bug pattern
11.1466 -and so can't describe it. This should occur only in cases of a bug in FindBugs or its configuration,
11.1467 -or perhaps if an analysis was generated using a plugin, but that plugin is not currently loaded.
11.1468 -.</p>
11.1469 -]]>
11.1470 - </Details>
11.1471 - </BugPattern>
11.1472 -
11.1473 -
11.1474 - <BugPattern type="AM_CREATES_EMPTY_ZIP_FILE_ENTRY">
11.1475 - <ShortDescription>Creates an empty zip file entry</ShortDescription>
11.1476 - <LongDescription>Empty zip file entry created in {1}</LongDescription>
11.1477 - <Details>
11.1478 -<![CDATA[
11.1479 -<p>The code calls <code>putNextEntry()</code>, immediately
11.1480 -followed by a call to <code>closeEntry()</code>. This results
11.1481 -in an empty ZipFile entry. The contents of the entry
11.1482 -should be written to the ZipFile between the calls to
11.1483 -<code>putNextEntry()</code> and
11.1484 -<code>closeEntry()</code>.</p>
11.1485 -]]>
11.1486 - </Details>
11.1487 - </BugPattern>
11.1488 -
11.1489 - <BugPattern type="AM_CREATES_EMPTY_JAR_FILE_ENTRY">
11.1490 - <ShortDescription>Creates an empty jar file entry</ShortDescription>
11.1491 - <LongDescription>Empty jar file entry created in {1}</LongDescription>
11.1492 - <Details>
11.1493 -<![CDATA[
11.1494 -<p>The code calls <code>putNextEntry()</code>, immediately
11.1495 -followed by a call to <code>closeEntry()</code>. This results
11.1496 -in an empty JarFile entry. The contents of the entry
11.1497 -should be written to the JarFile between the calls to
11.1498 -<code>putNextEntry()</code> and
11.1499 -<code>closeEntry()</code>.</p>
11.1500 -]]>
11.1501 - </Details>
11.1502 - </BugPattern>
11.1503 -
11.1504 - <BugPattern type="IMSE_DONT_CATCH_IMSE">
11.1505 - <ShortDescription>Dubious catching of IllegalMonitorStateException</ShortDescription>
11.1506 - <LongDescription>Dubious catching of IllegalMonitorStateException in {1}</LongDescription>
11.1507 - <Details>
11.1508 -<![CDATA[
11.1509 -<p>IllegalMonitorStateException is generally only
11.1510 - thrown in case of a design flaw in your code (calling wait or
11.1511 - notify on an object you do not hold a lock on).</p>
11.1512 -]]>
11.1513 - </Details>
11.1514 - </BugPattern>
11.1515 -
11.1516 -
11.1517 - <BugPattern type="FL_MATH_USING_FLOAT_PRECISION">
11.1518 - <ShortDescription>Method performs math using floating point precision</ShortDescription>
11.1519 - <LongDescription>{1} performs math using floating point precision</LongDescription>
11.1520 - <Details>
11.1521 -<![CDATA[
11.1522 -<p>
11.1523 - The method performs math operations using floating point precision.
11.1524 - Floating point precision is very imprecise. For example,
11.1525 - 16777216.0f + 1.0f = 16777216.0f. Consider using double math instead.</p>
11.1526 -]]>
11.1527 - </Details>
11.1528 - </BugPattern>
11.1529 -
11.1530 - <BugPattern type="CN_IDIOM">
11.1531 - <ShortDescription>Class implements Cloneable but does not define or use clone method</ShortDescription>
11.1532 - <LongDescription>Class {0} implements Cloneable but does not define or use clone method</LongDescription>
11.1533 - <Details>
11.1534 -<![CDATA[
11.1535 -<p>
11.1536 - Class implements Cloneable but does not define or
11.1537 - use the clone method.</p>
11.1538 -]]>
11.1539 - </Details>
11.1540 - </BugPattern>
11.1541 -
11.1542 - <BugPattern type="CN_IDIOM_NO_SUPER_CALL">
11.1543 - <ShortDescription>clone method does not call super.clone()</ShortDescription>
11.1544 - <LongDescription>{1} does not call super.clone()</LongDescription>
11.1545 - <Details>
11.1546 -<![CDATA[
11.1547 -<p> This non-final class defines a clone() method that does not call super.clone().
11.1548 -If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"),
11.1549 -and the subclass <i>B</i> calls super.clone(), then it is likely that
11.1550 -<i>B</i>'s clone() method will return an object of type <i>A</i>,
11.1551 -which violates the standard contract for clone().</p>
11.1552 -
11.1553 -<p> If all clone() methods call super.clone(), then they are guaranteed
11.1554 -to use Object.clone(), which always returns an object of the correct type.</p>
11.1555 -]]>
11.1556 - </Details>
11.1557 - </BugPattern>
11.1558 -
11.1559 -
11.1560 - <BugPattern type="NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER">
11.1561 - <ShortDescription>Use of identifier that is a keyword in later versions of Java</ShortDescription>
11.1562 - <LongDescription>{1} uses {2} for a variable name, which is a keyword in later versions of Java</LongDescription>
11.1563 - <Details>
11.1564 -<![CDATA[
11.1565 -<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
11.1566 -in order to compile it in later versions of Java.</p>
11.1567 -
11.1568 -]]>
11.1569 - </Details>
11.1570 - </BugPattern>
11.1571 - <BugPattern type="NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER">
11.1572 - <ShortDescription>Use of identifier that is a keyword in later versions of Java</ShortDescription>
11.1573 - <LongDescription>{1} conflicts with a keyword in a more recent version of Java</LongDescription>
11.1574 - <Details>
11.1575 -<![CDATA[
11.1576 -<p>This identifier is used as a keyword in later versions of Java. This code, and
11.1577 -any code that references this API,
11.1578 -will need to be changed in order to compile it in later versions of Java.</p>
11.1579 -
11.1580 -]]>
11.1581 - </Details>
11.1582 - </BugPattern>
11.1583 -
11.1584 -
11.1585 - <BugPattern type="DE_MIGHT_DROP">
11.1586 - <ShortDescription>Method might drop exception</ShortDescription>
11.1587 - <LongDescription>{1} might drop {2}</LongDescription>
11.1588 - <Details>
11.1589 -<![CDATA[
11.1590 - <p> This method might drop an exception. In general, exceptions
11.1591 - should be handled or reported in some way, or they should be thrown
11.1592 - out of the method.</p>
11.1593 -]]>
11.1594 - </Details>
11.1595 - </BugPattern>
11.1596 - <BugPattern type="DE_MIGHT_IGNORE">
11.1597 - <ShortDescription>Method might ignore exception</ShortDescription>
11.1598 - <LongDescription>{1} might ignore {2}</LongDescription>
11.1599 - <Details>
11.1600 -<![CDATA[
11.1601 - <p> This method might ignore an exception. In general, exceptions
11.1602 - should be handled or reported in some way, or they should be thrown
11.1603 - out of the method.</p>
11.1604 -]]>
11.1605 - </Details>
11.1606 - </BugPattern>
11.1607 -
11.1608 -<BugPattern type="DP_DO_INSIDE_DO_PRIVILEGED">
11.1609 - <ShortDescription>Method invoked that should be only be invoked inside a doPrivileged block</ShortDescription>
11.1610 - <LongDescription>{1} invokes {2}, which should be invoked from within a doPrivileged block</LongDescription>
11.1611 - <Details>
11.1612 -<![CDATA[
11.1613 - <p> This code invokes a method that requires a security permission check.
11.1614 - If this code will be granted security permissions, but might be invoked by code that does not
11.1615 - have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
11.1616 -]]>
11.1617 - </Details>
11.1618 - </BugPattern>
11.1619 -<BugPattern type="DP_DO_INSIDE_DO_PRIVILEDGED"> <!-- misspelled for backward compatibility -->
11.1620 - <ShortDescription>Method invoked that should be only be invoked inside a doPrivileged block</ShortDescription>
11.1621 - <LongDescription>{1} invokes {2}, which should be invoked from within a doPrivileged block</LongDescription>
11.1622 - <Details>
11.1623 -<![CDATA[
11.1624 - <p> This code invokes a method that requires a security permission check.
11.1625 - If this code will be granted security permissions, but might be invoked by code that does not
11.1626 - have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
11.1627 -]]>
11.1628 - </Details>
11.1629 - </BugPattern>
11.1630 -
11.1631 -<BugPattern type="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED">
11.1632 - <ShortDescription>Classloaders should only be created inside doPrivileged block</ShortDescription>
11.1633 - <LongDescription>{1} creates a {2} classloader, which should be performed within a doPrivileged block</LongDescription>
11.1634 - <Details>
11.1635 -<![CDATA[
11.1636 - <p> This code creates a classloader, which requires a security manager.
11.1637 - If this code will be granted security permissions, but might be invoked by code that does not
11.1638 - have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
11.1639 -]]>
11.1640 - </Details>
11.1641 - </BugPattern>
11.1642 -<BugPattern type="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEDGED"> <!-- misspelled for backward compatibility -->
11.1643 - <ShortDescription>Classloaders should only be created inside doPrivileged block</ShortDescription>
11.1644 - <LongDescription>{1} creates a {2} classloader, which should be performed within a doPrivileged block</LongDescription>
11.1645 - <Details>
11.1646 -<![CDATA[
11.1647 - <p> This code creates a classloader, which requires a security manager.
11.1648 - If this code will be granted security permissions, but might be invoked by code that does not
11.1649 - have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
11.1650 -]]>
11.1651 - </Details>
11.1652 - </BugPattern>
11.1653 -
11.1654 - <BugPattern type="JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS">
11.1655 - <ShortDescription>Fields of immutable classes should be final</ShortDescription>
11.1656 - <LongDescription>{1.givenClass} should be final since {0} is marked as Immutable. </LongDescription>
11.1657 - <Details>
11.1658 -<![CDATA[
11.1659 - <p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require
11.1660 -that all fields are final.
11.1661 - .</p>
11.1662 -]]>
11.1663 - </Details>
11.1664 - </BugPattern>
11.1665 -
11.1666 - <BugPattern type="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED">
11.1667 - <ShortDescription>Thread passed where Runnable expected</ShortDescription>
11.1668 - <LongDescription>Thread passed where Runnable expected in {1}</LongDescription>
11.1669 - <Details>
11.1670 -<![CDATA[
11.1671 - <p> A Thread object is passed as a parameter to a method where
11.1672 -a Runnable is expected. This is rather unusual, and may indicate a logic error
11.1673 -or cause unexpected behavior.
11.1674 - </p>
11.1675 -]]>
11.1676 - </Details>
11.1677 - </BugPattern>
11.1678 - <BugPattern type="DMI_COLLECTION_OF_URLS">
11.1679 - <ShortDescription>Maps and sets of URLs can be performance hogs</ShortDescription>
11.1680 - <LongDescription>{1} is or uses a map or set of URLs, which can be a performance hog</LongDescription>
11.1681 - <Details>
11.1682 -<![CDATA[
11.1683 - <p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode
11.1684 -method of URL perform domain name resolution, this can result in a big performance hit.
11.1685 -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.
11.1686 -Consider using <code>java.net.URI</code> instead.
11.1687 - </p>
11.1688 -]]>
11.1689 - </Details>
11.1690 - </BugPattern>
11.1691 - <BugPattern type="DMI_BLOCKING_METHODS_ON_URL">
11.1692 - <ShortDescription>The equals and hashCode methods of URL are blocking</ShortDescription>
11.1693 - <LongDescription>{1} invokes {2}, which blocks to do domain name resolution</LongDescription>
11.1694 - <Details>
11.1695 -<![CDATA[
11.1696 - <p> The equals and hashCode
11.1697 -method of URL perform domain name resolution, this can result in a big performance hit.
11.1698 -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.
11.1699 -Consider using <code>java.net.URI</code> instead.
11.1700 - </p>
11.1701 -]]>
11.1702 - </Details>
11.1703 - </BugPattern>
11.1704 - <BugPattern type="DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION">
11.1705 - <ShortDescription>Can't use reflection to check for presence of annotation with default retention</ShortDescription>
11.1706 - <LongDescription>{1} uses reflection to check for the presence of an annotation that has default retention</LongDescription>
11.1707 - <Details>
11.1708 -<![CDATA[
11.1709 - <p> Unless an annotation has itself been annotated with a @Retention other than the default
11.1710 -of source-only retention, the annotation isn't retained in the classfile and can't be observed using reflection
11.1711 - (e.g., by using the isAnnotationPresent method).
11.1712 - .</p>
11.1713 -]]>
11.1714 - </Details>
11.1715 - </BugPattern>
11.1716 -
11.1717 -
11.1718 - <BugPattern type="DM_EXIT">
11.1719 - <ShortDescription>Method invokes System.exit(...)</ShortDescription>
11.1720 - <LongDescription>{1} invokes System.exit(...), which shuts down the entire virtual machine</LongDescription>
11.1721 - <Details>
11.1722 -<![CDATA[
11.1723 - <p> Invoking System.exit shuts down the entire Java virtual machine. This
11.1724 - should only been done when it is appropriate. Such calls make it
11.1725 - hard or impossible for your code to be invoked by other code.
11.1726 - Consider throwing a RuntimeException instead.</p>
11.1727 -]]>
11.1728 - </Details>
11.1729 - </BugPattern>
11.1730 -
11.1731 -
11.1732 - <BugPattern type="DM_RUN_FINALIZERS_ON_EXIT">
11.1733 - <ShortDescription>Method invokes dangerous method runFinalizersOnExit </ShortDescription>
11.1734 - <LongDescription>{1} invokes dangerous method runFinalizersOnExit</LongDescription>
11.1735 - <Details>
11.1736 -<![CDATA[
11.1737 - <p> <em>Never call System.runFinalizersOnExit
11.1738 -or Runtime.runFinalizersOnExit for any reason: they are among the most
11.1739 -dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>
11.1740 -]]>
11.1741 - </Details>
11.1742 - </BugPattern>
11.1743 -
11.1744 - <BugPattern type="DM_STRING_CTOR">
11.1745 - <ShortDescription>Method invokes inefficient new String(String) constructor</ShortDescription>
11.1746 - <LongDescription>{1} invokes inefficient new String(String) constructor</LongDescription>
11.1747 - <Details>
11.1748 -<![CDATA[
11.1749 - <p> Using the <code>java.lang.String(String)</code> constructor wastes memory
11.1750 - because the object so constructed will be functionally indistinguishable
11.1751 - from the <code>String</code> passed as a parameter. Just use the
11.1752 - argument <code>String</code> directly.</p>
11.1753 -]]>
11.1754 - </Details>
11.1755 - </BugPattern>
11.1756 -
11.1757 -
11.1758 - <BugPattern type="DM_STRING_VOID_CTOR">
11.1759 - <ShortDescription>Method invokes inefficient new String() constructor</ShortDescription>
11.1760 - <LongDescription>{1} invokes inefficient new String() constructor</LongDescription>
11.1761 - <Details>
11.1762 -<![CDATA[
11.1763 - <p> Creating a new <code>java.lang.String</code> object using the
11.1764 - no-argument constructor wastes memory because the object so created will
11.1765 - be functionally indistinguishable from the empty string constant
11.1766 - <code>""</code>. Java guarantees that identical string constants
11.1767 - will be represented by the same <code>String</code> object. Therefore,
11.1768 - you should just use the empty string constant directly.</p>
11.1769 -]]>
11.1770 - </Details>
11.1771 - </BugPattern>
11.1772 - <BugPattern type="DM_STRING_TOSTRING">
11.1773 - <ShortDescription>Method invokes toString() method on a String</ShortDescription>
11.1774 - <LongDescription>Method {1} invokes toString() method on a String</LongDescription>
11.1775 - <Details>
11.1776 -<![CDATA[
11.1777 - <p> Calling <code>String.toString()</code> is just a redundant operation.
11.1778 - Just use the String.</p>
11.1779 -]]>
11.1780 - </Details>
11.1781 - </BugPattern>
11.1782 - <BugPattern type="DM_GC">
11.1783 - <ShortDescription>Explicit garbage collection; extremely dubious except in benchmarking code</ShortDescription>
11.1784 - <LongDescription>{1} forces garbage collection; extremely dubious except in benchmarking code</LongDescription>
11.1785 - <Details>
11.1786 -<![CDATA[
11.1787 - <p> Code explicitly invokes garbage collection.
11.1788 - Except for specific use in benchmarking, this is very dubious.</p>
11.1789 - <p>In the past, situations where people have explicitly invoked
11.1790 - the garbage collector in routines such as close or finalize methods
11.1791 - has led to huge performance black holes. Garbage collection
11.1792 - can be expensive. Any situation that forces hundreds or thousands
11.1793 - of garbage collections will bring the machine to a crawl.</p>
11.1794 -]]>
11.1795 - </Details>
11.1796 - </BugPattern>
11.1797 - <BugPattern type="DM_BOOLEAN_CTOR">
11.1798 - <ShortDescription>Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead</ShortDescription>
11.1799 - <LongDescription>{1} invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead</LongDescription>
11.1800 - <Details>
11.1801 -<![CDATA[
11.1802 - <p> Creating new instances of <code>java.lang.Boolean</code> wastes
11.1803 - memory, since <code>Boolean</code> objects are immutable and there are
11.1804 - only two useful values of this type. Use the <code>Boolean.valueOf()</code>
11.1805 - method (or Java 1.5 autoboxing) to create <code>Boolean</code> objects instead.</p>
11.1806 -]]>
11.1807 - </Details>
11.1808 - </BugPattern>
11.1809 -
11.1810 - <BugPattern type="DM_NUMBER_CTOR">
11.1811 - <ShortDescription>Method invokes inefficient Number constructor; use static valueOf instead</ShortDescription>
11.1812 - <LongDescription>Method {1} invokes inefficient {3} constructor; use {4} instead</LongDescription>
11.1813 - <Details>
11.1814 - <![CDATA[
11.1815 - <p>
11.1816 - Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas
11.1817 - <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM.
11.1818 - Using of cached values avoids object allocation and the code will be faster.
11.1819 - </p>
11.1820 - <p>
11.1821 - Values between -128 and 127 are guaranteed to have corresponding cached instances
11.1822 - and using <code>valueOf</code> is approximately 3.5 times faster than using constructor.
11.1823 - For values outside the constant range the performance of both styles is the same.
11.1824 - </p>
11.1825 - <p>
11.1826 - Unless the class must be compatible with JVMs predating Java 1.5,
11.1827 - use either autoboxing or the <code>valueOf()</code> method when creating instances of
11.1828 - <code>Long</code>, <code>Integer</code>, <code>Short</code>, <code>Character</code>, and <code>Byte</code>.
11.1829 - </p>
11.1830 - ]]>
11.1831 - </Details>
11.1832 - </BugPattern>
11.1833 - <BugPattern type="DM_FP_NUMBER_CTOR">
11.1834 - <ShortDescription>Method invokes inefficient floating-point Number constructor; use static valueOf instead</ShortDescription>
11.1835 - <LongDescription>Method {1} invokes inefficient {3} constructor; use {4} instead</LongDescription>
11.1836 - <Details>
11.1837 - <![CDATA[
11.1838 - <p>
11.1839 - Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas
11.1840 - <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM.
11.1841 - Using of cached values avoids object allocation and the code will be faster.
11.1842 - </p>
11.1843 - <p>
11.1844 - Unless the class must be compatible with JVMs predating Java 1.5,
11.1845 - use either autoboxing or the <code>valueOf()</code> method when creating instances of <code>Double</code> and <code>Float</code>.
11.1846 - </p>
11.1847 - ]]>
11.1848 - </Details>
11.1849 - </BugPattern>
11.1850 -
11.1851 - <BugPattern type="DM_STRING_EMPTY_EQUALS">
11.1852 - <ShortDescription>Method invokes inefficient String.equals(""); use String.length() == 0 instead</ShortDescription>
11.1853 - <LongDescription>Method {1} invokes inefficient String.equals(""); use String.length() == 0 instead</LongDescription>
11.1854 - <Details>
11.1855 -<![CDATA[
11.1856 - <p> An object is compared to the empty String object using the equals() method here.
11.1857 - Checking that the String object's length is zero may be faster, and removes String constants from the class file.</p>
11.1858 -]]>
11.1859 - </Details>
11.1860 - </BugPattern>
11.1861 - <BugPattern type="DM_CONVERT_CASE">
11.1862 - <ShortDescription>Consider using Locale parameterized version of invoked method</ShortDescription>
11.1863 - <LongDescription>Use of non-localized String.toUpperCase() or String.toLowerCase</LongDescription>
11.1864 - <Details>
11.1865 -<![CDATA[
11.1866 - <p> A String is being converted to upper or lowercase, using the platform's default encoding. This may
11.1867 - result in improper conversions when used with international characters. Use the </p>
11.1868 - <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table>
11.1869 - <p>versions instead.</p>
11.1870 -]]>
11.1871 - </Details>
11.1872 - </BugPattern>
11.1873 -
11.1874 -
11.1875 - <BugPattern type="BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR">
11.1876 - <ShortDescription>Primitive value is unboxed and coerced for ternary operator</ShortDescription>
11.1877 - <LongDescription>Primitive value is unboxed and coerced for ternary operator in {1}</LongDescription>
11.1878 - <Details>
11.1879 -<![CDATA[
11.1880 - <p>A wrapped primative value is unboxed and converted to another primative type as part of the
11.1881 -evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The
11.1882 -semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped
11.1883 -numeric values, the values are unboxed and converted/coerced to their common type (e.g,
11.1884 -if <code>e1</code> is of type <code>Integer</code>
11.1885 -and <code>e2</code> is of type <code>Float</code>, then <code>e1</code> is unboxed,
11.1886 -converted to a floating point value, and boxed. See JLS Section 15.25.
11.1887 -</p>
11.1888 -]]>
11.1889 - </Details>
11.1890 - </BugPattern>
11.1891 - <BugPattern type="BX_BOXING_IMMEDIATELY_UNBOXED">
11.1892 - <ShortDescription>Primitive value is boxed and then immediately unboxed</ShortDescription>
11.1893 - <LongDescription>Primitive value is boxed and then immediately unboxed in {1}</LongDescription>
11.1894 - <Details>
11.1895 -<![CDATA[
11.1896 - <p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual
11.1897 - boxing in a place where an unboxed value is required, thus forcing the compiler
11.1898 -to immediately undue the work of the boxing.
11.1899 -</p>
11.1900 -]]>
11.1901 - </Details>
11.1902 - </BugPattern>
11.1903 -
11.1904 -
11.1905 -
11.1906 - <BugPattern type="BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION">
11.1907 - <ShortDescription>Primitive value is boxed then unboxed to perform primative coercion</ShortDescription>
11.1908 - <LongDescription>Primitive value is boxed then unboxed to perform primative coercion in {1}</LongDescription>
11.1909 - <Details>
11.1910 -<![CDATA[
11.1911 - <p>A primitive boxed value constructed and then immediately converted into a different primitive type
11.1912 -(e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>
11.1913 -]]>
11.1914 - </Details>
11.1915 - </BugPattern>
11.1916 - <BugPattern type="DM_BOXED_PRIMITIVE_TOSTRING">
11.1917 - <ShortDescription>Method allocates a boxed primitive just to call toString</ShortDescription>
11.1918 - <LongDescription>Primitive boxed just to call toString in {1}</LongDescription>
11.1919 - <Details>
11.1920 -<![CDATA[
11.1921 - <p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static
11.1922 - form of toString which takes the primitive value. So,</p>
11.1923 - <table>
11.1924 - <tr><th>Replace...</th><th>With this...</th></tr>
11.1925 - <tr><td>new Integer(1).toString()</td><td>Integer.toString(1)</td></tr>
11.1926 - <tr><td>new Long(1).toString()</td><td>Long.toString(1)</td></tr>
11.1927 - <tr><td>new Float(1.0).toString()</td><td>Float.toString(1.0)</td></tr>
11.1928 - <tr><td>new Double(1.0).toString()</td><td>Double.toString(1.0)</td></tr>
11.1929 - <tr><td>new Byte(1).toString()</td><td>Byte.toString(1)</td></tr>
11.1930 - <tr><td>new Short(1).toString()</td><td>Short.toString(1)</td></tr>
11.1931 - <tr><td>new Boolean(true).toString()</td><td>Boolean.toString(true)</td></tr>
11.1932 - </table>
11.1933 -]]>
11.1934 - </Details>
11.1935 - </BugPattern>
11.1936 -
11.1937 -
11.1938 - <BugPattern type="DM_NEW_FOR_GETCLASS">
11.1939 - <ShortDescription>Method allocates an object, only to get the class object</ShortDescription>
11.1940 - <LongDescription>Method {1} allocates an object, only to get the class object</LongDescription>
11.1941 - <Details>
11.1942 -<![CDATA[
11.1943 - <p>This method allocates an object just to call getClass() on it, in order to
11.1944 - retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>
11.1945 -]]>
11.1946 - </Details>
11.1947 - </BugPattern>
11.1948 -
11.1949 - <BugPattern type="DM_MONITOR_WAIT_ON_CONDITION">
11.1950 - <ShortDescription>Monitor wait() called on Condition</ShortDescription>
11.1951 - <LongDescription>Monitor wait() called on a Condition in {1}</LongDescription>
11.1952 - <Details>
11.1953 - <![CDATA[
11.1954 - <p>
11.1955 - This method calls <code>wait()</code> on a
11.1956 - <code>java.util.concurrent.locks.Condition</code> object.
11.1957 - Waiting for a <code>Condition</code> should be done using one of the <code>await()</code>
11.1958 - methods defined by the <code>Condition</code> interface.
11.1959 - </p>
11.1960 - ]]>
11.1961 - </Details>
11.1962 - </BugPattern>
11.1963 -
11.1964 - <BugPattern type="RV_01_TO_INT">
11.1965 - <ShortDescription>Random value from 0 to 1 is coerced to the integer 0</ShortDescription>
11.1966 - <LongDescription>Method {1} uses generates a random value from 0 to 1 and then coerces that value to the integer 0</LongDescription>
11.1967 - <Details>
11.1968 -<![CDATA[
11.1969 - <p>A random value from 0 to 1 is being coerced to the integer value 0. You probably
11.1970 -want to multiple the random value by something else before coercing it to an integer, or use the Random.nextInt(n) method.
11.1971 -</p>
11.1972 -]]>
11.1973 - </Details>
11.1974 - </BugPattern>
11.1975 -
11.1976 - <BugPattern type="DM_NEXTINT_VIA_NEXTDOUBLE">
11.1977 - <ShortDescription>Use the nextInt method of Random rather than nextDouble to generate a random integer</ShortDescription>
11.1978 - <LongDescription>Method {1} uses the nextDouble method of Random to generate a random integer; using nextInt is more efficient</LongDescription>
11.1979 - <Details>
11.1980 -<![CDATA[
11.1981 - <p>If r is a java.util.Random, you can generate a random number from 0 to n-1
11.1982 -using r.nextInt(n) Rather than using (int)(r.nextDouble() * n).
11.1983 -</p>
11.1984 -]]>
11.1985 - </Details>
11.1986 - </BugPattern>
11.1987 -
11.1988 -
11.1989 -
11.1990 - <BugPattern type="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE">
11.1991 - <ShortDescription>Nonconstant string passed to execute method on an SQL statement</ShortDescription>
11.1992 - <LongDescription>Method {1} passes a nonconstant String to an execute method on an SQL statement</LongDescription>
11.1993 - <Details>
11.1994 -<![CDATA[
11.1995 - <p>The method invokes the execute method on an SQL statement with a String that seems
11.1996 -to be dynamically generated. Consider using
11.1997 -a prepared statement instead. It is more efficient and less vulnerable to
11.1998 -SQL injection attacks.
11.1999 -</p>
11.2000 -]]>
11.2001 - </Details>
11.2002 - </BugPattern>
11.2003 -
11.2004 - <BugPattern type="SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING">
11.2005 - <ShortDescription>A prepared statement is generated from a nonconstant String</ShortDescription>
11.2006 - <LongDescription>A prepared statement is generated from a nonconstant String at {1} </LongDescription>
11.2007 - <Details>
11.2008 -<![CDATA[
11.2009 - <p>The code creates an SQL prepared statement from a nonconstant String.
11.2010 -If unchecked, tainted data from a user is used in building this String, SQL injection could
11.2011 -be used to make the prepared statement do something unexpected and undesirable.
11.2012 -</p>
11.2013 -]]>
11.2014 - </Details>
11.2015 - </BugPattern>
11.2016 -
11.2017 - <BugPattern type="DM_USELESS_THREAD">
11.2018 - <ShortDescription>A thread was created using the default empty run method</ShortDescription>
11.2019 - <LongDescription>Method {1} creates a thread using the default empty run method</LongDescription>
11.2020 - <Details>
11.2021 -<![CDATA[
11.2022 - <p>This method creates a thread without specifying a run method either by deriving from the Thread class, or
11.2023 - by passing a Runnable object. This thread, then, does nothing but waste time.
11.2024 -</p>
11.2025 -]]>
11.2026 - </Details>
11.2027 - </BugPattern>
11.2028 -
11.2029 - <BugPattern type="DC_DOUBLECHECK">
11.2030 - <ShortDescription>Possible double check of field</ShortDescription>
11.2031 - <LongDescription>Possible doublecheck on {2} in {1}</LongDescription>
11.2032 - <Details>
11.2033 -<![CDATA[
11.2034 - <p> This method may contain an instance of double-checked locking.
11.2035 - This idiom is not correct according to the semantics of the Java memory
11.2036 - model. For more information, see the web page
11.2037 - <a href="http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html"
11.2038 - >http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html</a>.</p>
11.2039 -]]>
11.2040 - </Details>
11.2041 - </BugPattern>
11.2042 -
11.2043 - <BugPattern type="FI_FINALIZER_NULLS_FIELDS">
11.2044 - <ShortDescription>Finalizer nulls fields</ShortDescription>
11.2045 - <LongDescription>{3} is set to null inside finalize method</LongDescription>
11.2046 - <Details>
11.2047 -<![CDATA[
11.2048 - <p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection,
11.2049 - and the object is going to be garbage collected anyway.
11.2050 -]]>
11.2051 - </Details>
11.2052 - </BugPattern>
11.2053 - <BugPattern type="FI_FINALIZER_ONLY_NULLS_FIELDS">
11.2054 - <ShortDescription>Finalizer only nulls fields</ShortDescription>
11.2055 - <LongDescription>{1} only nulls fields</LongDescription>
11.2056 - <Details>
11.2057 -<![CDATA[
11.2058 - <p> This finalizer does nothing except null out fields. This is completely pointless, and requires that
11.2059 -the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize
11.2060 -method.
11.2061 -]]>
11.2062 - </Details>
11.2063 - </BugPattern>
11.2064 -
11.2065 - <BugPattern type="FI_PUBLIC_SHOULD_BE_PROTECTED">
11.2066 - <ShortDescription>Finalizer should be protected, not public</ShortDescription>
11.2067 - <LongDescription>{1} is public; should be protected</LongDescription>
11.2068 - <Details>
11.2069 -<![CDATA[
11.2070 - <p> A class's <code>finalize()</code> method should have protected access,
11.2071 - not public.</p>
11.2072 -]]>
11.2073 - </Details>
11.2074 - </BugPattern>
11.2075 -
11.2076 - <BugPattern type="FI_EMPTY">
11.2077 - <ShortDescription>Empty finalizer should be deleted</ShortDescription>
11.2078 - <LongDescription>{1} is empty and should be deleted</LongDescription>
11.2079 - <Details>
11.2080 -<![CDATA[
11.2081 - <p> Empty <code>finalize()</code> methods are useless, so they should
11.2082 - be deleted.</p>
11.2083 -]]>
11.2084 - </Details>
11.2085 - </BugPattern>
11.2086 -
11.2087 - <BugPattern type="FI_NULLIFY_SUPER">
11.2088 - <ShortDescription>Finalizer nullifies superclass finalizer</ShortDescription>
11.2089 - <LongDescription>{1} is nullifying {2}.finalize(); is this intended?</LongDescription>
11.2090 - <Details>
11.2091 -<![CDATA[
11.2092 - <p> This empty <code>finalize()</code> method explicitly negates the
11.2093 - effect of any finalizer defined by its superclass. Any finalizer
11.2094 - actions defined for the superclass will not be performed.
11.2095 - Unless this is intended, delete this method.</p>
11.2096 -]]>
11.2097 - </Details>
11.2098 - </BugPattern>
11.2099 -
11.2100 - <BugPattern type="FI_USELESS">
11.2101 - <ShortDescription>Finalizer does nothing but call superclass finalizer</ShortDescription>
11.2102 - <LongDescription>{1} does nothing except call super.finalize(); delete it</LongDescription>
11.2103 - <Details>
11.2104 -<![CDATA[
11.2105 - <p> The only thing this <code>finalize()</code> method does is call
11.2106 - the superclass's <code>finalize()</code> method, making it
11.2107 - redundant. Delete it.</p>
11.2108 -]]>
11.2109 - </Details>
11.2110 - </BugPattern>
11.2111 -
11.2112 - <BugPattern type="FI_MISSING_SUPER_CALL">
11.2113 - <ShortDescription>Finalizer does not call superclass finalizer</ShortDescription>
11.2114 - <LongDescription>{1} missing call to super.finalize(), so {2}.finalize() doesn't get called</LongDescription>
11.2115 - <Details>
11.2116 -<![CDATA[
11.2117 - <p> This <code>finalize()</code> method does not make a call to its
11.2118 - superclass's <code>finalize()</code> method. So, any finalizer
11.2119 - actions defined for the superclass will not be performed.
11.2120 - Add a call to <code>super.finalize()</code>.</p>
11.2121 -]]>
11.2122 - </Details>
11.2123 - </BugPattern>
11.2124 -
11.2125 - <BugPattern type="FI_EXPLICIT_INVOCATION">
11.2126 - <ShortDescription>Explicit invocation of finalizer</ShortDescription>
11.2127 - <LongDescription>{1} explicitly invokes {2}</LongDescription>
11.2128 - <Details>
11.2129 -<![CDATA[
11.2130 - <p> This method contains an explicit invocation of the <code>finalize()</code>
11.2131 - method on an object. Because finalizer methods are supposed to be
11.2132 - executed once, and only by the VM, this is a bad idea.</p>
11.2133 -<p>If a connected set of objects beings finalizable, then the VM will invoke the
11.2134 -finalize method on all the finalizable object, possibly at the same time in different threads.
11.2135 -Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize
11.2136 -on objects referenced by X, because they may already be getting finalized in a separate thread.
11.2137 -]]>
11.2138 - </Details>
11.2139 - </BugPattern>
11.2140 -
11.2141 - <BugPattern type="EQ_DONT_DEFINE_EQUALS_FOR_ENUM">
11.2142 - <ShortDescription>Covariant equals() method defined for enum</ShortDescription>
11.2143 - <LongDescription>enum {0} defines equals({0.givenClass})</LongDescription>
11.2144 - <Details>
11.2145 -<![CDATA[
11.2146 - <p> This class defines an enumeration, and equality on enumerations are defined
11.2147 -using object identity. Definine a covariant equals method for an enumeration
11.2148 -value is exceptionally bad practice, since it would likely result
11.2149 -in having two different enumeration values that compare as equals using
11.2150 -the covariant enum method, and as not equal when compared normally.
11.2151 -Don't do it.
11.2152 -</p>
11.2153 -]]>
11.2154 - </Details>
11.2155 - </BugPattern>
11.2156 - <BugPattern type="EQ_SELF_USE_OBJECT">
11.2157 - <ShortDescription>Covariant equals() method defined, Object.equals(Object) inherited</ShortDescription>
11.2158 - <LongDescription>{0} defines equals({0.givenClass}) method and uses Object.equals(Object)</LongDescription>
11.2159 - <Details>
11.2160 -<![CDATA[
11.2161 - <p> This class defines a covariant version of the <code>equals()</code>
11.2162 - method, but inherits the normal <code>equals(Object)</code> method
11.2163 - defined in the base <code>java.lang.Object</code> class.
11.2164 - The class should probably define a non-covariant version of <code>equals()</code>.
11.2165 - (I.e., a method with the signature <code>boolean equals(java.lang.Object)</code>.</p>
11.2166 -]]>
11.2167 - </Details>
11.2168 - </BugPattern>
11.2169 - <BugPattern type="EQ_SELF_NO_OBJECT">
11.2170 - <ShortDescription>Covariant equals() method defined</ShortDescription>
11.2171 - <LongDescription>{0} defines equals({0.givenClass}) method but not equals(Object)</LongDescription>
11.2172 - <Details>
11.2173 -<![CDATA[
11.2174 - <p> This class defines a covariant version of <code>equals()</code>.
11.2175 - To correctly override the <code>equals()</code> method in
11.2176 - <code>java.lang.Object</code>, the parameter of <code>equals()</code>
11.2177 - must have type <code>java.lang.Object</code>.</p>
11.2178 -]]>
11.2179 - </Details>
11.2180 - </BugPattern>
11.2181 - <BugPattern type="HSC_HUGE_SHARED_STRING_CONSTANT">
11.2182 - <ShortDescription>Huge string constants is duplicated across multiple class files</ShortDescription>
11.2183 - <LongDescription>{1} is initialized to a string constant {2} characters long that is duplicated in {3} other class files</LongDescription>
11.2184 - <Details>
11.2185 - <![CDATA[
11.2186 - <p>
11.2187 - A large String constant is duplicated across multiple class files.
11.2188 - This is likely because a final field is initialized to a String constant, and the Java language
11.2189 - mandates that all references to a final field from other classes be inlined into
11.2190 -that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6447475">JDK bug 6447475</a>
11.2191 - for a description of an occurrence of this bug in the JDK and how resolving it reduced
11.2192 - the size of the JDK by 1 megabyte.
11.2193 -</p>
11.2194 - ]]>
11.2195 - </Details>
11.2196 - </BugPattern>
11.2197 - <BugPattern type="NP_ARGUMENT_MIGHT_BE_NULL">
11.2198 - <ShortDescription>Method does not check for null argument</ShortDescription>
11.2199 - <LongDescription>{1} does not check for null argument</LongDescription>
11.2200 - <Details>
11.2201 - <![CDATA[
11.2202 - <p>
11.2203 - A parameter to this method has been identified as a value that should
11.2204 - always be checked to see whether or not it is null, but it is being dereferenced
11.2205 - without a preceding null check.
11.2206 - </p>
11.2207 - ]]>
11.2208 - </Details>
11.2209 - </BugPattern>
11.2210 -
11.2211 - <BugPattern type="NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT">
11.2212 - <ShortDescription>equals() method does not check for null argument</ShortDescription>
11.2213 - <LongDescription>{1} does not check for null argument</LongDescription>
11.2214 - <Details>
11.2215 - <![CDATA[
11.2216 - <p>
11.2217 - This implementation of equals(Object) violates the contract defined
11.2218 - by java.lang.Object.equals() because it does not check for null
11.2219 - being passed as the argument. All equals() methods should return
11.2220 - false if passed a null value.
11.2221 - </p>
11.2222 - ]]>
11.2223 - </Details>
11.2224 - </BugPattern>
11.2225 -
11.2226 - <BugPattern type="NP_DOES_NOT_HANDLE_NULL">
11.2227 - <ShortDescription>equals() method does not check for null parameter</ShortDescription>
11.2228 - <LongDescription>{1} does not check for null parameter</LongDescription>
11.2229 - <Details>
11.2230 - <![CDATA[
11.2231 - <p>
11.2232 - This implementation of equals(Object) violates the contract defined
11.2233 - by java.lang.Object.equals() because it does not check for null
11.2234 - being passed as the parameter. All equals() methods should return
11.2235 - false if passed a null value.
11.2236 - </p>
11.2237 - ]]>
11.2238 - </Details>
11.2239 - </BugPattern>
11.2240 -
11.2241 - <BugPattern type="CO_SELF_NO_OBJECT">
11.2242 - <ShortDescription>Covariant compareTo() method defined</ShortDescription>
11.2243 - <LongDescription>{0} defines compareTo({0.givenClass}) method but not compareTo(Object)</LongDescription>
11.2244 - <Details>
11.2245 -<![CDATA[
11.2246 - <p> This class defines a covariant version of <code>compareTo()</code>.
11.2247 - To correctly override the <code>compareTo()</code> method in the
11.2248 - <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
11.2249 - must have type <code>java.lang.Object</code>.</p>
11.2250 -]]>
11.2251 - </Details>
11.2252 - </BugPattern>
11.2253 - <BugPattern type="HE_USE_OF_UNHASHABLE_CLASS">
11.2254 - <ShortDescription>Use of class without a hashCode() method in a hashed data structure</ShortDescription>
11.2255 - <LongDescription>{2} doesn't define a hashCode() method but is used in a hashed data structure</LongDescription>
11.2256 - <Details>
11.2257 -<![CDATA[
11.2258 - <p> A class defines an equals(Object) method but not a hashCode() method,
11.2259 -and thus doesn't fulfill the requirement that equal Objects have equal hashCodes.
11.2260 -An instance of this class is used in a hash data structure, making the need to
11.2261 -fix this problem of highest importance.
11.2262 -]]>
11.2263 - </Details>
11.2264 - </BugPattern>
11.2265 -
11.2266 -
11.2267 - <BugPattern type="HE_HASHCODE_USE_OBJECT_EQUALS">
11.2268 - <ShortDescription>Class defines hashCode() and uses Object.equals()</ShortDescription>
11.2269 - <LongDescription>{0} defines hashCode and uses Object.equals()</LongDescription>
11.2270 - <Details>
11.2271 -<![CDATA[
11.2272 - <p> This class defines a <code>hashCode()</code> method but inherits its
11.2273 - <code>equals()</code> method from <code>java.lang.Object</code>
11.2274 - (which defines equality by comparing object references). Although
11.2275 - this will probably satisfy the contract that equal objects must have
11.2276 - equal hashcodes, it is probably not what was intended by overriding
11.2277 - the <code>hashCode()</code> method. (Overriding <code>hashCode()</code>
11.2278 - implies that the object's identity is based on criteria more complicated
11.2279 - than simple reference equality.)</p>
11.2280 -<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
11.2281 -the recommended <code>hashCode</code> implementation to use is:</p>
11.2282 -<p><pre>public int hashCode() {
11.2283 - assert false : "hashCode not designed";
11.2284 - return 42; // any arbitrary constant will do
11.2285 - }</pre></p>
11.2286 -]]>
11.2287 - </Details>
11.2288 - </BugPattern>
11.2289 -
11.2290 -
11.2291 -
11.2292 - <BugPattern type="EQ_COMPARETO_USE_OBJECT_EQUALS">
11.2293 - <ShortDescription>Class defines compareTo(...) and uses Object.equals()</ShortDescription>
11.2294 - <LongDescription>{0} defines {1.givenClass} and uses Object.equals()</LongDescription>
11.2295 - <Details>
11.2296 -<![CDATA[
11.2297 - <p> This class defines a <code>compareTo(...)</code> method but inherits its
11.2298 - <code>equals()</code> method from <code>java.lang.Object</code>.
11.2299 - Generally, the value of compareTo should return zero if and only if
11.2300 - equals returns true. If this is violated, weird and unpredictable
11.2301 - failures will occur in classes such as PriorityQueue.
11.2302 - In Java 5 the PriorityQueue.remove method uses the compareTo method,
11.2303 - while in Java 6 it uses the equals method.
11.2304 -
11.2305 -<p>From the JavaDoc for the compareTo method in the Comparable interface:
11.2306 -<blockquote>
11.2307 -It is strongly recommended, but not strictly required that <code>(x.compareTo(y)==0) == (x.equals(y))</code>.
11.2308 -Generally speaking, any class that implements the Comparable interface and violates this condition
11.2309 -should clearly indicate this fact. The recommended language
11.2310 -is "Note: this class has a natural ordering that is inconsistent with equals."
11.2311 -</blockquote>
11.2312 -]]>
11.2313 - </Details>
11.2314 - </BugPattern>
11.2315 -
11.2316 -
11.2317 -
11.2318 -
11.2319 - <BugPattern type="HE_HASHCODE_NO_EQUALS">
11.2320 - <ShortDescription>Class defines hashCode() but not equals()</ShortDescription>
11.2321 - <LongDescription>{0} defines hashCode but not equals</LongDescription>
11.2322 - <Details>
11.2323 -<![CDATA[
11.2324 - <p> This class defines a <code>hashCode()</code> method but not an
11.2325 - <code>equals()</code> method. Therefore, the class may
11.2326 - violate the invariant that equal objects must have equal hashcodes.</p>
11.2327 -]]>
11.2328 - </Details>
11.2329 - </BugPattern>
11.2330 -
11.2331 - <BugPattern type="HE_EQUALS_USE_HASHCODE">
11.2332 - <ShortDescription>Class defines equals() and uses Object.hashCode()</ShortDescription>
11.2333 - <LongDescription>{0} defines equals and uses Object.hashCode()</LongDescription>
11.2334 - <Details>
11.2335 -<![CDATA[
11.2336 - <p> This class overrides <code>equals(Object)</code>, but does not
11.2337 - override <code>hashCode()</code>, and inherits the implementation of
11.2338 - <code>hashCode()</code> from <code>java.lang.Object</code> (which returns
11.2339 - the identity hash code, an arbitrary value assigned to the object
11.2340 - by the VM). Therefore, the class is very likely to violate the
11.2341 - invariant that equal objects must have equal hashcodes.</p>
11.2342 -
11.2343 -<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
11.2344 -the recommended <code>hashCode</code> implementation to use is:</p>
11.2345 -<pre>public int hashCode() {
11.2346 - assert false : "hashCode not designed";
11.2347 - return 42; // any arbitrary constant will do
11.2348 - }</pre>
11.2349 -]]>
11.2350 - </Details>
11.2351 - </BugPattern>
11.2352 - <BugPattern type="HE_INHERITS_EQUALS_USE_HASHCODE">
11.2353 - <ShortDescription>Class inherits equals() and uses Object.hashCode()</ShortDescription>
11.2354 - <LongDescription>{0} inherits equals and uses Object.hashCode()</LongDescription>
11.2355 - <Details>
11.2356 -<![CDATA[
11.2357 - <p> This class inherits <code>equals(Object)</code> from an abstract
11.2358 - superclass, and <code>hashCode()</code> from
11.2359 -<code>java.lang.Object</code> (which returns
11.2360 - the identity hash code, an arbitrary value assigned to the object
11.2361 - by the VM). Therefore, the class is very likely to violate the
11.2362 - invariant that equal objects must have equal hashcodes.</p>
11.2363 -
11.2364 - <p>If you don't want to define a hashCode method, and/or don't
11.2365 - believe the object will ever be put into a HashMap/Hashtable,
11.2366 - define the <code>hashCode()</code> method
11.2367 - to throw <code>UnsupportedOperationException</code>.</p>
11.2368 -]]>
11.2369 - </Details>
11.2370 - </BugPattern>
11.2371 - <BugPattern type="HE_EQUALS_NO_HASHCODE">
11.2372 - <ShortDescription>Class defines equals() but not hashCode()</ShortDescription>
11.2373 - <LongDescription>{0} defines equals but not hashCode</LongDescription>
11.2374 - <Details>
11.2375 -<![CDATA[
11.2376 - <p> This class overrides <code>equals(Object)</code>, but does not
11.2377 - override <code>hashCode()</code>. Therefore, the class may violate the
11.2378 - invariant that equal objects must have equal hashcodes.</p>
11.2379 -]]>
11.2380 - </Details>
11.2381 - </BugPattern>
11.2382 - <BugPattern type="EQ_ABSTRACT_SELF">
11.2383 - <ShortDescription>Abstract class defines covariant equals() method</ShortDescription>
11.2384 - <LongDescription>Abstract {0} defines equals({0.givenClass}) method</LongDescription>
11.2385 - <Details>
11.2386 -<![CDATA[
11.2387 - <p> This class defines a covariant version of <code>equals()</code>.
11.2388 - To correctly override the <code>equals()</code> method in
11.2389 - <code>java.lang.Object</code>, the parameter of <code>equals()</code>
11.2390 - must have type <code>java.lang.Object</code>.</p>
11.2391 -]]>
11.2392 - </Details>
11.2393 - </BugPattern>
11.2394 -
11.2395 - <BugPattern type="ES_COMPARING_STRINGS_WITH_EQ">
11.2396 - <ShortDescription>Comparison of String objects using == or !=</ShortDescription>
11.2397 - <LongDescription>Comparison of String objects using == or != in {1} </LongDescription>
11.2398 - <Details>
11.2399 -<![CDATA[
11.2400 - <p>This code compares <code>java.lang.String</code> objects for reference
11.2401 -equality using the == or != operators.
11.2402 -Unless both strings are either constants in a source file, or have been
11.2403 -interned using the <code>String.intern()</code> method, the same string
11.2404 -value may be represented by two different String objects. Consider
11.2405 -using the <code>equals(Object)</code> method instead.</p>
11.2406 -]]>
11.2407 - </Details>
11.2408 - </BugPattern>
11.2409 - <BugPattern type="ES_COMPARING_PARAMETER_STRING_WITH_EQ">
11.2410 - <ShortDescription>Comparison of String parameter using == or !=</ShortDescription>
11.2411 - <LongDescription>Comparison of String parameter using == or != in {1} </LongDescription>
11.2412 - <Details>
11.2413 -<![CDATA[
11.2414 - <p>This code compares a <code>java.lang.String</code> parameter for reference
11.2415 -equality using the == or != operators. Requiring callers to
11.2416 -pass only String constants or interned strings to a method is unnecessarily
11.2417 -fragile, and rarely leads to measurable performance gains. Consider
11.2418 -using the <code>equals(Object)</code> method instead.</p>
11.2419 -]]>
11.2420 - </Details>
11.2421 - </BugPattern>
11.2422 -
11.2423 - <BugPattern type="CO_ABSTRACT_SELF">
11.2424 - <ShortDescription>Abstract class defines covariant compareTo() method</ShortDescription>
11.2425 - <LongDescription>Abstract {0} defines compareTo({0.givenClass}) method</LongDescription>
11.2426 - <Details>
11.2427 -<![CDATA[
11.2428 - <p> This class defines a covariant version of <code>compareTo()</code>.
11.2429 - To correctly override the <code>compareTo()</code> method in the
11.2430 - <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
11.2431 - must have type <code>java.lang.Object</code>.</p>
11.2432 -]]>
11.2433 - </Details>
11.2434 - </BugPattern>
11.2435 -
11.2436 -
11.2437 - <BugPattern type="IS_FIELD_NOT_GUARDED">
11.2438 - <ShortDescription>Field not guarded against concurrent access</ShortDescription>
11.2439 - <LongDescription>{1.givenClass} not guarded against concurrent access; locked {2}% of time</LongDescription>
11.2440 - <Details>
11.2441 -<![CDATA[
11.2442 - <p> This field is annotated with net.jcip.annotations.GuardedBy,
11.2443 -but can be accessed in a way that seems to violate the annotation.</p>
11.2444 -]]>
11.2445 -</Details>
11.2446 -</BugPattern>
11.2447 -
11.2448 - <BugPattern type="IS2_INCONSISTENT_SYNC">
11.2449 - <ShortDescription>Inconsistent synchronization</ShortDescription>
11.2450 - <LongDescription>Inconsistent synchronization of {1}; locked {2}% of time</LongDescription>
11.2451 - <Details>
11.2452 -<![CDATA[
11.2453 - <p> The fields of this class appear to be accessed inconsistently with respect
11.2454 - to synchronization. This bug report indicates that the bug pattern detector
11.2455 - judged that
11.2456 - </p>
11.2457 - <ol>
11.2458 - <li> The class contains a mix of locked and unlocked accesses,</li>
11.2459 - <li> At least one locked access was performed by one of the class's own methods, and</li>
11.2460 - <li> The number of unsynchronized field accesses (reads and writes) was no more than
11.2461 - one third of all accesses, with writes being weighed twice as high as reads</li>
11.2462 - </ol>
11.2463 -
11.2464 - <p> A typical bug matching this bug pattern is forgetting to synchronize
11.2465 - one of the methods in a class that is intended to be thread-safe.</p>
11.2466 -
11.2467 - <p> You can select the nodes labeled "Unsynchronized access" to show the
11.2468 - code locations where the detector believed that a field was accessed
11.2469 - without synchronization.</p>
11.2470 -
11.2471 - <p> Note that there are various sources of inaccuracy in this detector;
11.2472 - for example, the detector cannot statically detect all situations in which
11.2473 - a lock is held. Also, even when the detector is accurate in
11.2474 - distinguishing locked vs. unlocked accesses, the code in question may still
11.2475 - be correct.</p>
11.2476 -
11.2477 - <p> This description refers to the "IS2" version of the pattern detector,
11.2478 - which has more accurate ways of detecting locked vs. unlocked accesses
11.2479 - than the older "IS" detector.</p>
11.2480 -]]>
11.2481 - </Details>
11.2482 - </BugPattern>
11.2483 - <BugPattern type="NN_NAKED_NOTIFY">
11.2484 - <ShortDescription>Naked notify</ShortDescription>
11.2485 - <LongDescription>Naked notify in {1}</LongDescription>
11.2486 - <Details>
11.2487 -<![CDATA[
11.2488 - <p> A call to <code>notify()</code> or <code>notifyAll()</code>
11.2489 - was made without any (apparent) accompanying
11.2490 - modification to mutable object state. In general, calling a notify
11.2491 - method on a monitor is done because some condition another thread is
11.2492 - waiting for has become true. However, for the condition to be meaningful,
11.2493 - it must involve a heap object that is visible to both threads.</p>
11.2494 -
11.2495 - <p> This bug does not necessarily indicate an error, since the change to
11.2496 - mutable object state may have taken place in a method which then called
11.2497 - the method containing the notification.</p>
11.2498 -]]>
11.2499 - </Details>
11.2500 - </BugPattern>
11.2501 - <BugPattern type="MS_EXPOSE_REP">
11.2502 - <ShortDescription>Public static method may expose internal representation by returning array</ShortDescription>
11.2503 - <LongDescription>public static {1} may expose internal representation by returning {2.givenClass}</LongDescription>
11.2504 - <Details>
11.2505 -<![CDATA[
11.2506 - <p> A public static method returns a reference to
11.2507 - an array that is part of the static state of the class.
11.2508 - Any code that calls this method can freely modify
11.2509 - the underlying array.
11.2510 - One fix is to return a copy of the array.</p>
11.2511 -]]>
11.2512 - </Details>
11.2513 - </BugPattern>
11.2514 - <BugPattern type="EI_EXPOSE_REP">
11.2515 - <ShortDescription>May expose internal representation by returning reference to mutable object</ShortDescription>
11.2516 - <LongDescription>{1} may expose internal representation by returning {2.givenClass}</LongDescription>
11.2517 - <Details>
11.2518 -<![CDATA[
11.2519 - <p> Returning a reference to a mutable object value stored in one of the object's fields
11.2520 - exposes the internal representation of the object.
11.2521 - If instances
11.2522 - are accessed by untrusted code, and unchecked changes to
11.2523 - the mutable object would compromise security or other
11.2524 - important properties, you will need to do something different.
11.2525 - Returning a new copy of the object is better approach in many situations.</p>
11.2526 -]]>
11.2527 - </Details>
11.2528 - </BugPattern>
11.2529 - <BugPattern type="EI_EXPOSE_REP2">
11.2530 - <ShortDescription>May expose internal representation by incorporating reference to mutable object</ShortDescription>
11.2531 - <LongDescription>{1} may expose internal representation by storing an externally mutable object into {2.givenClass}</LongDescription>
11.2532 - <Details>
11.2533 -<![CDATA[
11.2534 - <p> This code stores a reference to an externally mutable object into the
11.2535 - internal representation of the object.
11.2536 - If instances
11.2537 - are accessed by untrusted code, and unchecked changes to
11.2538 - the mutable object would compromise security or other
11.2539 - important properties, you will need to do something different.
11.2540 - Storing a copy of the object is better approach in many situations.</p>
11.2541 -]]>
11.2542 - </Details>
11.2543 - </BugPattern>
11.2544 - <BugPattern type="EI_EXPOSE_STATIC_REP2">
11.2545 - <ShortDescription>May expose internal static state by storing a mutable object into a static field</ShortDescription>
11.2546 - <LongDescription>{1} may expose internal static state by storing a mutable object into a static field {2}</LongDescription>
11.2547 - <Details>
11.2548 -<![CDATA[
11.2549 - <p> This code stores a reference to an externally mutable object into a static
11.2550 - field.
11.2551 - If unchecked changes to
11.2552 - the mutable object would compromise security or other
11.2553 - important properties, you will need to do something different.
11.2554 - Storing a copy of the object is better approach in many situations.</p>
11.2555 -]]>
11.2556 - </Details>
11.2557 - </BugPattern>
11.2558 - <BugPattern type="RU_INVOKE_RUN">
11.2559 - <ShortDescription>Invokes run on a thread (did you mean to start it instead?)</ShortDescription>
11.2560 - <LongDescription>{1} explicitly invokes run on a thread (did you mean to start it instead?)</LongDescription>
11.2561 - <Details>
11.2562 -<![CDATA[
11.2563 - <p> This method explicitly invokes <code>run()</code> on an object.
11.2564 - In general, classes implement the <code>Runnable</code> interface because
11.2565 - they are going to have their <code>run()</code> method invoked in a new thread,
11.2566 - in which case <code>Thread.start()</code> is the right method to call.</p>
11.2567 -]]>
11.2568 - </Details>
11.2569 - </BugPattern>
11.2570 - <BugPattern type="SP_SPIN_ON_FIELD">
11.2571 - <ShortDescription>Method spins on field</ShortDescription>
11.2572 - <LongDescription>Spinning on {2.givenClass} in {1}</LongDescription>
11.2573 - <Details>
11.2574 -<![CDATA[
11.2575 - <p> This method spins in a loop which reads a field. The compiler
11.2576 - may legally hoist the read out of the loop, turning the code into an
11.2577 - infinite loop. The class should be changed so it uses proper
11.2578 - synchronization (including wait and notify calls).</p>
11.2579 -]]>
11.2580 - </Details>
11.2581 - </BugPattern>
11.2582 - <BugPattern type="NS_DANGEROUS_NON_SHORT_CIRCUIT">
11.2583 - <ShortDescription>Potentially dangerous use of non-short-circuit logic</ShortDescription>
11.2584 - <LongDescription>Potentially dangerous use of non-short-circuit logic in {1}</LongDescription>
11.2585 - <Details>
11.2586 -<![CDATA[
11.2587 - <p> This code seems to be using non-short-circuit logic (e.g., &
11.2588 -or |)
11.2589 -rather than short-circuit logic (&& or ||). In addition,
11.2590 -it seem possible that, depending on the value of the left hand side, you might not
11.2591 -want to evaluate the right hand side (because it would have side effects, could cause an exception
11.2592 -or could be expensive.</p>
11.2593 -<p>
11.2594 -Non-short-circuit logic causes both sides of the expression
11.2595 -to be evaluated even when the result can be inferred from
11.2596 -knowing the left-hand side. This can be less efficient and
11.2597 -can result in errors if the left-hand side guards cases
11.2598 -when evaluating the right-hand side can generate an error.
11.2599 -</p>
11.2600 -
11.2601 -<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
11.2602 -Language Specification</a> for details
11.2603 -
11.2604 -</p>
11.2605 -]]>
11.2606 - </Details>
11.2607 - </BugPattern>
11.2608 - <BugPattern type="NS_NON_SHORT_CIRCUIT">
11.2609 - <ShortDescription>Questionable use of non-short-circuit logic</ShortDescription>
11.2610 - <LongDescription>Questionable use of non-short-circuit logic in {1}</LongDescription>
11.2611 - <Details>
11.2612 -<![CDATA[
11.2613 - <p> This code seems to be using non-short-circuit logic (e.g., &
11.2614 -or |)
11.2615 -rather than short-circuit logic (&& or ||).
11.2616 -Non-short-circuit logic causes both sides of the expression
11.2617 -to be evaluated even when the result can be inferred from
11.2618 -knowing the left-hand side. This can be less efficient and
11.2619 -can result in errors if the left-hand side guards cases
11.2620 -when evaluating the right-hand side can generate an error.
11.2621 -
11.2622 -<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
11.2623 -Language Specification</a> for details
11.2624 -
11.2625 -</p>
11.2626 -]]>
11.2627 - </Details>
11.2628 - </BugPattern>
11.2629 -
11.2630 -
11.2631 -
11.2632 -
11.2633 - <BugPattern type="TLW_TWO_LOCK_WAIT">
11.2634 - <ShortDescription>Wait with two locks held</ShortDescription>
11.2635 - <LongDescription>wait() with two locks held in {1}</LongDescription>
11.2636 - <Details>
11.2637 -<![CDATA[
11.2638 - <p> Waiting on a monitor while two locks are held may cause
11.2639 - deadlock.
11.2640 -
11.2641 - Performing a wait only releases the lock on the object
11.2642 - being waited on, not any other locks.
11.2643 -
11.2644 -This not necessarily a bug, but is worth examining
11.2645 - closely.</p>
11.2646 -]]>
11.2647 - </Details>
11.2648 - </BugPattern>
11.2649 - <BugPattern type="TLW_TWO_LOCK_NOTIFY" deprecated="true"> <!-- never generated -->
11.2650 - <ShortDescription>Notify with two locks held</ShortDescription>
11.2651 - <LongDescription>notify() or notifyAll*() with two locks held in {1}</LongDescription>
11.2652 - <Details>
11.2653 -<![CDATA[
11.2654 - <p> The code calls notify() or notifyAll() while two locks
11.2655 - are held. If this notification is intended to wake up a wait()
11.2656 - that is holding the same locks, it may deadlock, since the wait
11.2657 - will only give up one lock and the notify will be unable to get both locks,
11.2658 - and thus the notify will not succeed.
11.2659 - If there is also a warning about a two lock wait, the
11.2660 - probably of a bug is quite high.
11.2661 -</p>
11.2662 -]]>
11.2663 - </Details>
11.2664 - </BugPattern>
11.2665 -
11.2666 - <BugPattern type="UW_UNCOND_WAIT">
11.2667 - <ShortDescription>Unconditional wait</ShortDescription>
11.2668 - <LongDescription>Unconditional wait in {1}</LongDescription>
11.2669 - <Details>
11.2670 -<![CDATA[
11.2671 - <p> This method contains a call to <code>java.lang.Object.wait()</code> which
11.2672 - is not guarded by conditional control flow. The code should
11.2673 - verify that condition it intends to wait for is not already satisfied
11.2674 - before calling wait; any previous notifications will be ignored.
11.2675 - </p>
11.2676 -]]>
11.2677 - </Details>
11.2678 - </BugPattern>
11.2679 - <BugPattern type="UR_UNINIT_READ">
11.2680 - <ShortDescription>Uninitialized read of field in constructor</ShortDescription>
11.2681 - <LongDescription>Uninitialized read of {2.name} in {1}</LongDescription>
11.2682 - <Details>
11.2683 -<![CDATA[
11.2684 - <p> This constructor reads a field which has not yet been assigned a value.
11.2685 - This is often caused when the programmer mistakenly uses the field instead
11.2686 - of one of the constructor's parameters.</p>
11.2687 -]]>
11.2688 - </Details>
11.2689 - </BugPattern>
11.2690 - <BugPattern type="UG_SYNC_SET_UNSYNC_GET">
11.2691 - <ShortDescription>Unsynchronized get method, synchronized set method</ShortDescription>
11.2692 - <LongDescription>{1} is unsynchronized, {2} is synchronized</LongDescription>
11.2693 - <Details>
11.2694 -<![CDATA[
11.2695 - <p> This class contains similarly-named get and set
11.2696 - methods where the set method is synchronized and the get method is not.
11.2697 - This may result in incorrect behavior at runtime, as callers of the get
11.2698 - method will not necessarily see a consistent state for the object.
11.2699 - The get method should be made synchronized.</p>
11.2700 -]]>
11.2701 - </Details>
11.2702 - </BugPattern>
11.2703 -
11.2704 - <BugPattern type="IC_INIT_CIRCULARITY">
11.2705 - <ShortDescription>Initialization circularity</ShortDescription>
11.2706 - <LongDescription>Initialization circularity between {0} and {1}</LongDescription>
11.2707 - <Details>
11.2708 -<![CDATA[
11.2709 - <p> A circularity was detected in the static initializers of the two
11.2710 - classes referenced by the bug instance. Many kinds of unexpected
11.2711 - behavior may arise from such circularity.</p>
11.2712 -]]>
11.2713 - </Details>
11.2714 - </BugPattern>
11.2715 -
11.2716 - <BugPattern type="IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION">
11.2717 - <ShortDescription>Superclass uses subclass during initialization</ShortDescription>
11.2718 - <LongDescription>Initialization of {0} accesses class {2}, which isn't initialized yet</LongDescription>
11.2719 - <Details>
11.2720 -<![CDATA[
11.2721 - <p> During the initialization of a class, the class makes an active use of a subclass.
11.2722 -That subclass will not yet be initialized at the time of this use.
11.2723 -For example, in the following code, <code>foo</code> will be null.</p>
11.2724 -
11.2725 -<pre>
11.2726 -public class CircularClassInitialization {
11.2727 - static class InnerClassSingleton extends CircularClassInitialization {
11.2728 - static InnerClassSingleton singleton = new InnerClassSingleton();
11.2729 - }
11.2730 -
11.2731 - static CircularClassInitialization foo = InnerClassSingleton.singleton;
11.2732 -}
11.2733 -</pre>
11.2734 -
11.2735 -]]>
11.2736 - </Details>
11.2737 - </BugPattern>
11.2738 -
11.2739 -
11.2740 -
11.2741 - <BugPattern type="IT_NO_SUCH_ELEMENT">
11.2742 - <ShortDescription>Iterator next() method can't throw NoSuchElement exception</ShortDescription>
11.2743 - <LongDescription>{1} can't throw NoSuchElement exception</LongDescription>
11.2744 - <Details>
11.2745 -<![CDATA[
11.2746 - <p> This class implements the <code>java.util.Iterator</code> interface.
11.2747 - However, its <code>next()</code> method is not capable of throwing
11.2748 - <code>java.util.NoSuchElementException</code>. The <code>next()</code>
11.2749 - method should be changed so it throws <code>NoSuchElementException</code>
11.2750 - if is called when there are no more elements to return.</p>
11.2751 -]]>
11.2752 - </Details>
11.2753 - </BugPattern>
11.2754 -
11.2755 - <BugPattern type="ESync_EMPTY_SYNC">
11.2756 - <ShortDescription>Empty synchronized block</ShortDescription>
11.2757 - <LongDescription>Empty synchronized block in {1}</LongDescription>
11.2758 - <Details>
11.2759 -<![CDATA[
11.2760 - <p> The code contains an empty synchronized block:</p>
11.2761 -<pre>
11.2762 -synchronized() {}
11.2763 -</pre>
11.2764 -<p>Empty synchronized blocks are far more subtle and hard to use correctly
11.2765 -than most people recognize, and empty synchronized blocks
11.2766 -are almost never a better solution
11.2767 -than less contrived solutions.
11.2768 -</p>
11.2769 -]]>
11.2770 - </Details>
11.2771 - </BugPattern>
11.2772 -
11.2773 - <BugPattern type="IS_INCONSISTENT_SYNC">
11.2774 - <ShortDescription>Inconsistent synchronization</ShortDescription>
11.2775 - <LongDescription>Inconsistent synchronization of {1}; locked {2}% of the time</LongDescription>
11.2776 - <Details>
11.2777 -<![CDATA[
11.2778 - <p> The fields of this class appear to be accessed inconsistently with respect
11.2779 - to synchronization. This bug report indicates that the bug pattern detector
11.2780 - judged that
11.2781 - </p>
11.2782 - <ol>
11.2783 - <li> The class contains a mix of locked and unlocked accesses,</li>
11.2784 - <li> At least one locked access was performed by one of the class's own methods, and</li>
11.2785 - <li> The number of unsynchronized field accesses (reads and writes) was no more than
11.2786 - one third of all accesses, with writes being weighed twice as high as reads</li>
11.2787 - </ol>
11.2788 -
11.2789 - <p> A typical bug matching this bug pattern is forgetting to synchronize
11.2790 - one of the methods in a class that is intended to be thread-safe.</p>
11.2791 -
11.2792 - <p> Note that there are various sources of inaccuracy in this detector;
11.2793 - for example, the detector cannot statically detect all situations in which
11.2794 - a lock is held. Also, even when the detector is accurate in
11.2795 - distinguishing locked vs. unlocked accesses, the code in question may still
11.2796 - be correct.</p>
11.2797 -]]>
11.2798 - </Details>
11.2799 - </BugPattern>
11.2800 -
11.2801 - <BugPattern type="ML_SYNC_ON_UPDATED_FIELD">
11.2802 - <ShortDescription>Method synchronizes on an updated field</ShortDescription>
11.2803 - <LongDescription>{1} synchronizes on updated field {2.givenClass}</LongDescription>
11.2804 - <Details>
11.2805 -<![CDATA[
11.2806 - <p> This method synchronizes on an object
11.2807 - references from a mutable field.
11.2808 - This is unlikely to have useful semantics, since different
11.2809 -threads may be synchronizing on different objects.</p>
11.2810 -]]>
11.2811 - </Details>
11.2812 - </BugPattern>
11.2813 - <BugPattern type="MS_OOI_PKGPROTECT">
11.2814 - <ShortDescription>Field should be moved out of an interface and made package protected</ShortDescription>
11.2815 - <LongDescription>{1} should be moved out of an interface and made package protected</LongDescription>
11.2816 - <Details>
11.2817 -<![CDATA[
11.2818 -<p>
11.2819 - A final static field that is
11.2820 -defined in an interface references a mutable
11.2821 - object such as an array or hashtable.
11.2822 - This mutable object could
11.2823 - be changed by malicious code or
11.2824 - by accident from another package.
11.2825 - To solve this, the field needs to be moved to a class
11.2826 - and made package protected
11.2827 - to avoid
11.2828 - this vulnerability.</p>
11.2829 -]]>
11.2830 - </Details>
11.2831 - </BugPattern>
11.2832 - <BugPattern type="MS_FINAL_PKGPROTECT">
11.2833 - <ShortDescription>Field should be both final and package protected</ShortDescription>
11.2834 - <LongDescription>{1} should be both final and package protected</LongDescription>
11.2835 - <Details>
11.2836 -<![CDATA[
11.2837 - <p>
11.2838 - A mutable static field could be changed by malicious code or
11.2839 - by accident from another package.
11.2840 - The field could be made package protected and/or made final
11.2841 - to avoid
11.2842 - this vulnerability.</p>
11.2843 -]]>
11.2844 - </Details>
11.2845 - </BugPattern>
11.2846 - <BugPattern type="MS_SHOULD_BE_FINAL">
11.2847 - <ShortDescription>Field isn't final but should be</ShortDescription>
11.2848 - <LongDescription>{1} isn't final but should be</LongDescription>
11.2849 - <Details>
11.2850 -<![CDATA[
11.2851 - <p>
11.2852 - A mutable static field could be changed by malicious code or
11.2853 - by accident from another package.
11.2854 - The field could be made final to avoid
11.2855 - this vulnerability.</p>
11.2856 -]]>
11.2857 - </Details>
11.2858 - </BugPattern>
11.2859 - <BugPattern type="MS_PKGPROTECT">
11.2860 - <ShortDescription>Field should be package protected</ShortDescription>
11.2861 - <LongDescription>{1} should be package protected</LongDescription>
11.2862 - <Details>
11.2863 -<![CDATA[
11.2864 - <p> A mutable static field could be changed by malicious code or
11.2865 - by accident.
11.2866 - The field could be made package protected to avoid
11.2867 - this vulnerability.</p>
11.2868 -]]>
11.2869 - </Details>
11.2870 - </BugPattern>
11.2871 - <BugPattern type="MS_MUTABLE_HASHTABLE">
11.2872 - <ShortDescription>Field is a mutable Hashtable</ShortDescription>
11.2873 - <LongDescription>{1} is a mutable Hashtable</LongDescription>
11.2874 - <Details>
11.2875 -<![CDATA[
11.2876 - <p>A final static field references a Hashtable
11.2877 - and can be accessed by malicious code or
11.2878 - by accident from another package.
11.2879 - This code can freely modify the contents of the Hashtable.</p>
11.2880 -]]>
11.2881 - </Details>
11.2882 - </BugPattern>
11.2883 - <BugPattern type="MS_MUTABLE_ARRAY">
11.2884 - <ShortDescription>Field is a mutable array</ShortDescription>
11.2885 - <LongDescription>{1} is a mutable array</LongDescription>
11.2886 - <Details>
11.2887 -<![CDATA[
11.2888 -<p> A final static field references an array
11.2889 - and can be accessed by malicious code or
11.2890 - by accident from another package.
11.2891 - This code can freely modify the contents of the array.</p>
11.2892 -]]>
11.2893 - </Details>
11.2894 - </BugPattern>
11.2895 - <BugPattern type="MS_CANNOT_BE_FINAL">
11.2896 - <ShortDescription>Field isn't final and can't be protected from malicious code</ShortDescription>
11.2897 - <LongDescription>{1} isn't final and can't be protected from malicious code </LongDescription>
11.2898 - <Details>
11.2899 -<![CDATA[
11.2900 - <p>
11.2901 - A mutable static field could be changed by malicious code or
11.2902 - by accident from another package.
11.2903 - Unfortunately, the way the field is used doesn't allow
11.2904 - any easy fix to this problem.</p>
11.2905 -]]>
11.2906 - </Details>
11.2907 - </BugPattern>
11.2908 -
11.2909 - <BugPattern type="IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD">
11.2910 - <ShortDescription>Ambiguous invocation of either an inherited or outer method</ShortDescription>
11.2911 - <LongDescription>Ambiguous invocation of either an outer or inherited method {2} in {1}</LongDescription>
11.2912 - <Details>
11.2913 -<![CDATA[
11.2914 - <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,
11.2915 -it will be resolved to invoke the inherited method, but this may not be want
11.2916 -you intend. If you really intend to invoke the inherited method,
11.2917 -invoke it by invoking the method on super (e.g., invoke super.foo(17)), and
11.2918 -thus it will be clear to other readers of your code and to FindBugs
11.2919 -that you want to invoke the inherited method, not the method in the outer class.
11.2920 -</p>
11.2921 -]]>
11.2922 - </Details>
11.2923 - </BugPattern>
11.2924 - <BugPattern type="NM_CLASS_NAMING_CONVENTION">
11.2925 - <ShortDescription>Class names should start with an upper case letter</ShortDescription>
11.2926 - <LongDescription>The class name {0} doesn't start with an upper case letter</LongDescription>
11.2927 - <Details>
11.2928 -<![CDATA[
11.2929 - <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).
11.2930 -</p>
11.2931 -]]>
11.2932 - </Details>
11.2933 - </BugPattern>
11.2934 -
11.2935 - <BugPattern type="NM_METHOD_NAMING_CONVENTION">
11.2936 - <ShortDescription>Method names should start with an lower case letter</ShortDescription>
11.2937 - <LongDescription>The method name {1} doesn't start with an lower case letter</LongDescription>
11.2938 - <Details>
11.2939 -<![CDATA[
11.2940 - <p>
11.2941 -Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.
11.2942 -</p>
11.2943 -]]>
11.2944 - </Details>
11.2945 - </BugPattern>
11.2946 -
11.2947 - <BugPattern type="NM_FIELD_NAMING_CONVENTION">
11.2948 - <ShortDescription>Field names should start with an lower case letter</ShortDescription>
11.2949 - <LongDescription>The field name {1} doesn't start with an lower case letter</LongDescription>
11.2950 - <Details>
11.2951 -<![CDATA[
11.2952 - <p>
11.2953 -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.
11.2954 -</p>
11.2955 -]]>
11.2956 - </Details>
11.2957 - </BugPattern>
11.2958 -
11.2959 - <BugPattern type="NM_VERY_CONFUSING">
11.2960 - <ShortDescription>Very confusing method names</ShortDescription>
11.2961 - <LongDescription>VERY confusing to have methods {1} and {3}</LongDescription>
11.2962 - <Details>
11.2963 -<![CDATA[
11.2964 - <p> The referenced methods have names that differ only by capitalization or the packages of their parameters.
11.2965 -This is very confusing because if the capitalization and parameter package names were
11.2966 -identical then one of the methods would override the other.
11.2967 -</p>
11.2968 -]]>
11.2969 - </Details>
11.2970 - </BugPattern>
11.2971 - <BugPattern type="NM_VERY_CONFUSING_INTENTIONAL">
11.2972 - <ShortDescription>Very confusing method names (but intentional)</ShortDescription>
11.2973 - <LongDescription>VERY confusing (but perhaps intentional) to have methods {1} and {3}</LongDescription>
11.2974 - <Details>
11.2975 -<![CDATA[
11.2976 - <p> The referenced methods have names that differ only by capitalization or the packages of their parameters.
11.2977 -This is very confusing because if the capitalization were
11.2978 -identical then one of the methods would override the other. From the existence of other methods, it
11.2979 -seems that the existence of both of these methods is intentional, but is sure is confusing.
11.2980 -You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.
11.2981 -</p>
11.2982 -]]>
11.2983 - </Details>
11.2984 - </BugPattern>
11.2985 -
11.2986 -
11.2987 - <BugPattern type="NM_CONFUSING">
11.2988 - <ShortDescription>Confusing method names</ShortDescription>
11.2989 - <LongDescription>Confusing to have methods {1} and {3}</LongDescription>
11.2990 - <Details>
11.2991 -<![CDATA[
11.2992 - <p> The referenced methods have names that differ only by capitalization.</p>
11.2993 -]]>
11.2994 - </Details>
11.2995 - </BugPattern>
11.2996 - <BugPattern type="NM_METHOD_CONSTRUCTOR_CONFUSION">
11.2997 - <ShortDescription>Apparent method/constructor confusion</ShortDescription>
11.2998 - <LongDescription>Method {1} was probably intended to be a constructor</LongDescription>
11.2999 - <Details>
11.3000 -<![CDATA[
11.3001 - <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.
11.3002 - If it was intended to be a constructor, remove the declaration of a void return value.
11.3003 - If you had accidently defined this method, realized the mistake, defined a proper constructor
11.3004 - but can't get rid of this method due to backwards compatibility, deprecate the method.
11.3005 -</p>
11.3006 -]]>
11.3007 - </Details>
11.3008 - </BugPattern>
11.3009 - <BugPattern type="NM_LCASE_HASHCODE">
11.3010 - <ShortDescription>Class defines hashcode(); should it be hashCode()?</ShortDescription>
11.3011 - <LongDescription>Class {0} defines hashcode(); should it be hashCode()?</LongDescription>
11.3012 - <Details>
11.3013 -<![CDATA[
11.3014 - <p> This class defines a method called <code>hashcode()</code>. This method
11.3015 - does not override the <code>hashCode()</code> method in <code>java.lang.Object</code>,
11.3016 - which is probably what was intended.</p>
11.3017 -]]>
11.3018 - </Details>
11.3019 - </BugPattern>
11.3020 - <BugPattern type="NM_LCASE_TOSTRING">
11.3021 - <ShortDescription>Class defines tostring(); should it be toString()?</ShortDescription>
11.3022 - <LongDescription>Class {0} defines tostring(); should it be toString()?</LongDescription>
11.3023 - <Details>
11.3024 -<![CDATA[
11.3025 - <p> This class defines a method called <code>tostring()</code>. This method
11.3026 - does not override the <code>toString()</code> method in <code>java.lang.Object</code>,
11.3027 - which is probably what was intended.</p>
11.3028 -]]>
11.3029 - </Details>
11.3030 - </BugPattern>
11.3031 -
11.3032 - <BugPattern type="NM_BAD_EQUAL">
11.3033 - <ShortDescription>Class defines equal(); should it be equals()?</ShortDescription>
11.3034 - <LongDescription>Class {0} defines equal(); should it be equals()?</LongDescription>
11.3035 - <Details>
11.3036 -<![CDATA[
11.3037 -<p> This class defines a method <code>equal(Object)</code>. This method does
11.3038 -not override the <code>equals(Object)</code> method in <code>java.lang.Object</code>,
11.3039 -which is probably what was intended.</p>
11.3040 -]]>
11.3041 - </Details>
11.3042 - </BugPattern>
11.3043 -
11.3044 - <BugPattern type="NM_CLASS_NOT_EXCEPTION">
11.3045 - <ShortDescription>Class is not derived from an Exception, even though it is named as such</ShortDescription>
11.3046 - <LongDescription>Class {0} is not derived from an Exception, even though it is named as such</LongDescription>
11.3047 - <Details>
11.3048 -<![CDATA[
11.3049 -<p> This class is not derived from another exception, but ends with 'Exception'. This will
11.3050 -be confusing to users of this class.</p>
11.3051 -]]>
11.3052 - </Details>
11.3053 - </BugPattern>
11.3054 -
11.3055 - <BugPattern type="RR_NOT_CHECKED">
11.3056 - <ShortDescription>Method ignores results of InputStream.read()</ShortDescription>
11.3057 - <LongDescription>{1} ignores result of {2}</LongDescription>
11.3058 - <Details>
11.3059 -<![CDATA[
11.3060 - <p> This method ignores the return value of one of the variants of
11.3061 - <code>java.io.InputStream.read()</code> which can return multiple bytes.
11.3062 - If the return value is not checked, the caller will not be able to correctly
11.3063 - handle the case where fewer bytes were read than the caller requested.
11.3064 - This is a particularly insidious kind of bug, because in many programs,
11.3065 - reads from input streams usually do read the full amount of data requested,
11.3066 - causing the program to fail only sporadically.</p>
11.3067 -]]>
11.3068 - </Details>
11.3069 - </BugPattern>
11.3070 - <BugPattern type="SR_NOT_CHECKED">
11.3071 - <ShortDescription>Method ignores results of InputStream.skip()</ShortDescription>
11.3072 - <LongDescription>{1} ignores result of {2}</LongDescription>
11.3073 - <Details>
11.3074 -<![CDATA[
11.3075 - <p> This method ignores the return value of
11.3076 - <code>java.io.InputStream.skip()</code> which can skip multiple bytes.
11.3077 - If the return value is not checked, the caller will not be able to correctly
11.3078 - handle the case where fewer bytes were skipped than the caller requested.
11.3079 - This is a particularly insidious kind of bug, because in many programs,
11.3080 - skips from input streams usually do skip the full amount of data requested,
11.3081 - causing the program to fail only sporadically. With Buffered streams, however,
11.3082 - skip() will only skip data in the buffer, and will routinely fail to skip the
11.3083 - requested number of bytes.</p>
11.3084 -]]>
11.3085 - </Details>
11.3086 - </BugPattern>
11.3087 - <BugPattern type="SE_READ_RESOLVE_MUST_RETURN_OBJECT">
11.3088 - <ShortDescription>The readResolve method must be declared with a return type
11.3089 -of Object. </ShortDescription>
11.3090 - <LongDescription>The method {1} must be declared with a return type of Object rather than {1.returnType}</LongDescription>
11.3091 - <Details>
11.3092 -<![CDATA[
11.3093 - <p> In order for the readResolve method to be recognized by the serialization
11.3094 -mechanism.
11.3095 -</p>
11.3096 -]]>
11.3097 - </Details>
11.3098 - </BugPattern>
11.3099 - <BugPattern type="SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS">
11.3100 - <ShortDescription>Transient field of class that isn't Serializable. </ShortDescription>
11.3101 - <LongDescription>{1.givenClass} is transient but {0} isn't Serializable</LongDescription>
11.3102 - <Details>
11.3103 -<![CDATA[
11.3104 - <p> The field is marked as transient, but the class isn't Serializable, so marking it as transient
11.3105 -has absolutely no effect.
11.3106 -This may be leftover marking from a previous version of the code in which the class was transient, or
11.3107 -it may indicate a misunderstanding of how serialization works.
11.3108 -</p>
11.3109 -]]>
11.3110 - </Details>
11.3111 - </BugPattern>
11.3112 -
11.3113 - <BugPattern type="SE_TRANSIENT_FIELD_NOT_RESTORED">
11.3114 - <ShortDescription>Transient field that isn't set by deserialization. </ShortDescription>
11.3115 - <LongDescription>The field {1} is transient but isn't set by deserialization</LongDescription>
11.3116 - <Details>
11.3117 -<![CDATA[
11.3118 - <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
11.3119 -deserialized instance of the class.
11.3120 -</p>
11.3121 -]]>
11.3122 - </Details>
11.3123 - </BugPattern>
11.3124 -
11.3125 - <BugPattern type="SE_METHOD_MUST_BE_PRIVATE">
11.3126 - <ShortDescription>Method must be private in order for serialization to work</ShortDescription>
11.3127 - <LongDescription>The method {1.givenClass} must be private to be invoked in serialization/deserialization of {0}</LongDescription>
11.3128 - <Details>
11.3129 -<![CDATA[
11.3130 - <p> This class implements the <code>Serializable</code> interface, and defines a method
11.3131 - for custom serialization/deserialization. But since that method isn't declared private,
11.3132 - it will be silently ignored by the serialization/deserialization API.</p>
11.3133 -]]>
11.3134 - </Details>
11.3135 - </BugPattern>
11.3136 -
11.3137 - <BugPattern type="SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION">
11.3138 - <ShortDescription>Class is Externalizable but doesn't define a void constructor</ShortDescription>
11.3139 - <LongDescription>{0} is Externalizable but doesn't define a void constructor</LongDescription>
11.3140 - <Details>
11.3141 -<![CDATA[
11.3142 - <p> This class implements the <code>Externalizable</code> interface, but does
11.3143 - not define a void constructor. When Externalizable objects are deserialized,
11.3144 - they first need to be constructed by invoking the void
11.3145 - constructor. Since this class does not have one,
11.3146 - serialization and deserialization will fail at runtime.</p>
11.3147 -]]>
11.3148 - </Details>
11.3149 - </BugPattern>
11.3150 - <BugPattern type="SE_NO_SUITABLE_CONSTRUCTOR">
11.3151 - <ShortDescription>Class is Serializable but its superclass doesn't define a void constructor</ShortDescription>
11.3152 - <LongDescription>{0} is Serializable but its superclass doesn't define an accessible void constructor</LongDescription>
11.3153 - <Details>
11.3154 -<![CDATA[
11.3155 - <p> This class implements the <code>Serializable</code> interface
11.3156 - and its superclass does not. When such an object is deserialized,
11.3157 - the fields of the superclass need to be initialized by
11.3158 - invoking the void constructor of the superclass.
11.3159 - Since the superclass does not have one,
11.3160 - serialization and deserialization will fail at runtime.</p>
11.3161 -]]>
11.3162 - </Details>
11.3163 - </BugPattern>
11.3164 -
11.3165 - <BugPattern type="SE_NO_SERIALVERSIONID">
11.3166 - <ShortDescription>Class is Serializable, but doesn't define serialVersionUID</ShortDescription>
11.3167 - <LongDescription>{0} is Serializable; consider declaring a serialVersionUID</LongDescription>
11.3168 - <Details>
11.3169 -<![CDATA[
11.3170 - <p> This class implements the <code>Serializable</code> interface, but does
11.3171 - not define a <code>serialVersionUID</code> field.
11.3172 - A change as simple as adding a reference to a .class object
11.3173 - will add synthetic fields to the class,
11.3174 - which will unfortunately change the implicit
11.3175 - serialVersionUID (e.g., adding a reference to <code>String.class</code>
11.3176 - will generate a static field <code>class$java$lang$String</code>).
11.3177 - Also, different source code to bytecode compilers may use different
11.3178 - naming conventions for synthetic variables generated for
11.3179 - references to class objects or inner classes.
11.3180 - To ensure interoperability of Serializable across versions,
11.3181 - consider adding an explicit serialVersionUID.</p>
11.3182 -]]>
11.3183 - </Details>
11.3184 - </BugPattern>
11.3185 - <BugPattern type="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE">
11.3186 - <ShortDescription>Comparator doesn't implement Serializable</ShortDescription>
11.3187 - <LongDescription>{0} implements Comparator but not Serializable</LongDescription>
11.3188 - <Details>
11.3189 -<![CDATA[
11.3190 - <p> This class implements the <code>Comparator</code> interface. You
11.3191 -should consider whether or not it should also implement the <code>Serializable</code>
11.3192 -interface. If a comparator is used to construct an ordered collection
11.3193 -such as a <code>TreeMap</code>, then the <code>TreeMap</code>
11.3194 -will be serializable only if the comparator is also serializable.
11.3195 -As most comparators have little or no state, making them serializable
11.3196 -is generally easy and good defensive programming.
11.3197 -</p>
11.3198 -]]>
11.3199 - </Details>
11.3200 - </BugPattern>
11.3201 -
11.3202 - <BugPattern type="SF_SWITCH_FALLTHROUGH">
11.3203 - <ShortDescription>Switch statement found where one case falls through to the next case</ShortDescription>
11.3204 - <LongDescription>Switch statement found in {1} where one case falls through to the next case</LongDescription>
11.3205 - <Details>
11.3206 -<![CDATA[
11.3207 - <p> This method contains a switch statement where one case branch will fall through to the next case.
11.3208 - Usually you need to end this case with a break or return.</p>
11.3209 -]]>
11.3210 - </Details>
11.3211 - </BugPattern>
11.3212 - <BugPattern type="SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH">
11.3213 - <ShortDescription>Dead store due to switch statement fall through</ShortDescription>
11.3214 - <LongDescription>Value of {2} from previous case is overwritten here due to switch statement fall through</LongDescription>
11.3215 - <Details>
11.3216 -<![CDATA[
11.3217 - <p> A value stored in the previous switch case is overwritten here due to a switch fall through. It is likely that
11.3218 - you forgot to put a break or return at the end of the previous case.
11.3219 -</p>
11.3220 -]]>
11.3221 - </Details>
11.3222 - </BugPattern>
11.3223 -
11.3224 - <BugPattern type="WS_WRITEOBJECT_SYNC">
11.3225 - <ShortDescription>Class's writeObject() method is synchronized but nothing else is</ShortDescription>
11.3226 - <LongDescription>{0}'s writeObject method is synchronized but nothing else is</LongDescription>
11.3227 - <Details>
11.3228 -<![CDATA[
11.3229 - <p> This class has a <code>writeObject()</code> method which is synchronized;
11.3230 - however, no other method of the class is synchronized.</p>
11.3231 -]]>
11.3232 - </Details>
11.3233 - </BugPattern>
11.3234 - <BugPattern type="RS_READOBJECT_SYNC">
11.3235 - <ShortDescription>Class's readObject() method is synchronized</ShortDescription>
11.3236 - <LongDescription>{0}'s readObject method is synchronized</LongDescription>
11.3237 - <Details>
11.3238 -<![CDATA[
11.3239 - <p> This serializable class defines a <code>readObject()</code> which is
11.3240 - synchronized. By definition, an object created by deserialization
11.3241 - is only reachable by one thread, and thus there is no need for
11.3242 - <code>readObject()</code> to be synchronized. If the <code>readObject()</code>
11.3243 - method itself is causing the object to become visible to another thread,
11.3244 - that is an example of very dubious coding style.</p>
11.3245 -]]>
11.3246 - </Details>
11.3247 - </BugPattern>
11.3248 -
11.3249 - <BugPattern type="SE_NONSTATIC_SERIALVERSIONID">
11.3250 - <ShortDescription>serialVersionUID isn't static</ShortDescription>
11.3251 - <LongDescription>{1} isn't static</LongDescription>
11.3252 - <Details>
11.3253 -<![CDATA[
11.3254 - <p> This class defines a <code>serialVersionUID</code> field that is not static.
11.3255 - The field should be made static
11.3256 - if it is intended to specify
11.3257 - the version UID for purposes of serialization.</p>
11.3258 -]]>
11.3259 - </Details>
11.3260 - </BugPattern>
11.3261 -
11.3262 - <BugPattern type="SE_NONFINAL_SERIALVERSIONID">
11.3263 - <ShortDescription>serialVersionUID isn't final</ShortDescription>
11.3264 - <LongDescription>{1} isn't final</LongDescription>
11.3265 - <Details>
11.3266 -<![CDATA[
11.3267 - <p> This class defines a <code>serialVersionUID</code> field that is not final.
11.3268 - The field should be made final
11.3269 - if it is intended to specify
11.3270 - the version UID for purposes of serialization.</p>
11.3271 -]]>
11.3272 - </Details>
11.3273 - </BugPattern>
11.3274 -
11.3275 -
11.3276 - <BugPattern type="SE_NONLONG_SERIALVERSIONID">
11.3277 - <ShortDescription>serialVersionUID isn't long</ShortDescription>
11.3278 - <LongDescription>{1} isn't long</LongDescription>
11.3279 - <Details>
11.3280 -<![CDATA[
11.3281 - <p> This class defines a <code>serialVersionUID</code> field that is not long.
11.3282 - The field should be made long
11.3283 - if it is intended to specify
11.3284 - the version UID for purposes of serialization.</p>
11.3285 -]]>
11.3286 - </Details>
11.3287 - </BugPattern>
11.3288 -
11.3289 - <BugPattern type="SE_BAD_FIELD">
11.3290 - <ShortDescription>Non-transient non-serializable instance field in serializable class</ShortDescription>
11.3291 - <LongDescription>Class {0} defines non-transient non-serializable instance field {1.name}</LongDescription>
11.3292 - <Details>
11.3293 -<![CDATA[
11.3294 -<p> This Serializable class defines a non-primitive instance field which is neither transient,
11.3295 -Serializable, or <code>java.lang.Object</code>, and does not appear to implement
11.3296 -the <code>Externalizable</code> interface or the
11.3297 -<code>readObject()</code> and <code>writeObject()</code> methods.
11.3298 -Objects of this class will not be deserialized correctly if a non-Serializable
11.3299 -object is stored in this field.</p>
11.3300 -]]>
11.3301 - </Details>
11.3302 - </BugPattern>
11.3303 -
11.3304 - <BugPattern type="SE_BAD_FIELD_INNER_CLASS">
11.3305 - <ShortDescription>Non-serializable class has a serializable inner class</ShortDescription>
11.3306 - <LongDescription>{0} is serializable but also an inner class of a non-serializable class</LongDescription>
11.3307 - <Details>
11.3308 -<![CDATA[
11.3309 -<p> This Serializable class is an inner class of a non-serializable class.
11.3310 -Thus, attempts to serialize it will also attempt to associate instance of the outer
11.3311 -class with which it is associated, leading to a runtime error.
11.3312 -</p>
11.3313 -<p>If possible, making the inner class a static inner class should solve the
11.3314 -problem. Making the outer class serializable might also work, but that would
11.3315 -mean serializing an instance of the inner class would always also serialize the instance
11.3316 -of the outer class, which it often not what you really want.
11.3317 -]]>
11.3318 - </Details>
11.3319 - </BugPattern>
11.3320 - <BugPattern type="SE_INNER_CLASS">
11.3321 - <ShortDescription>Serializable inner class</ShortDescription>
11.3322 - <LongDescription>{0} is serializable and an inner class</LongDescription>
11.3323 - <Details>
11.3324 -<![CDATA[
11.3325 -<p> This Serializable class is an inner class. Any attempt to serialize
11.3326 -it will also serialize the associated outer instance. The outer instance is serializable,
11.3327 -so this won't fail, but it might serialize a lot more data than intended.
11.3328 -If possible, making the inner class a static inner class (also known as a nested class) should solve the
11.3329 -problem.
11.3330 -]]>
11.3331 - </Details>
11.3332 - </BugPattern>
11.3333 -
11.3334 - <BugPattern type="SE_BAD_FIELD_STORE">
11.3335 - <ShortDescription>Non-serializable value stored into instance field of a serializable class</ShortDescription>
11.3336 - <LongDescription>{2} stored into non-transient field {1.givenClass}</LongDescription>
11.3337 - <Details>
11.3338 -<![CDATA[
11.3339 -<p> A non-serializable value is stored into a non-transient field
11.3340 -of a serializable class.</p>
11.3341 -]]>
11.3342 - </Details>
11.3343 - </BugPattern>
11.3344 -
11.3345 - <BugPattern type="SC_START_IN_CTOR">
11.3346 - <ShortDescription>Constructor invokes Thread.start()</ShortDescription>
11.3347 - <LongDescription>{1} invokes {2}</LongDescription>
11.3348 - <Details>
11.3349 -<![CDATA[
11.3350 - <p> The constructor starts a thread. This is likely to be wrong if
11.3351 - the class is ever extended/subclassed, since the thread will be started
11.3352 - before the subclass constructor is started.</p>
11.3353 -]]>
11.3354 - </Details>
11.3355 - </BugPattern>
11.3356 - <BugPattern type="SS_SHOULD_BE_STATIC">
11.3357 - <ShortDescription>Unread field: should this field be static?</ShortDescription>
11.3358 - <LongDescription>Unread field: {1}; should this field be static?</LongDescription>
11.3359 - <Details>
11.3360 -<![CDATA[
11.3361 - <p> This class contains an instance final field that
11.3362 - is initialized to a compile-time static value.
11.3363 - Consider making the field static.</p>
11.3364 -]]>
11.3365 - </Details>
11.3366 - </BugPattern>
11.3367 - <BugPattern type="UUF_UNUSED_FIELD">
11.3368 - <ShortDescription>Unused field</ShortDescription>
11.3369 - <LongDescription>Unused field: {1}</LongDescription>
11.3370 - <Details>
11.3371 -<![CDATA[
11.3372 - <p> This field is never used. Consider removing it from the class.</p>
11.3373 -]]>
11.3374 - </Details>
11.3375 - </BugPattern>
11.3376 - <BugPattern type="URF_UNREAD_FIELD">
11.3377 - <ShortDescription>Unread field</ShortDescription>
11.3378 - <LongDescription>Unread field: {1}</LongDescription>
11.3379 - <Details>
11.3380 -<![CDATA[
11.3381 - <p> This field is never read. Consider removing it from the class.</p>
11.3382 -]]>
11.3383 - </Details>
11.3384 - </BugPattern>
11.3385 -
11.3386 - <BugPattern type="QF_QUESTIONABLE_FOR_LOOP">
11.3387 - <ShortDescription>Complicated, subtle or wrong increment in for-loop </ShortDescription>
11.3388 - <LongDescription>Complicated, subtle or wrong increment in for-loop {1} </LongDescription>
11.3389 - <Details>
11.3390 -<![CDATA[
11.3391 - <p>Are you sure this for loop is incrementing the correct variable?
11.3392 - It appears that another variable is being initialized and checked
11.3393 - by the for loop.
11.3394 -</p>
11.3395 -]]>
11.3396 - </Details>
11.3397 - </BugPattern>
11.3398 - <BugPattern type="UWF_NULL_FIELD">
11.3399 - <ShortDescription>Field only ever set to null</ShortDescription>
11.3400 - <LongDescription>Field only ever set to null: {1}</LongDescription>
11.3401 - <Details>
11.3402 -<![CDATA[
11.3403 - <p> All writes to this field are of the constant value null, and thus
11.3404 -all reads of the field will return null.
11.3405 -Check for errors, or remove it if it is useless.</p>
11.3406 -]]>
11.3407 - </Details>
11.3408 - </BugPattern>
11.3409 - <BugPattern type="UWF_UNWRITTEN_FIELD">
11.3410 - <ShortDescription>Unwritten field</ShortDescription>
11.3411 - <LongDescription>Unwritten field: {1}</LongDescription>
11.3412 - <Details>
11.3413 -<![CDATA[
11.3414 - <p> This field is never written. All reads of it will return the default
11.3415 -value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>
11.3416 -]]>
11.3417 - </Details>
11.3418 - </BugPattern>
11.3419 -
11.3420 -
11.3421 - <BugPattern type="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD">
11.3422 - <ShortDescription>Write to static field from instance method</ShortDescription>
11.3423 - <LongDescription>Write to static field {2} from instance method {1}</LongDescription>
11.3424 - <Details>
11.3425 -<![CDATA[
11.3426 - <p> This instance method writes to a static field. This is tricky to get
11.3427 -correct if multiple instances are being manipulated,
11.3428 -and generally bad practice.
11.3429 -</p>
11.3430 -]]>
11.3431 - </Details>
11.3432 - </BugPattern>
11.3433 -
11.3434 - <BugPattern type="NP_LOAD_OF_KNOWN_NULL_VALUE">
11.3435 - <ShortDescription>Load of known null value</ShortDescription>
11.3436 - <LongDescription>Load of known null value in {1}</LongDescription>
11.3437 - <Details>
11.3438 -<![CDATA[
11.3439 - <p> The variable referenced at this point is known to be null due to an earlier
11.3440 - check against null. Although this is valid, it might be a mistake (perhaps you
11.3441 -intended to refer to a different variable, or perhaps the earlier check to see if the
11.3442 -variable is null should have been a check to see if it was nonnull.
11.3443 -</p>
11.3444 -]]>
11.3445 - </Details>
11.3446 - </BugPattern>
11.3447 -
11.3448 - <BugPattern type="NP_IMMEDIATE_DEREFERENCE_OF_READLINE">
11.3449 - <ShortDescription>Immediate dereference of the result of readLine()</ShortDescription>
11.3450 - <LongDescription>Immediate dereference of the result of readLine() in {1}</LongDescription>
11.3451 - <Details>
11.3452 -<![CDATA[
11.3453 - <p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text
11.3454 -to read, readLine() will return null and dereferencing that will generate a null pointer exception.
11.3455 -</p>
11.3456 -]]>
11.3457 - </Details>
11.3458 - </BugPattern>
11.3459 -
11.3460 - <BugPattern type="NP_UNWRITTEN_FIELD">
11.3461 - <ShortDescription>Read of unwritten field</ShortDescription>
11.3462 - <LongDescription>Read of unwritten field {2.name} in {1}</LongDescription>
11.3463 - <Details>
11.3464 -<![CDATA[
11.3465 - <p> The program is dereferencing a field that does not seem to ever have a non-null value written to it.
11.3466 -Dereferencing this value will generate a null pointer exception.
11.3467 -</p>
11.3468 -]]>
11.3469 - </Details>
11.3470 - </BugPattern>
11.3471 -
11.3472 - <BugPattern type="SIC_INNER_SHOULD_BE_STATIC">
11.3473 - <ShortDescription>Should be a static inner class</ShortDescription>
11.3474 - <LongDescription>Should {0} be a _static_ inner class?</LongDescription>
11.3475 - <Details>
11.3476 -<![CDATA[
11.3477 - <p> This class is an inner class, but does not use its embedded reference
11.3478 - to the object which created it. This reference makes the instances
11.3479 - of the class larger, and may keep the reference to the creator object
11.3480 - alive longer than necessary. If possible, the class should be
11.3481 - made static.
11.3482 -</p>
11.3483 -]]>
11.3484 - </Details>
11.3485 - </BugPattern>
11.3486 -
11.3487 -
11.3488 -
11.3489 - <BugPattern type="NP_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" deprecated="true"> <!-- deprecated in favor of UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR -->
11.3490 - <ShortDescription>Read of field not initialized in constructor</ShortDescription>
11.3491 - <LongDescription>Read of field not initialized in constructor at {1}</LongDescription>
11.3492 - <Details>
11.3493 -<![CDATA[
11.3494 - <p> This is a read of a field is never initialized within any constructor, and is therefore could be null after
11.3495 -the object is initialized. This might be a coding error, or else the class containing the field
11.3496 -is written in a way that depends upon methods being called in some specific order (a little bit dodgy,
11.3497 -but not necessarily wrong).
11.3498 -</p>
11.3499 -]]>
11.3500 - </Details>
11.3501 - </BugPattern>
11.3502 - <BugPattern type="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR">
11.3503 - <ShortDescription>Field not initialized in constructor</ShortDescription>
11.3504 - <LongDescription>{1.givenClass} not initialized in constructor</LongDescription>
11.3505 - <Details>
11.3506 -<![CDATA[
11.3507 - <p> This field is never initialized within any constructor, and is therefore could be null after
11.3508 -the object is constructed.
11.3509 -This could be a either an error or a questionable design, since
11.3510 -it means a null pointer exception will be generated if that field is dereferenced
11.3511 -before being initialized.
11.3512 -</p>
11.3513 -]]>
11.3514 - </Details>
11.3515 - </BugPattern>
11.3516 -
11.3517 - <BugPattern type="SIC_INNER_SHOULD_BE_STATIC_ANON">
11.3518 - <ShortDescription>Could be refactored into a named static inner class</ShortDescription>
11.3519 - <LongDescription>The class {0} could be refactored into a named _static_ inner class</LongDescription>
11.3520 - <Details>
11.3521 -<![CDATA[
11.3522 - <p> This class is an inner class, but does not use its embedded reference
11.3523 - to the object which created it. This reference makes the instances
11.3524 - of the class larger, and may keep the reference to the creator object
11.3525 - alive longer than necessary. If possible, the class should be
11.3526 - made into a <em>static</em> inner class. Since anonymous inner
11.3527 -classes cannot be marked as static, doing this will requiring refactoring
11.3528 -the inner class so that it is a named inner class.</p>
11.3529 -]]>
11.3530 - </Details>
11.3531 - </BugPattern>
11.3532 - <BugPattern type="SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS">
11.3533 - <ShortDescription>Could be refactored into a static inner class</ShortDescription>
11.3534 - <LongDescription>The class {0} could be refactored into a _static_ inner class</LongDescription>
11.3535 - <Details>
11.3536 -<![CDATA[
11.3537 - <p> This class is an inner class, but does not use its embedded reference
11.3538 - to the object which created it except during construction of the
11.3539 -inner object. This reference makes the instances
11.3540 - of the class larger, and may keep the reference to the creator object
11.3541 - alive longer than necessary. If possible, the class should be
11.3542 - made into a <em>static</em> inner class. Since the reference to the
11.3543 - outer object is required during construction of the inner instance,
11.3544 - the inner class will need to be refactored so as to
11.3545 - pass a reference to the outer instance to the constructor
11.3546 - for the inner class.</p>
11.3547 -]]>
11.3548 - </Details>
11.3549 - </BugPattern>
11.3550 -
11.3551 - <BugPattern type="WA_NOT_IN_LOOP">
11.3552 - <ShortDescription>Wait not in loop </ShortDescription>
11.3553 - <LongDescription>Wait not in loop in {1}</LongDescription>
11.3554 - <Details>
11.3555 -<![CDATA[
11.3556 - <p> This method contains a call to <code>java.lang.Object.wait()</code>
11.3557 - which is not in a loop. If the monitor is used for multiple conditions,
11.3558 - the condition the caller intended to wait for might not be the one
11.3559 - that actually occurred.</p>
11.3560 -]]>
11.3561 - </Details>
11.3562 - </BugPattern>
11.3563 -
11.3564 - <BugPattern type="WA_AWAIT_NOT_IN_LOOP">
11.3565 - <ShortDescription>Condition.await() not in loop </ShortDescription>
11.3566 - <LongDescription>Condition.await() not in loop in {1}</LongDescription>
11.3567 - <Details>
11.3568 -<![CDATA[
11.3569 - <p> This method contains a call to <code>java.util.concurrent.await()</code>
11.3570 - (or variants)
11.3571 - which is not in a loop. If the object is used for multiple conditions,
11.3572 - the condition the caller intended to wait for might not be the one
11.3573 - that actually occurred.</p>
11.3574 -]]>
11.3575 - </Details>
11.3576 - </BugPattern>
11.3577 -
11.3578 - <BugPattern type="NO_NOTIFY_NOT_NOTIFYALL">
11.3579 - <ShortDescription>Using notify() rather than notifyAll()</ShortDescription>
11.3580 - <LongDescription>Using notify rather than notifyAll in {1}</LongDescription>
11.3581 - <Details>
11.3582 -<![CDATA[
11.3583 - <p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>.
11.3584 - Java monitors are often used for multiple conditions. Calling <code>notify()</code>
11.3585 - only wakes up one thread, meaning that the thread woken up might not be the
11.3586 - one waiting for the condition that the caller just satisfied.</p>
11.3587 -]]>
11.3588 - </Details>
11.3589 - </BugPattern>
11.3590 -
11.3591 - <BugPattern type="RV_CHECK_FOR_POSITIVE_INDEXOF">
11.3592 - <ShortDescription>Method checks to see if result of String.indexOf is positive</ShortDescription>
11.3593 - <LongDescription>{1} checks to see if result of String.indexOf is positive</LongDescription>
11.3594 - <Details>
11.3595 -<![CDATA[
11.3596 - <p> The method invokes String.indexOf and checks to see if the result is positive or non-positive.
11.3597 - It is much more typical to check to see if the result is negative or non-negative. It is
11.3598 - positive only if the substring checked for occurs at some place other than at the beginning of
11.3599 - the String.</p>
11.3600 -]]>
11.3601 - </Details>
11.3602 - </BugPattern>
11.3603 -
11.3604 - <BugPattern type="RV_DONT_JUST_NULL_CHECK_READLINE">
11.3605 - <ShortDescription>Method discards result of readLine after checking if it is nonnull</ShortDescription>
11.3606 - <LongDescription>{1} discards result of readLine after checking if it is nonnull</LongDescription>
11.3607 - <Details>
11.3608 -<![CDATA[
11.3609 - <p> The value returned by readLine is discarded after checking to see if the return
11.3610 -value is non-null. In almost all situations, if the result is non-null, you will want
11.3611 -to use that non-null value. Calling readLine again will give you a different line.</p>
11.3612 -]]>
11.3613 - </Details>
11.3614 - </BugPattern>
11.3615 -
11.3616 -
11.3617 - <BugPattern type="RV_RETURN_VALUE_IGNORED">
11.3618 - <ShortDescription>Method ignores return value</ShortDescription>
11.3619 - <LongDescription>{1} ignores return value of {2}</LongDescription>
11.3620 - <Details>
11.3621 -<![CDATA[
11.3622 - <p> The return value of this method should be checked. One common
11.3623 -cause of this warning is to invoke a method on an immutable object,
11.3624 -thinking that it updates the object. For example, in the following code
11.3625 -fragment,</p>
11.3626 -<blockquote>
11.3627 -<pre>
11.3628 -String dateString = getHeaderField(name);
11.3629 -dateString.trim();
11.3630 -</pre>
11.3631 -</blockquote>
11.3632 -<p>the programmer seems to be thinking that the trim() method will update
11.3633 -the String referenced by dateString. But since Strings are immutable, the trim()
11.3634 -function returns a new String value, which is being ignored here. The code
11.3635 -should be corrected to: </p>
11.3636 -<blockquote>
11.3637 -<pre>
11.3638 -String dateString = getHeaderField(name);
11.3639 -dateString = dateString.trim();
11.3640 -</pre>
11.3641 -</blockquote>
11.3642 -]]>
11.3643 - </Details>
11.3644 - </BugPattern>
11.3645 - <BugPattern type="RV_RETURN_VALUE_IGNORED2">
11.3646 - <ShortDescription>Method ignores return value</ShortDescription>
11.3647 - <LongDescription>{1} ignores return value of {2}</LongDescription>
11.3648 - <Details>
11.3649 -<![CDATA[
11.3650 - <p> The return value of this method should be checked. One common
11.3651 -cause of this warning is to invoke a method on an immutable object,
11.3652 -thinking that it updates the object. For example, in the following code
11.3653 -fragment,</p>
11.3654 -<blockquote>
11.3655 -<pre>
11.3656 -String dateString = getHeaderField(name);
11.3657 -dateString.trim();
11.3658 -</pre>
11.3659 -</blockquote>
11.3660 -<p>the programmer seems to be thinking that the trim() method will update
11.3661 -the String referenced by dateString. But since Strings are immutable, the trim()
11.3662 -function returns a new String value, which is being ignored here. The code
11.3663 -should be corrected to: </p>
11.3664 -<blockquote>
11.3665 -<pre>
11.3666 -String dateString = getHeaderField(name);
11.3667 -dateString = dateString.trim();
11.3668 -</pre>
11.3669 -</blockquote>
11.3670 -]]>
11.3671 - </Details>
11.3672 - </BugPattern>
11.3673 -
11.3674 - <BugPattern type="NP_ALWAYS_NULL">
11.3675 - <ShortDescription>Null pointer dereference</ShortDescription>
11.3676 - <LongDescription>Null pointer dereference of {2.givenClass} in {1}</LongDescription>
11.3677 - <Details>
11.3678 -<![CDATA[
11.3679 -<p> A null pointer is dereferenced here. This will lead to a
11.3680 -<code>NullPointerException</code> when the code is executed.</p>
11.3681 -]]>
11.3682 - </Details>
11.3683 - </BugPattern>
11.3684 - <BugPattern type="NP_STORE_INTO_NONNULL_FIELD">
11.3685 - <ShortDescription>Store of null value into field annotated NonNull</ShortDescription>
11.3686 - <LongDescription>Store of null value into field {2.givenClass} annotated NonNull at {1}</LongDescription>
11.3687 - <Details>
11.3688 - <![CDATA[
11.3689 -<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>
11.3690 -]]>
11.3691 - </Details>
11.3692 - </BugPattern>
11.3693 - <BugPattern type="NP_ALWAYS_NULL_EXCEPTION">
11.3694 - <ShortDescription>Null pointer dereference in method on exception path</ShortDescription>
11.3695 - <LongDescription>Null pointer dereference of {2.givenClass} in {1} on exception path</LongDescription>
11.3696 - <Details>
11.3697 -<![CDATA[
11.3698 -<p> A pointer which is null on an exception path is dereferenced here.
11.3699 -This will lead to a <code>NullPointerException</code> when the code is executed.
11.3700 -Note that because FindBugs currently does not prune infeasible exception paths,
11.3701 -this may be a false warning.</p>
11.3702 -
11.3703 -<p> Also note that FindBugs considers the default case of a switch statement to
11.3704 -be an exception path, since the default case is often infeasible.</p>
11.3705 -]]>
11.3706 - </Details>
11.3707 - </BugPattern>
11.3708 -
11.3709 - <BugPattern type="NP_NULL_ON_SOME_PATH">
11.3710 - <ShortDescription>Possible null pointer dereference</ShortDescription>
11.3711 - <LongDescription>Possible null pointer dereference of {2.givenClass} in {1}</LongDescription>
11.3712 - <Details>
11.3713 -<![CDATA[
11.3714 -<p> A reference value dereferenced here might be null at runtime.
11.3715 -This may lead to a <code>NullPointerException</code> when the code is executed.</p>
11.3716 -]]>
11.3717 - </Details>
11.3718 - </BugPattern>
11.3719 -
11.3720 - <BugPattern type="NP_NULL_ON_SOME_PATH_EXCEPTION">
11.3721 - <ShortDescription>Possible null pointer dereference in method on exception path</ShortDescription>
11.3722 - <LongDescription>Possible null pointer dereference of {2.givenClass} in {1} on exception path</LongDescription>
11.3723 - <Details>
11.3724 -<![CDATA[
11.3725 -<p> A reference value which is null on some exception control path is
11.3726 -dereferenced here. This may lead to a <code>NullPointerException</code>
11.3727 -when the code is executed.
11.3728 -Note that because FindBugs currently does not prune infeasible exception paths,
11.3729 -this may be a false warning.</p>
11.3730 -
11.3731 -<p> Also note that FindBugs considers the default case of a switch statement to
11.3732 -be an exception path, since the default case is often infeasible.</p>
11.3733 -]]>
11.3734 - </Details>
11.3735 - </BugPattern>
11.3736 -
11.3737 - <BugPattern type="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE">
11.3738 - <ShortDescription>Possible null pointer dereference due to return value of called method</ShortDescription>
11.3739 - <LongDescription>Possible null pointer dereference in {1} due to return value of called method</LongDescription>
11.3740 - <Details>
11.3741 - <![CDATA[
11.3742 -<p> A reference value which is null on some exception control path is
11.3743 -dereferenced here. This may lead to a <code>NullPointerException</code>
11.3744 -when the code is executed. The value may be null because it
11.3745 -was return from a method which is known to return possibly-null values.</p>
11.3746 - ]]>
11.3747 - </Details>
11.3748 - </BugPattern>
11.3749 -
11.3750 - <BugPattern type="NP_NULL_PARAM_DEREF_NONVIRTUAL">
11.3751 - <ShortDescription>Non-virtual method call passes null for unconditionally dereferenced parameter</ShortDescription>
11.3752 - <LongDescription>Non-virtual method call in {1} passes null for unconditionally dereferenced parameter of {2.givenClass}</LongDescription>
11.3753 - <Details>
11.3754 - <![CDATA[
11.3755 - <p>
11.3756 - A possibly-null value is passed to a method which unconditionally
11.3757 - dereferences it. This will almost certainly result in a null pointer exception.
11.3758 - </p>
11.3759 - ]]>
11.3760 - </Details>
11.3761 - </BugPattern>
11.3762 -
11.3763 - <BugPattern type="NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS">
11.3764 - <ShortDescription>Method call passes null for unconditionally dereferenced parameter</ShortDescription>
11.3765 - <LongDescription>Method call in {1} passes null for unconditionally dereferenced parameter of {2.givenClass}</LongDescription>
11.3766 - <Details>
11.3767 - <![CDATA[
11.3768 - <p>
11.3769 - A possibly-null value is passed at a call site where all known
11.3770 - target methods will unconditionally dereference it.
11.3771 - This is very likely to result in a null pointer exception.
11.3772 - </p>
11.3773 - ]]>
11.3774 - </Details>
11.3775 - </BugPattern>
11.3776 -
11.3777 - <BugPattern type="NP_NULL_PARAM_DEREF">
11.3778 - <ShortDescription>Method call passes null for unconditionally dereferenced parameter</ShortDescription>
11.3779 - <LongDescription>Method call in {1} passes null for unconditionally dereferenced parameter of {2.givenClass}</LongDescription>
11.3780 - <Details>
11.3781 - <![CDATA[
11.3782 - <p>
11.3783 - This method call passes a null value to a method which might
11.3784 - dereference it unconditionally.
11.3785 - </p>
11.3786 - ]]>
11.3787 - </Details>
11.3788 - </BugPattern>
11.3789 -
11.3790 - <BugPattern type="NP_NONNULL_PARAM_VIOLATION">
11.3791 - <ShortDescription>Method call passes null to a nonnull parameter </ShortDescription>
11.3792 - <LongDescription>Method call in {1} passes null to a nonnull parameter of {2.givenClass}</LongDescription>
11.3793 - <Details>
11.3794 - <![CDATA[
11.3795 - <p>
11.3796 - This method passes a null value as the parameter of a method which
11.3797 - must be nonnull. Either this parameter has been explicitly marked
11.3798 - as @Nonnull, or analysis has determined that this parameter is
11.3799 - always deferenced.
11.3800 - </p>
11.3801 - ]]>
11.3802 - </Details>
11.3803 - </BugPattern>
11.3804 -
11.3805 - <BugPattern type="NP_NONNULL_RETURN_VIOLATION">
11.3806 - <ShortDescription>Method may return null, but is declared @NonNull</ShortDescription>
11.3807 - <LongDescription>Method {1} may return null, but is declared @NonNull</LongDescription>
11.3808 - <Details>
11.3809 - <![CDATA[
11.3810 - <p>
11.3811 - This method may return a null value, but the method (or a superclass method
11.3812 - which it overrides) is declared to return @NonNull.
11.3813 - </p>
11.3814 - ]]>
11.3815 - </Details>
11.3816 - </BugPattern>
11.3817 - <BugPattern type="NP_CLONE_COULD_RETURN_NULL">
11.3818 - <ShortDescription>Clone method may return null</ShortDescription>
11.3819 - <LongDescription>{1} may return null</LongDescription>
11.3820 - <Details>
11.3821 - <![CDATA[
11.3822 - <p>
11.3823 - This clone method seems to return null in some circumstances, but clone is never
11.3824 - allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError
11.3825 - instead.
11.3826 - </p>
11.3827 - ]]>
11.3828 - </Details>
11.3829 - </BugPattern>
11.3830 - <BugPattern type="NP_TOSTRING_COULD_RETURN_NULL">
11.3831 - <ShortDescription>toString method may return null</ShortDescription>
11.3832 - <LongDescription>{1} may return null</LongDescription>
11.3833 - <Details>
11.3834 - <![CDATA[
11.3835 - <p>
11.3836 - This toString method seems to return null in some circumstances. A liberal reading of the
11.3837 - spec could be interpreted as allowing this, but it is probably a bad idea and could cause
11.3838 - other code to break. Return the empty string or some other appropriate string rather than null.
11.3839 - </p>
11.3840 - ]]>
11.3841 - </Details>
11.3842 - </BugPattern>
11.3843 -
11.3844 -
11.3845 - <BugPattern type="NP_GUARANTEED_DEREF">
11.3846 - <ShortDescription>Null value is guaranteed to be dereferenced</ShortDescription>
11.3847 - <LongDescription>{2.givenClass} could be null and is guaranteed to be dereferenced in {1}</LongDescription>
11.3848 - <Details>
11.3849 - <![CDATA[
11.3850 - <p>
11.3851 - There is a statement or branch that if executed guarantees that
11.3852 - a value is null at this point, and that
11.3853 - value that is guaranteed to be dereferenced
11.3854 - (except on forward paths involving runtime exceptions).
11.3855 - </p>
11.3856 - ]]>
11.3857 - </Details>
11.3858 - </BugPattern>
11.3859 -
11.3860 - <BugPattern type="NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH">
11.3861 - <ShortDescription>Value is null and guaranteed to be dereferenced on exception path</ShortDescription>
11.3862 - <LongDescription>{2.name} is null guaranteed to be dereferenced in {1} on exception path</LongDescription>
11.3863 - <Details>
11.3864 - <![CDATA[
11.3865 - <p>
11.3866 - There is a statement or branch on an exception path
11.3867 - that if executed guarantees that
11.3868 - a value is null at this point, and that
11.3869 - value that is guaranteed to be dereferenced
11.3870 - (except on forward paths involving runtime exceptions).
11.3871 - </p>
11.3872 - ]]>
11.3873 - </Details>
11.3874 - </BugPattern>
11.3875 -
11.3876 - <BugPattern type="SI_INSTANCE_BEFORE_FINALS_ASSIGNED">
11.3877 - <ShortDescription>Static initializer creates instance before all static final fields assigned</ShortDescription>
11.3878 - <LongDescription>Static initializer for {0} creates instance before all static final fields assigned</LongDescription>
11.3879 - <Details>
11.3880 -<![CDATA[
11.3881 -<p> The class's static initializer creates an instance of the class
11.3882 -before all of the static final fields are assigned.</p>
11.3883 -]]>
11.3884 - </Details>
11.3885 - </BugPattern>
11.3886 -
11.3887 - <BugPattern type="OS_OPEN_STREAM">
11.3888 - <ShortDescription>Method may fail to close stream</ShortDescription>
11.3889 - <LongDescription>{1} may fail to close stream</LongDescription>
11.3890 - <Details>
11.3891 -<![CDATA[
11.3892 -<p> The method creates an IO stream object, does not assign it to any
11.3893 -fields, pass it to other methods that might close it,
11.3894 -or return it, and does not appear to close
11.3895 -the stream on all paths out of the method. This may result in
11.3896 -a file descriptor leak. It is generally a good
11.3897 -idea to use a <code>finally</code> block to ensure that streams are
11.3898 -closed.</p>
11.3899 -]]>
11.3900 - </Details>
11.3901 - </BugPattern>
11.3902 -
11.3903 - <BugPattern type="OS_OPEN_STREAM_EXCEPTION_PATH">
11.3904 - <ShortDescription>Method may fail to close stream on exception</ShortDescription>
11.3905 - <LongDescription>{1} may fail to close stream on exception</LongDescription>
11.3906 - <Details>
11.3907 -<![CDATA[
11.3908 -<p> The method creates an IO stream object, does not assign it to any
11.3909 -fields, pass it to other methods, or return it, and does not appear to close
11.3910 -it on all possible exception paths out of the method.
11.3911 -This may result in a file descriptor leak. It is generally a good
11.3912 -idea to use a <code>finally</code> block to ensure that streams are
11.3913 -closed.</p>
11.3914 -]]>
11.3915 - </Details>
11.3916 - </BugPattern>
11.3917 -
11.3918 - <BugPattern type="PZLA_PREFER_ZERO_LENGTH_ARRAYS">
11.3919 - <ShortDescription>Consider returning a zero length array rather than null</ShortDescription>
11.3920 - <LongDescription>Should {1} return a zero length array rather than null?</LongDescription>
11.3921 - <Details>
11.3922 -<![CDATA[
11.3923 -<p> It is often a better design to
11.3924 -return a length zero array rather than a null reference to indicate that there
11.3925 -are no results (i.e., an empty list of results).
11.3926 -This way, no explicit check for null is needed by clients of the method.</p>
11.3927 -
11.3928 -<p>On the other hand, using null to indicate
11.3929 -"there is no answer to this question", then it is probably appropriate.
11.3930 -For example, <code>File.listFiles()</code> returns an empty list
11.3931 -if given a directory containing no files, and returns null if the file
11.3932 -is not a directory.</p>
11.3933 -]]>
11.3934 - </Details>
11.3935 - </BugPattern>
11.3936 -
11.3937 - <BugPattern type="UCF_USELESS_CONTROL_FLOW">
11.3938 - <ShortDescription>Useless control flow</ShortDescription>
11.3939 - <LongDescription>Useless control flow in {1}</LongDescription>
11.3940 - <Details>
11.3941 -<![CDATA[
11.3942 -<p> This method contains a useless control flow statement, where
11.3943 -control flow continues onto the same place regardless of whether or not
11.3944 -the branch is taken. For example,
11.3945 -this is caused by having an empty statement
11.3946 -block fot an <code>if</code> statement:</p>
11.3947 -<pre>
11.3948 - if (argv.length == 0) {
11.3949 - // TODO: handle this case
11.3950 - }
11.3951 -</pre>
11.3952 -]]>
11.3953 - </Details>
11.3954 - </BugPattern>
11.3955 - <BugPattern type="UCF_USELESS_CONTROL_FLOW_NEXT_LINE">
11.3956 - <ShortDescription>Useless control flow to next line</ShortDescription>
11.3957 - <LongDescription>Useless control flow to next line in {1}</LongDescription>
11.3958 - <Details>
11.3959 -<![CDATA[
11.3960 -<p> This method contains a useless control flow statement in which control
11.3961 -flow follows to the same or following line regardless of whether or not
11.3962 -the branch is taken.
11.3963 -Often, this is caused by inadvertently using an empty statement as the
11.3964 -body of an <code>if</code> statement, e.g.:</p>
11.3965 -<pre>
11.3966 - if (argv.length == 1);
11.3967 - System.out.println("Hello, " + argv[0]);
11.3968 -</pre>
11.3969 -]]>
11.3970 - </Details>
11.3971 - </BugPattern>
11.3972 -
11.3973 - <BugPattern type="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE">
11.3974 - <ShortDescription>Nullcheck of value previously dereferenced</ShortDescription>
11.3975 - <LongDescription>Nullcheck of {2.givenClass} at {4.lineNumber} of value previously dereferenced in {1}</LongDescription>
11.3976 - <Details>
11.3977 -<![CDATA[
11.3978 -<p> A value is checked here to see whether it is null, but this value can't
11.3979 -be null because it was previously dereferenced and if it were null a null pointer
11.3980 -exception would have occurred at the earlier dereference.
11.3981 -Essentially, this code and the previous dereference
11.3982 -disagree as to whether this value is allowed to be null. Either the check is redundant
11.3983 -or the previous dereference is erroneous.</p>
11.3984 -]]>
11.3985 - </Details>
11.3986 - </BugPattern>
11.3987 - <BugPattern type="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE">
11.3988 - <ShortDescription>Redundant nullcheck of value known to be null</ShortDescription>
11.3989 - <LongDescription>Redundant nullcheck of {2} which is known to be null in {1}</LongDescription>
11.3990 - <Details>
11.3991 -<![CDATA[
11.3992 -<p> This method contains a redundant check of a known null value against
11.3993 -the constant null.</p>
11.3994 -]]>
11.3995 - </Details>
11.3996 - </BugPattern>
11.3997 -
11.3998 -
11.3999 -
11.4000 - <BugPattern type="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE">
11.4001 - <ShortDescription>Redundant nullcheck of value known to be non-null</ShortDescription>
11.4002 - <LongDescription>Redundant nullcheck of {2}, which is known to be non-null in {1}</LongDescription>
11.4003 - <Details>
11.4004 -<![CDATA[
11.4005 -<p> This method contains a redundant check of a known non-null value against
11.4006 -the constant null.</p>
11.4007 -]]>
11.4008 - </Details>
11.4009 - </BugPattern>
11.4010 - <BugPattern type="RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES">
11.4011 - <ShortDescription>Redundant comparison of two null values</ShortDescription>
11.4012 - <LongDescription>Redundant comparison of two null values in {1}</LongDescription>
11.4013 - <Details>
11.4014 -<![CDATA[
11.4015 -<p> This method contains a redundant comparison of two references known to
11.4016 -both be definitely null.</p>
11.4017 -]]>
11.4018 - </Details>
11.4019 - </BugPattern>
11.4020 -
11.4021 -
11.4022 - <BugPattern type="RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE">
11.4023 - <ShortDescription>Redundant comparison of non-null value to null</ShortDescription>
11.4024 - <LongDescription>Redundant comparison of non-null value to null in {1}</LongDescription>
11.4025 - <Details>
11.4026 -<![CDATA[
11.4027 -<p> This method contains a reference known to be non-null with another reference
11.4028 -known to be null.</p>
11.4029 -]]>
11.4030 - </Details>
11.4031 - </BugPattern>
11.4032 -
11.4033 -
11.4034 -
11.4035 - <BugPattern type="RCN_REDUNDANT_CHECKED_NULL_COMPARISON" deprecated="true"> <!-- deprecated in favor of two separate RCN_ patterns -->
11.4036 - <ShortDescription>Redundant comparison to null of previously checked value</ShortDescription>
11.4037 - <LongDescription>Redundant comparison to null of previously checked {2} in {1}</LongDescription>
11.4038 - <Details>
11.4039 -<![CDATA[
11.4040 -<p> This method contains a redundant comparison of a reference value
11.4041 -to null. Two types of redundant comparison are reported:
11.4042 -</p>
11.4043 -<ul>
11.4044 -<li> Both values compared are definitely null</li>
11.4045 -<li> One value is definitely null and the other is definitely not null</li>
11.4046 -</ul>
11.4047 -
11.4048 -<p> This particular warning generally indicates that a
11.4049 -value known not to be null was checked against null.
11.4050 -While the check is not necessary, it may simply be a case
11.4051 -of defensive programming.</p>
11.4052 -]]>
11.4053 - </Details>
11.4054 - </BugPattern>
11.4055 -
11.4056 - <BugPattern type="UL_UNRELEASED_LOCK">
11.4057 - <ShortDescription>Method does not release lock on all paths</ShortDescription>
11.4058 - <LongDescription>{1} does not release lock on all paths</LongDescription>
11.4059 - <Details>
11.4060 -<![CDATA[
11.4061 -<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
11.4062 -but does not release it on all paths out of the method. In general, the correct idiom
11.4063 -for using a JSR-166 lock is:
11.4064 -</p>
11.4065 -<pre>
11.4066 - Lock l = ...;
11.4067 - l.lock();
11.4068 - try {
11.4069 - // do something
11.4070 - } finally {
11.4071 - l.unlock();
11.4072 - }
11.4073 -</pre>
11.4074 -]]>
11.4075 - </Details>
11.4076 - </BugPattern>
11.4077 -
11.4078 - <BugPattern type="UL_UNRELEASED_LOCK_EXCEPTION_PATH">
11.4079 - <ShortDescription>Method does not release lock on all exception paths</ShortDescription>
11.4080 - <LongDescription>{1} does not release lock on all exception paths</LongDescription>
11.4081 - <Details>
11.4082 -<![CDATA[
11.4083 -<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
11.4084 -but does not release it on all exception paths out of the method. In general, the correct idiom
11.4085 -for using a JSR-166 lock is:
11.4086 -</p>
11.4087 -<pre>
11.4088 - Lock l = ...;
11.4089 - l.lock();
11.4090 - try {
11.4091 - // do something
11.4092 - } finally {
11.4093 - l.unlock();
11.4094 - }
11.4095 -</pre>
11.4096 -]]>
11.4097 - </Details>
11.4098 - </BugPattern>
11.4099 -
11.4100 - <BugPattern type="RC_REF_COMPARISON">
11.4101 - <ShortDescription>Suspicious reference comparison</ShortDescription>
11.4102 - <LongDescription>Suspicious comparison of {2} references in {1}</LongDescription>
11.4103 - <Details>
11.4104 -<![CDATA[
11.4105 -<p> This method compares two reference values using the == or != operator,
11.4106 -where the correct way to compare instances of this type is generally
11.4107 -with the equals() method. Examples of classes which should generally
11.4108 -not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>
11.4109 -]]>
11.4110 - </Details>
11.4111 - </BugPattern>
11.4112 -
11.4113 - <BugPattern type="EC_UNRELATED_TYPES">
11.4114 - <ShortDescription>Call to equals() comparing different types</ShortDescription>
11.4115 - <LongDescription>Call to equals() comparing different types in {1}</LongDescription>
11.4116 - <Details>
11.4117 -<![CDATA[
11.4118 -<p> This method calls equals(Object) on two references of different
11.4119 -class types with no common subclasses.
11.4120 -Therefore, the objects being compared
11.4121 -are unlikely to be members of the same class at runtime
11.4122 -(unless some application classes were not analyzed, or dynamic class
11.4123 -loading can occur at runtime).
11.4124 -According to the contract of equals(),
11.4125 -objects of different
11.4126 -classes should always compare as unequal; therefore, according to the
11.4127 -contract defined by java.lang.Object.equals(Object),
11.4128 -the result of this comparison will always be false at runtime.
11.4129 -</p>
11.4130 -]]>
11.4131 - </Details>
11.4132 - </BugPattern>
11.4133 -
11.4134 - <BugPattern type="EC_UNRELATED_INTERFACES">
11.4135 - <ShortDescription>Call to equals() comparing different interface types</ShortDescription>
11.4136 - <LongDescription>Call to equals() comparing different interface types in {1}</LongDescription>
11.4137 - <Details>
11.4138 -<![CDATA[
11.4139 -<p> This method calls equals(Object) on two references of unrelated
11.4140 -interface types, where neither is a subtype of the other,
11.4141 -and there are no known non-abstract classes which implement both interfaces.
11.4142 -Therefore, the objects being compared
11.4143 -are unlikely to be members of the same class at runtime
11.4144 -(unless some application classes were not analyzed, or dynamic class
11.4145 -loading can occur at runtime).
11.4146 -According to the contract of equals(),
11.4147 -objects of different
11.4148 -classes should always compare as unequal; therefore, according to the
11.4149 -contract defined by java.lang.Object.equals(Object),
11.4150 -the result of this comparison will always be false at runtime.
11.4151 -</p>
11.4152 -]]>
11.4153 - </Details>
11.4154 - </BugPattern>
11.4155 -
11.4156 - <BugPattern type="EC_UNRELATED_CLASS_AND_INTERFACE">
11.4157 - <ShortDescription>Call to equals() comparing unrelated class and interface</ShortDescription>
11.4158 - <LongDescription>Call to equals() comparing unrelated class and interface in {1}</LongDescription>
11.4159 - <Details>
11.4160 - <![CDATA[
11.4161 -<p>
11.4162 -This method calls equals(Object) on two references, one of which is a class
11.4163 -and the other an interface, where neither the class nor any of its
11.4164 -non-abstract subclasses implement the interface.
11.4165 -Therefore, the objects being compared
11.4166 -are unlikely to be members of the same class at runtime
11.4167 -(unless some application classes were not analyzed, or dynamic class
11.4168 -loading can occur at runtime).
11.4169 -According to the contract of equals(),
11.4170 -objects of different
11.4171 -classes should always compare as unequal; therefore, according to the
11.4172 -contract defined by java.lang.Object.equals(Object),
11.4173 -the result of this comparison will always be false at runtime.
11.4174 -</p>
11.4175 - ]]>
11.4176 - </Details>
11.4177 - </BugPattern>
11.4178 -
11.4179 -
11.4180 - <BugPattern type="EC_NULL_ARG">
11.4181 - <ShortDescription>Call to equals() with null argument</ShortDescription>
11.4182 - <LongDescription>Call to equals() with null argument in {1}</LongDescription>
11.4183 - <Details>
11.4184 -<![CDATA[
11.4185 -<p> This method calls equals(Object), passing a null value as
11.4186 -the argument. According to the contract of the equals() method,
11.4187 -this call should always return <code>false</code>.</p>
11.4188 -]]>
11.4189 - </Details>
11.4190 - </BugPattern>
11.4191 -
11.4192 - <BugPattern type="MWN_MISMATCHED_WAIT">
11.4193 - <ShortDescription>Mismatched wait()</ShortDescription>
11.4194 - <LongDescription>Mismatched wait() in {1}</LongDescription>
11.4195 - <Details>
11.4196 -<![CDATA[
11.4197 -<p> This method calls Object.wait() without obviously holding a lock
11.4198 -on the object. Calling wait() without a lock held will result in
11.4199 -an <code>IllegalMonitorStateException</code> being thrown.</p>
11.4200 -]]>
11.4201 - </Details>
11.4202 - </BugPattern>
11.4203 -
11.4204 - <BugPattern type="MWN_MISMATCHED_NOTIFY">
11.4205 - <ShortDescription>Mismatched notify()</ShortDescription>
11.4206 - <LongDescription>Mismatched notify() in {1}</LongDescription>
11.4207 - <Details>
11.4208 -<![CDATA[
11.4209 -<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock
11.4210 -on the object. Calling notify() or notifyAll() without a lock held will result in
11.4211 -an <code>IllegalMonitorStateException</code> being thrown.</p>
11.4212 -]]>
11.4213 - </Details>
11.4214 - </BugPattern>
11.4215 -
11.4216 - <BugPattern type="SA_LOCAL_SELF_ASSIGNMENT">
11.4217 - <ShortDescription>Self assignment of local variable</ShortDescription>
11.4218 - <LongDescription>Self assignment of local variable in {1}</LongDescription>
11.4219 - <Details>
11.4220 -<![CDATA[
11.4221 -<p> This method contains a self assignment of a local variable; e.g.</p>
11.4222 -<pre>
11.4223 - public void foo() {
11.4224 - int x = 3;
11.4225 - x = x;
11.4226 - }
11.4227 -</pre>
11.4228 -<p>
11.4229 -Such assignments are useless, and may indicate a logic error or typo.
11.4230 -</p>
11.4231 -]]>
11.4232 - </Details>
11.4233 - </BugPattern>
11.4234 -
11.4235 - <BugPattern type="SA_FIELD_SELF_ASSIGNMENT">
11.4236 - <ShortDescription>Self assignment of field</ShortDescription>
11.4237 - <LongDescription>Self assignment of field {2.givenClass} in {1}</LongDescription>
11.4238 - <Details>
11.4239 -<![CDATA[
11.4240 -<p> This method contains a self assignment of a field; e.g.
11.4241 -</p>
11.4242 -<pre>
11.4243 - int x;
11.4244 - public void foo() {
11.4245 - x = x;
11.4246 - }
11.4247 -</pre>
11.4248 -<p>Such assignments are useless, and may indicate a logic error or typo.</p>
11.4249 -]]>
11.4250 - </Details>
11.4251 - </BugPattern>
11.4252 -
11.4253 - <BugPattern type="SA_FIELD_DOUBLE_ASSIGNMENT">
11.4254 - <ShortDescription>Double assignment of field</ShortDescription>
11.4255 - <LongDescription>Double assignment of field {2.givenClass} in {1}</LongDescription>
11.4256 - <Details>
11.4257 -<![CDATA[
11.4258 -<p> This method contains a double assignment of a field; e.g.
11.4259 -</p>
11.4260 -<pre>
11.4261 - int x,y;
11.4262 - public void foo() {
11.4263 - x = x = 17;
11.4264 - }
11.4265 -</pre>
11.4266 -<p>Assigning to a field twice is useless, and may indicate a logic error or typo.</p>
11.4267 -]]>
11.4268 - </Details>
11.4269 - </BugPattern>
11.4270 - <BugPattern type="SA_LOCAL_DOUBLE_ASSIGNMENT">
11.4271 - <ShortDescription>Double assignment of local variable </ShortDescription>
11.4272 - <LongDescription>Double assignment of {2} in {1}</LongDescription>
11.4273 - <Details>
11.4274 -<![CDATA[
11.4275 -<p> This method contains a double assignment of a local variable; e.g.
11.4276 -</p>
11.4277 -<pre>
11.4278 - public void foo() {
11.4279 - int x,y;
11.4280 - x = x = 17;
11.4281 - }
11.4282 -</pre>
11.4283 -<p>Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.</p>
11.4284 -]]>
11.4285 - </Details>
11.4286 - </BugPattern>
11.4287 -
11.4288 - <BugPattern type="SA_FIELD_SELF_COMPUTATION">
11.4289 - <ShortDescription>Nonsensical self computation involving a field (e.g., x & x)</ShortDescription>
11.4290 - <LongDescription>Nonsensical self computation of {2.givenClass} with itself {1}</LongDescription>
11.4291 - <Details>
11.4292 -<![CDATA[
11.4293 -<p> This method performs a nonsensical computation of a field with another
11.4294 -reference to the same field (e.g., x&x or x-x). Because of the nature
11.4295 -of the computation, this operation doesn't seem to make sense,
11.4296 -and may indicate a typo or
11.4297 -a logic error. Double check the computation.
11.4298 -</p>
11.4299 -]]>
11.4300 - </Details>
11.4301 - </BugPattern>
11.4302 - <BugPattern type="SA_LOCAL_SELF_COMPUTATION">
11.4303 - <ShortDescription>Nonsensical self computation involving a variable (e.g., x & x)</ShortDescription>
11.4304 - <LongDescription>Nonsensical self computation of {2} with itself {1}</LongDescription>
11.4305 - <Details>
11.4306 -<![CDATA[
11.4307 -<p> This method performs a nonsensical computation of a local variable with another
11.4308 -reference to the same variable (e.g., x&x or x-x). Because of the nature
11.4309 -of the computation, this operation doesn't seem to make sense,
11.4310 -and may indicate a typo or
11.4311 -a logic error. Double check the computation.
11.4312 -</p>
11.4313 -]]>
11.4314 - </Details>
11.4315 - </BugPattern>
11.4316 -
11.4317 -
11.4318 - <BugPattern type="SA_FIELD_SELF_COMPARISON">
11.4319 - <ShortDescription>Self comparison of field with itself</ShortDescription>
11.4320 - <LongDescription>Self comparison of {2.givenClass} with itself {1}</LongDescription>
11.4321 - <Details>
11.4322 -<![CDATA[
11.4323 -<p> This method compares a field with itself, and may indicate a typo or
11.4324 -a logic error. Make sure that you are comparing the right things.
11.4325 -</p>
11.4326 -]]>
11.4327 - </Details>
11.4328 - </BugPattern>
11.4329 -
11.4330 - <BugPattern type="SA_LOCAL_SELF_COMPARISON">
11.4331 - <ShortDescription>Self comparison of value with itself</ShortDescription>
11.4332 - <LongDescription>Self comparison of {2} with itself {1}</LongDescription>
11.4333 - <Details>
11.4334 -<![CDATA[
11.4335 -<p> This method compares a local variable with itself, and may indicate a typo or
11.4336 -a logic error. Make sure that you are comparing the right things.
11.4337 -</p>
11.4338 -]]>
11.4339 - </Details>
11.4340 - </BugPattern>
11.4341 -
11.4342 - <BugPattern type="DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT">
11.4343 - <ShortDescription>Double.longBitsToDouble invoked on an int</ShortDescription>
11.4344 - <LongDescription>Double.longBitsToDouble invoked on an int in {1}</LongDescription>
11.4345 - <Details>
11.4346 -<![CDATA[
11.4347 -<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed
11.4348 - as an argument. This almostly certainly is not intended and is unlikely
11.4349 - to give the intended result.
11.4350 -</p>
11.4351 -]]>
11.4352 - </Details>
11.4353 - </BugPattern>
11.4354 -
11.4355 -
11.4356 -
11.4357 -
11.4358 - <BugPattern type="DMI_RANDOM_USED_ONLY_ONCE">
11.4359 - <ShortDescription>Random object created and used only once</ShortDescription>
11.4360 - <LongDescription>Random object created and used only once in {1}</LongDescription>
11.4361 - <Details>
11.4362 -<![CDATA[
11.4363 -<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards
11.4364 -the Random object. This produces mediocre quality random numbers and is inefficient.
11.4365 -If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number
11.4366 -is required invoke a method on the existing Random object to obtain it.
11.4367 -</p>
11.4368 -
11.4369 -<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
11.4370 -number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead
11.4371 -(and avoid allocating a new SecureRandom for each random number needed).
11.4372 -</p>
11.4373 -]]>
11.4374 - </Details>
11.4375 - </BugPattern>
11.4376 - <BugPattern type="RV_ABSOLUTE_VALUE_OF_RANDOM_INT">
11.4377 - <ShortDescription>Bad attempt to compute absolute value of signed 32-bit random integer</ShortDescription>
11.4378 - <LongDescription>Bad attempt to compute absolute value of signed 32-bit random integer in {1}</LongDescription>
11.4379 - <Details>
11.4380 -<![CDATA[
11.4381 -<p> This code generates a random signed integer and then computes
11.4382 -the absolute value of that random integer. If the number returned by the random number
11.4383 -generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
11.4384 -<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
11.4385 -</p>
11.4386 -]]>
11.4387 - </Details>
11.4388 - </BugPattern>
11.4389 -
11.4390 -
11.4391 -
11.4392 - <BugPattern type="RV_ABSOLUTE_VALUE_OF_HASHCODE">
11.4393 - <ShortDescription>Bad attempt to compute absolute value of signed 32-bit hashcode </ShortDescription>
11.4394 - <LongDescription>Bad attempt to compute absolute value of signed 32-bit hashcode in {1}</LongDescription>
11.4395 - <Details>
11.4396 -<![CDATA[
11.4397 -<p> This code generates a hashcode and then computes
11.4398 -the absolute value of that hashcode. If the hashcode
11.4399 -is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
11.4400 -<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
11.4401 -</p>
11.4402 -]]>
11.4403 - </Details>
11.4404 - </BugPattern>
11.4405 -
11.4406 -
11.4407 -
11.4408 - <BugPattern type="RV_REM_OF_RANDOM_INT">
11.4409 - <ShortDescription>Remainder of 32-bit signed random integer</ShortDescription>
11.4410 - <LongDescription>Remainder of 32-bit signed random integer computed in {1}</LongDescription>
11.4411 - <Details>
11.4412 -<![CDATA[
11.4413 -<p> This code generates a random signed integer and then computes
11.4414 -the remainder of that value modulo another value. Since the random
11.4415 -number can be negative, the result of the remainder operation
11.4416 -can also be negative. Be sure this is intended, and strongly
11.4417 -consider using the Random.nextInt(int) method instead.
11.4418 -</p>
11.4419 -]]>
11.4420 - </Details>
11.4421 - </BugPattern>
11.4422 -
11.4423 - <BugPattern type="RV_REM_OF_HASHCODE">
11.4424 - <ShortDescription>Remainder of hashCode could be negative</ShortDescription>
11.4425 - <LongDescription>Remainder of hashCode could be negative in {1}</LongDescription>
11.4426 - <Details>
11.4427 -<![CDATA[
11.4428 -<p> This code computes a hashCode, and then computes
11.4429 -the remainder of that value modulo another value. Since the hashCode
11.4430 -can be negative, the result of the remainder operation
11.4431 -can also be negative. </p>
11.4432 -<p> Assuming you want to ensure that the result of your computation is nonnegative,
11.4433 -you may need to change your code.
11.4434 -If you know the divisor is a power of 2,
11.4435 -you can use a bitwise and operator instead (i.e., instead of
11.4436 -using <code>x.hashCode()%n</code>, use <code>x.hashCode()&(n-1)</code>.
11.4437 -This is probably faster than computing the remainder as well.
11.4438 -If you don't know that the divisor is a power of 2, take the absolute
11.4439 -value of the result of the remainder operation (i.e., use
11.4440 -<code>Math.abs(x.hashCode()%n)</code>
11.4441 -</p>
11.4442 -]]>
11.4443 - </Details>
11.4444 - </BugPattern>
11.4445 -
11.4446 -
11.4447 - <BugPattern type="INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE">
11.4448 - <ShortDescription>Bad comparison of nonnegative value with negative constant</ShortDescription>
11.4449 - <LongDescription>Bad comparison of nonnegative value with {2} in {1}</LongDescription>
11.4450 - <Details>
11.4451 -<![CDATA[
11.4452 -<p> This code compares a value that is guaranteed to be non-negative with a negative constant.
11.4453 -</p>
11.4454 -]]>
11.4455 - </Details>
11.4456 - </BugPattern>
11.4457 -
11.4458 -
11.4459 - <BugPattern type="INT_BAD_COMPARISON_WITH_SIGNED_BYTE">
11.4460 - <ShortDescription>Bad comparison of signed byte</ShortDescription>
11.4461 - <LongDescription>Bad comparison of signed byte with {2} in {1}</LongDescription>
11.4462 - <Details>
11.4463 -<![CDATA[
11.4464 -<p> Signed bytes can only have a value in the range -128 to 127. Comparing
11.4465 -a signed byte with a value outside that range is vacuous and likely to be incorrect.
11.4466 -To convert a signed byte <code>b</code> to an unsigned value in the range 0..255,
11.4467 -use <code>0xff & b</code>
11.4468 -</p>
11.4469 -]]>
11.4470 - </Details>
11.4471 - </BugPattern>
11.4472 -
11.4473 -
11.4474 -
11.4475 - <BugPattern type="INT_VACUOUS_COMPARISON">
11.4476 - <ShortDescription>Vacuous comparison of integer value</ShortDescription>
11.4477 - <LongDescription>Vacuous comparison of integer value {1} </LongDescription>
11.4478 - <Details>
11.4479 -<![CDATA[
11.4480 -<p> There is an integer comparison that always returns
11.4481 -the same value (e.g., x <= Integer.MAX_VALUE).
11.4482 -</p>
11.4483 -]]>
11.4484 - </Details>
11.4485 - </BugPattern>
11.4486 - <BugPattern type="INT_BAD_REM_BY_1">
11.4487 - <ShortDescription>Integer remainder modulo 1</ShortDescription>
11.4488 - <LongDescription>Integer remainder modulo 1 computed in {1} </LongDescription>
11.4489 - <Details>
11.4490 -<![CDATA[
11.4491 -<p> Any expression (exp % 1) is guaranteed to always return zero.
11.4492 -Did you mean (exp & 1) or (exp % 2) instead?
11.4493 -</p>
11.4494 -]]>
11.4495 - </Details>
11.4496 - </BugPattern>
11.4497 - <BugPattern type="BIT_IOR_OF_SIGNED_BYTE">
11.4498 - <ShortDescription>Bitwise OR of signed byte value</ShortDescription>
11.4499 - <LongDescription>Bitwise OR of signed byte value computed in {1} </LongDescription>
11.4500 - <Details>
11.4501 -<![CDATA[
11.4502 -<p> Loads a value from a byte array and performs a bitwise OR with
11.4503 -that value. Values loaded from a byte array are sign extended to 32 bits
11.4504 -before any any bitwise operations are performed on the value.
11.4505 -Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
11.4506 -<code>x</code> is initially 0, then the code
11.4507 -<code>((x << 8) | b[0])</code> will sign extend <code>0xff</code>
11.4508 -to get <code>0xffffffff</code>, and thus give the value
11.4509 -<code>0xffffffff</code> as the result.
11.4510 -</p>
11.4511 -
11.4512 -<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
11.4513 -<code>
11.4514 -int result = 0;
11.4515 -for(int i = 0; i < 4; i++)
11.4516 - result = ((result << 8) | b[i]);
11.4517 -</code>
11.4518 -
11.4519 -<p>The following idiom will work instead: </p>
11.4520 -<code>
11.4521 -int result = 0;
11.4522 -for(int i = 0; i < 4; i++)
11.4523 - result = ((result << 8) | (b[i] &s; 0xff));
11.4524 -</code>
11.4525 -
11.4526 -]]>
11.4527 - </Details>
11.4528 - </BugPattern>
11.4529 -
11.4530 -
11.4531 -
11.4532 - <BugPattern type="BIT_AND">
11.4533 - <ShortDescription>Incompatible bit masks</ShortDescription>
11.4534 - <LongDescription>Incompatible bit masks yield a constant result in {1}</LongDescription>
11.4535 - <Details>
11.4536 -<![CDATA[
11.4537 -<p> This method compares an expression of the form (a & C) to D,
11.4538 -which will always compare unequal
11.4539 -due to the specific values of constants C and D.
11.4540 -This may indicate a logic error or typo.</p>
11.4541 -]]>
11.4542 - </Details>
11.4543 - </BugPattern>
11.4544 -
11.4545 - <BugPattern type="BIT_AND_ZZ">
11.4546 - <ShortDescription>Check to see if ((...) & 0) == 0</ShortDescription>
11.4547 - <LongDescription>Check to see if ((...) & 0) == 0 in {1}</LongDescription>
11.4548 - <Details>
11.4549 -<![CDATA[
11.4550 -<p> This method compares an expression of the form (a & 0) to 0,
11.4551 -which will always compare equal.
11.4552 -This may indicate a logic error or typo.</p>
11.4553 -]]>
11.4554 - </Details>
11.4555 - </BugPattern>
11.4556 -
11.4557 - <BugPattern type="BIT_IOR">
11.4558 - <ShortDescription>Incompatible bit masks</ShortDescription>
11.4559 - <LongDescription>Incompatible bit masks yield a constant result in {1}</LongDescription>
11.4560 - <Details>
11.4561 -<![CDATA[
11.4562 -<p> This method compares an expression of the form (a | C) to D.
11.4563 -which will always compare unequal
11.4564 -due to the specific values of constants C and D.
11.4565 -This may indicate a logic error or typo.</p>
11.4566 -
11.4567 -<p> Typically, this bug occurs because the code wants to perform
11.4568 -a membership test in a bit set, but uses the bitwise OR
11.4569 -operator ("|") instead of bitwise AND ("&").</p>
11.4570 -]]>
11.4571 - </Details>
11.4572 - </BugPattern>
11.4573 -
11.4574 - <BugPattern type="LI_LAZY_INIT_INSTANCE" deprecated="true"> <!-- never generated? -->
11.4575 - <ShortDescription>Incorrect lazy initialization of instance field</ShortDescription>
11.4576 - <LongDescription>Incorrect lazy initialization of instance field {2} in {1}</LongDescription>
11.4577 - <Details>
11.4578 -<![CDATA[
11.4579 -<p> This method contains an unsynchronized lazy initialization of a non-volatile field.
11.4580 -Because the compiler or processor may reorder instructions,
11.4581 -threads are not guaranteed to see a completely initialized object,
11.4582 -<em>if the method can be called by multiple threads</em>.
11.4583 -You can make the field volatile to correct the problem.
11.4584 -For more information, see the
11.4585 -<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
11.4586 -</p>
11.4587 -]]>
11.4588 - </Details>
11.4589 - </BugPattern>
11.4590 -
11.4591 - <BugPattern type="LI_LAZY_INIT_STATIC">
11.4592 - <ShortDescription>Incorrect lazy initialization of static field</ShortDescription>
11.4593 - <LongDescription>Incorrect lazy initialization of static field {2} in {1}</LongDescription>
11.4594 - <Details>
11.4595 -<![CDATA[
11.4596 -<p> This method contains an unsynchronized lazy initialization of a non-volatile static field.
11.4597 -Because the compiler or processor may reorder instructions,
11.4598 -threads are not guaranteed to see a completely initialized object,
11.4599 -<em>if the method can be called by multiple threads</em>.
11.4600 -You can make the field volatile to correct the problem.
11.4601 -For more information, see the
11.4602 -<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
11.4603 -</p>
11.4604 -]]>
11.4605 - </Details>
11.4606 - </BugPattern>
11.4607 -
11.4608 - <BugPattern type="JLM_JSR166_LOCK_MONITORENTER">
11.4609 - <ShortDescription>Synchronization performed on java.util.concurrent Lock</ShortDescription>
11.4610 - <LongDescription>Synchronization performed on java.util.concurrent Lock in {1}</LongDescription>
11.4611 -<Details>
11.4612 -<![CDATA[
11.4613 -<p> This method performs synchronization on an implementation of
11.4614 -<code>java.util.concurrent.locks.Lock</code>. You should use
11.4615 -the <code>lock()</code> and <code>unlock()</code> methods instead.
11.4616 -</p>
11.4617 -]]>
11.4618 -</Details>
11.4619 - </BugPattern>
11.4620 -
11.4621 - <BugPattern type="UPM_UNCALLED_PRIVATE_METHOD">
11.4622 - <ShortDescription>Private method is never called</ShortDescription>
11.4623 - <LongDescription>Private method {1} is never called</LongDescription>
11.4624 -<Details>
11.4625 -<![CDATA[
11.4626 -<p> This private method is never called. Although it is
11.4627 -possible that the method will be invoked through reflection,
11.4628 -it is more likely that the method is never used, and should be
11.4629 -removed.
11.4630 -</p>
11.4631 -]]>
11.4632 -</Details>
11.4633 - </BugPattern>
11.4634 - <BugPattern type="UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS">
11.4635 - <ShortDescription>Uncallable method defined in anonymous class</ShortDescription>
11.4636 - <LongDescription>Uncallable method {1} defined in anonymous class</LongDescription>
11.4637 -<Details>
11.4638 -<![CDATA[
11.4639 -<p> This anonymous class defined a method that is not directly invoked and does not override
11.4640 -a method in a superclass. Since methods in other classes cannot directly invoke methods
11.4641 -declared in an anonymous class, it seems that this method is uncallable. The method
11.4642 -might simply be dead code, but it is also possible that the method is intended to
11.4643 -override a method declared in a superclass, and due to an typo or other error the method does not,
11.4644 -in fact, override the method it is intended to.
11.4645 -</p>
11.4646 -]]>
11.4647 -</Details>
11.4648 - </BugPattern>
11.4649 -
11.4650 - <BugPattern type="ODR_OPEN_DATABASE_RESOURCE">
11.4651 - <ShortDescription>Method may fail to close database resource</ShortDescription>
11.4652 - <LongDescription>{1} may fail to close {2.excludingPackage}</LongDescription>
11.4653 - <Details>
11.4654 -<![CDATA[
11.4655 -<p> The method creates a database resource (such as a database connection
11.4656 -or row set), does not assign it to any
11.4657 -fields, pass it to other methods, or return it, and does not appear to close
11.4658 -the object on all paths out of the method. Failure to
11.4659 -close database resources on all paths out of a method may
11.4660 -result in poor performance, and could cause the application to
11.4661 -have problems communicating with the database.
11.4662 -</p>
11.4663 -]]>
11.4664 - </Details>
11.4665 - </BugPattern>
11.4666 -
11.4667 - <BugPattern type="ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH">
11.4668 - <ShortDescription>Method may fail to close database resource on exception</ShortDescription>
11.4669 - <LongDescription>{1} may fail to close database resource on exception</LongDescription>
11.4670 - <Details>
11.4671 -<![CDATA[
11.4672 -<p> The method creates a database resource (such as a database connection
11.4673 -or row set), does not assign it to any
11.4674 -fields, pass it to other methods, or return it, and does not appear to close
11.4675 -the object on all exception paths out of the method. Failure to
11.4676 -close database resources on all paths out of a method may
11.4677 -result in poor performance, and could cause the application to
11.4678 -have problems communicating with the database.</p>
11.4679 -]]>
11.4680 - </Details>
11.4681 - </BugPattern>
11.4682 -
11.4683 - <BugPattern type="SBSC_USE_STRINGBUFFER_CONCATENATION">
11.4684 - <ShortDescription>Method concatenates strings using + in a loop</ShortDescription>
11.4685 - <LongDescription>Method {1} concatenates strings using + in a loop</LongDescription>
11.4686 - <Details>
11.4687 -<![CDATA[
11.4688 -<p> The method seems to be building a String using concatenation in a loop.
11.4689 -In each iteration, the String is converted to a StringBuffer/StringBuilder,
11.4690 - appended to, and converted back to a String.
11.4691 - This can lead to a cost quadratic in the number of iterations,
11.4692 - as the growing string is recopied in each iteration. </p>
11.4693 -
11.4694 -<p>Better performance can be obtained by using
11.4695 -a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p>
11.4696 -
11.4697 -<p> For example:</p>
11.4698 -<pre>
11.4699 - // This is bad
11.4700 - String s = "";
11.4701 - for (int i = 0; i < field.length; ++i) {
11.4702 - s = s + field[i];
11.4703 - }
11.4704 -
11.4705 - // This is better
11.4706 - StringBuffer buf = new StringBuffer();
11.4707 - for (int i = 0; i < field.length; ++i) {
11.4708 - buf.append(field[i]);
11.4709 - }
11.4710 - String s = buf.toString();
11.4711 -</pre>
11.4712 -]]>
11.4713 - </Details>
11.4714 - </BugPattern>
11.4715 -
11.4716 - <BugPattern type="ITA_INEFFICIENT_TO_ARRAY">
11.4717 - <ShortDescription>Method uses toArray() with zero-length array argument</ShortDescription>
11.4718 - <LongDescription>Method {1} uses Collection.toArray() with zero-length array argument</LongDescription>
11.4719 - <Details>
11.4720 -<![CDATA[
11.4721 -<p> This method uses the toArray() method of a collection derived class, and passes
11.4722 -in a zero-length prototype array argument. It is more efficient to use
11.4723 -<code>myCollection.toArray(new Foo[myCollection.size()])</code>
11.4724 -If the array passed in is big enough to store all of the
11.4725 -elements of the collection, then it is populated and returned
11.4726 -directly. This avoids the need to create a second array
11.4727 -(by reflection) to return as the result.</p>
11.4728 -]]>
11.4729 - </Details>
11.4730 - </BugPattern>
11.4731 -
11.4732 - <BugPattern type="IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD">
11.4733 - <ShortDescription>JUnit assertion in run method will not be noticed by JUnit</ShortDescription>
11.4734 - <LongDescription>JUnit assertion in {1} will not be noticed by JUnit</LongDescription>
11.4735 - <Details>
11.4736 -<![CDATA[
11.4737 -<p> A JUnit assertion is performed in a run method. Failed JUnit assertions
11.4738 -just result in exceptions being thrown.
11.4739 -Thus, if this exception occurs in a thread other than the thread that invokes
11.4740 -the test method, the exception will terminate the thread but not result
11.4741 -in the test failing.
11.4742 -</p>
11.4743 -]]>
11.4744 - </Details>
11.4745 - </BugPattern>
11.4746 - <BugPattern type="IJU_SETUP_NO_SUPER">
11.4747 - <ShortDescription>TestCase implements setUp but doesn't call super.setUp()</ShortDescription>
11.4748 - <LongDescription>TestCase {0} implements setUp but doesn't call super.setUp()</LongDescription>
11.4749 - <Details>
11.4750 -<![CDATA[
11.4751 -<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call
11.4752 -super.setUp(), but doesn't.</p>
11.4753 -]]>
11.4754 - </Details>
11.4755 - </BugPattern>
11.4756 -
11.4757 - <BugPattern type="IJU_TEARDOWN_NO_SUPER">
11.4758 - <ShortDescription>TestCase implements tearDown but doesn't call super.tearDown()</ShortDescription>
11.4759 - <LongDescription>TestCase {0} implements tearDown but doesn't call super.tearDown()</LongDescription>
11.4760 - <Details>
11.4761 -<![CDATA[
11.4762 -<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call
11.4763 -super.tearDown(), but doesn't.</p>
11.4764 -]]>
11.4765 - </Details>
11.4766 - </BugPattern>
11.4767 -
11.4768 - <BugPattern type="IJU_SUITE_NOT_STATIC">
11.4769 - <ShortDescription>TestCase implements a non-static suite method </ShortDescription>
11.4770 - <LongDescription>TestCase {0} implements a non-static suite method</LongDescription>
11.4771 - <Details>
11.4772 -<![CDATA[
11.4773 -<p> Class is a JUnit TestCase and implements the suite() method.
11.4774 - The suite method should be declared as being static, but isn't.</p>
11.4775 -]]>
11.4776 - </Details>
11.4777 - </BugPattern>
11.4778 -
11.4779 - <BugPattern type="IJU_BAD_SUITE_METHOD">
11.4780 - <ShortDescription>TestCase declares a bad suite method </ShortDescription>
11.4781 - <LongDescription>Bad declaration for suite method in {0}</LongDescription>
11.4782 - <Details>
11.4783 -<![CDATA[
11.4784 -<p> Class is a JUnit TestCase and defines a suite() method.
11.4785 -However, the suite method needs to be declared as either
11.4786 -<pre>public static junit.framework.Test suite()</pre>
11.4787 -or
11.4788 -<pre>public static junit.framework.TestSuite suite()</pre>
11.4789 -</p>
11.4790 -]]>
11.4791 - </Details>
11.4792 - </BugPattern>
11.4793 -
11.4794 - <BugPattern type="IJU_NO_TESTS">
11.4795 - <ShortDescription>TestCase has no tests</ShortDescription>
11.4796 - <LongDescription>TestCase {0} has no tests</LongDescription>
11.4797 - <Details>
11.4798 -<![CDATA[
11.4799 -<p> Class is a JUnit TestCase but has not implemented any test methods</p>
11.4800 -]]>
11.4801 - </Details>
11.4802 - </BugPattern>
11.4803 -
11.4804 -
11.4805 - <BugPattern type="BOA_BADLY_OVERRIDDEN_ADAPTER">
11.4806 - <ShortDescription>Class overrides a method implemented in super class Adapter wrongly</ShortDescription>
11.4807 - <LongDescription>Class {0} overrides a method {1} implemented in super class Adapter wrongly</LongDescription>
11.4808 - <Details>
11.4809 -<![CDATA[
11.4810 -<p> This method overrides a method found in a parent class, where that class is an Adapter that implements
11.4811 -a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not
11.4812 -get called when the event occurs.</p>
11.4813 -]]>
11.4814 - </Details>
11.4815 - </BugPattern>
11.4816 -
11.4817 - <BugPattern type="BRSA_BAD_RESULTSET_ACCESS" deprecated="true"> <!-- deprecated in favor of SQL_BAD_RESULTSET_ACCESS -->
11.4818 - <ShortDescription>Method attempts to access a result set field with index 0</ShortDescription>
11.4819 - <LongDescription>Method {1} attempts to access a result set field with index 0</LongDescription>
11.4820 - <Details>
11.4821 -<![CDATA[
11.4822 -<p> A call to getXXX or updateXXX methods of a result set was made where the
11.4823 -field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
11.4824 -]]>
11.4825 - </Details>
11.4826 - </BugPattern>
11.4827 -
11.4828 - <BugPattern type="SQL_BAD_RESULTSET_ACCESS">
11.4829 - <ShortDescription>Method attempts to access a result set field with index 0</ShortDescription>
11.4830 - <LongDescription>Method {1} attempts to access a result set field with index 0</LongDescription>
11.4831 - <Details>
11.4832 -<![CDATA[
11.4833 -<p> A call to getXXX or updateXXX methods of a result set was made where the
11.4834 -field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
11.4835 -]]>
11.4836 - </Details>
11.4837 - </BugPattern>
11.4838 -
11.4839 - <BugPattern type="SQL_BAD_PREPARED_STATEMENT_ACCESS">
11.4840 - <ShortDescription>Method attempts to access a prepared statement parameter with index 0</ShortDescription>
11.4841 - <LongDescription>Method {1} attempts to access a prepared statement parameter with index 0</LongDescription>
11.4842 - <Details>
11.4843 -<![CDATA[
11.4844 -<p> A call to a setXXX method of a prepared statement was made where the
11.4845 -parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>
11.4846 -]]>
11.4847 - </Details>
11.4848 - </BugPattern>
11.4849 -
11.4850 - <BugPattern type="SIO_SUPERFLUOUS_INSTANCEOF">
11.4851 - <ShortDescription>Unnecessary type check done using instanceof operator</ShortDescription>
11.4852 - <LongDescription>Method {1} does an unnecessary type check using instanceof operator when it can be determined statically</LongDescription>
11.4853 - <Details>
11.4854 -<![CDATA[
11.4855 -<p> Type check performed using the instanceof operator where it can be statically determined whether the object
11.4856 -is of the type requested. </p>
11.4857 -]]>
11.4858 - </Details>
11.4859 - </BugPattern>
11.4860 -
11.4861 - <BugPattern type="BAC_BAD_APPLET_CONSTRUCTOR">
11.4862 - <ShortDescription>Bad Applet Constructor relies on uninitialized AppletStub</ShortDescription>
11.4863 - <LongDescription>Bad Applet Constructor relies on uninitialized AppletStub</LongDescription>
11.4864 - <Details>
11.4865 -<![CDATA[
11.4866 -<p>
11.4867 -This constructor calls methods in the parent Applet that rely on the AppletStub. Since the AppletStub
11.4868 -isn't initialized until the init() method of this applet is called, these methods will not perform
11.4869 -correctly.
11.4870 -</p>
11.4871 -]]>
11.4872 - </Details>
11.4873 - </BugPattern>
11.4874 -
11.4875 - <BugPattern type="EC_ARRAY_AND_NONARRAY">
11.4876 - <ShortDescription>equals() used to compare array and nonarray</ShortDescription>
11.4877 - <LongDescription>{1} uses equals to compare an array and nonarray</LongDescription>
11.4878 - <Details>
11.4879 -<![CDATA[
11.4880 -<p>
11.4881 -This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem
11.4882 -to be an array. If things being compared are of different types, they are guaranteed to be unequal
11.4883 -and the comparison is almost certainly an error. Even if they are both arrays, the equals method
11.4884 -on arrays only determines of the two arrays are the same object.
11.4885 -To compare the
11.4886 -contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
11.4887 -</p>
11.4888 -]]>
11.4889 - </Details>
11.4890 - </BugPattern>
11.4891 - <BugPattern type="EC_BAD_ARRAY_COMPARE">
11.4892 - <ShortDescription>Invocation of equals() on an array, which is equivalent to ==</ShortDescription>
11.4893 - <LongDescription>{1} invokes equals() on an array, which is equivalent to ==</LongDescription>
11.4894 - <Details>
11.4895 -<![CDATA[
11.4896 -<p>
11.4897 -This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals
11.4898 -method of Object, calling equals on an array is the same as comparing their addresses. To compare the
11.4899 -contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
11.4900 -</p>
11.4901 -]]>
11.4902 - </Details>
11.4903 - </BugPattern>
11.4904 -
11.4905 - <BugPattern type="UOE_USE_OBJECT_EQUALS">
11.4906 - <ShortDescription>Calls to equals on a final class that doesn't override Object's version</ShortDescription>
11.4907 - <LongDescription>Calls to equals on a final class that doesn't override Object's version</LongDescription>
11.4908 - <Details>
11.4909 -<![CDATA[
11.4910 -<p>
11.4911 -This method invokes the .equals(Object o) method on a final class that doesn't override the equals method
11.4912 -in the Object class, effectively making the equals method test for sameness, like ==. It is good to use
11.4913 -the .equals method, but you should consider adding an .equals method in this class.
11.4914 -</p>
11.4915 -<p>[Bill Pugh]: Sorry, but I strongly disagree that this should be a warning, and I think your code
11.4916 -is just fine. Users of your code shouldn't care how you've implemented equals(), and they should never
11.4917 -depend on == to compare instances, since that bypasses the libraries ability to control how objects
11.4918 -are compared.
11.4919 -</p>
11.4920 -]]>
11.4921 - </Details>
11.4922 - </BugPattern>
11.4923 -
11.4924 - <BugPattern type="STI_INTERRUPTED_ON_CURRENTTHREAD">
11.4925 - <ShortDescription>Unneeded use of currentThread() call, to call interrupted() </ShortDescription>
11.4926 - <LongDescription>Method {1} makes an unneeded call to currentThread() just to call interrupted()</LongDescription>
11.4927 - <Details>
11.4928 -<![CDATA[
11.4929 -<p>
11.4930 -This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a
11.4931 -static method, is more simple and clear to use Thread.interrupted().
11.4932 -</p>
11.4933 -]]>
11.4934 - </Details>
11.4935 - </BugPattern>
11.4936 -
11.4937 - <BugPattern type="STI_INTERRUPTED_ON_UNKNOWNTHREAD">
11.4938 - <ShortDescription>Static Thread.interrupted() method invoked on thread instance</ShortDescription>
11.4939 - <LongDescription>{1} invokes static Thread.interrupted() method on thread instance</LongDescription>
11.4940 - <Details>
11.4941 -<![CDATA[
11.4942 -<p>
11.4943 -This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is
11.4944 -not the current thread. As the interrupted() method is static, the interrupted method will be called on a different
11.4945 -object than the one the author intended.
11.4946 -</p>
11.4947 -]]>
11.4948 - </Details>
11.4949 - </BugPattern>
11.4950 -
11.4951 - <BugPattern type="IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN">
11.4952 - <ShortDescription>A parameter is dead upon entry to a method but overwritten</ShortDescription>
11.4953 - <LongDescription>The parameter {2} to {1} is dead upon entry but overwritten</LongDescription>
11.4954 - <Details>
11.4955 -<![CDATA[
11.4956 -<p>
11.4957 -The initial value of this parameter is ignored, and the parameter
11.4958 -is overwritten here. This often indicates a mistaken belief that
11.4959 -the write to the parameter will be conveyed back to
11.4960 -the caller.
11.4961 -</p>
11.4962 -]]>
11.4963 - </Details>
11.4964 - </BugPattern>
11.4965 - <BugPattern type="DLS_DEAD_LOCAL_STORE">
11.4966 - <ShortDescription>Dead store to local variable</ShortDescription>
11.4967 - <LongDescription>Dead store to {2} in {1}</LongDescription>
11.4968 - <Details>
11.4969 -<![CDATA[
11.4970 -<p>
11.4971 -This instruction assigns a value to a local variable,
11.4972 -but the value is not read by any subsequent instruction.
11.4973 -Often, this indicates an error, because the value computed
11.4974 -is never used.
11.4975 -</p>
11.4976 -<p>
11.4977 -Note that Sun's javac compiler often generates dead stores for
11.4978 -final local variables. Because FindBugs is a bytecode-based tool,
11.4979 -there is no easy way to eliminate these false positives.
11.4980 -</p>
11.4981 -]]>
11.4982 - </Details>
11.4983 - </BugPattern>
11.4984 -
11.4985 - <BugPattern type="DLS_DEAD_LOCAL_STORE_OF_NULL">
11.4986 - <ShortDescription>Dead store of null to local variable</ShortDescription>
11.4987 - <LongDescription>Dead store of null to {2} in {1}</LongDescription>
11.4988 - <Details>
11.4989 -<![CDATA[
11.4990 -<p>The code stores null into a local variable, and stored value is not
11.4991 -read. This store may have been introduced in assist the garbage collector, but
11.4992 -as of Java SE 6.0, this is no longer needed or useful.
11.4993 -</p>
11.4994 -]]>
11.4995 - </Details>
11.4996 - </BugPattern>
11.4997 -
11.4998 - <BugPattern type="MF_METHOD_MASKS_FIELD">
11.4999 - <ShortDescription>Method defines a variable that obscures a field</ShortDescription>
11.5000 - <LongDescription>Method {1} defines a variable that obscures field {2.givenClass}</LongDescription>
11.5001 - <Details>
11.5002 -<![CDATA[
11.5003 -<p> This method defines a local variable with the same name as a field
11.5004 -in this class or a superclass. This may cause the method to
11.5005 -read an uninitialized value from the field, leave the field uninitialized,
11.5006 -or both.</p>
11.5007 -]]>
11.5008 - </Details>
11.5009 - </BugPattern>
11.5010 -
11.5011 - <BugPattern type="MF_CLASS_MASKS_FIELD">
11.5012 - <ShortDescription>Class defines field that masks a superclass field</ShortDescription>
11.5013 - <LongDescription>Field {1.givenClass} masks field in superclass {2.class}</LongDescription>
11.5014 - <Details>
11.5015 -<![CDATA[
11.5016 -<p> This class defines a field with the same name as a visible
11.5017 -instance field in a superclass. This is confusing, and
11.5018 -may indicate an error if methods update or access one of
11.5019 -the fields when they wanted the other.</p>
11.5020 -]]>
11.5021 - </Details>
11.5022 - </BugPattern>
11.5023 -
11.5024 - <BugPattern type="WMI_WRONG_MAP_ITERATOR">
11.5025 - <ShortDescription>Inefficient use of keySet iterator instead of entrySet iterator</ShortDescription>
11.5026 - <LongDescription>Method {1} makes inefficient use of keySet iterator instead of entrySet iterator</LongDescription>
11.5027 - <Details>
11.5028 -<![CDATA[
11.5029 -<p> This method accesses the value of a Map entry, using a key that was retrieved from
11.5030 -a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the
11.5031 -Map.get(key) lookup.</p>
11.5032 -]]>
11.5033 - </Details>
11.5034 - </BugPattern>
11.5035 -
11.5036 - <BugPattern type="ISC_INSTANTIATE_STATIC_CLASS">
11.5037 - <ShortDescription>Needless instantiation of class that only supplies static methods</ShortDescription>
11.5038 - <LongDescription>Method {1} needlessly instantiates a class that only supplies static methods</LongDescription>
11.5039 - <Details>
11.5040 -<![CDATA[
11.5041 -<p> This class allocates an object that is based on a class that only supplies static methods. This object
11.5042 -does not need to be created, just access the static methods directly using the class name as a qualifier.</p>
11.5043 -]]>
11.5044 - </Details>
11.5045 - </BugPattern>
11.5046 -
11.5047 - <BugPattern type="REC_CATCH_EXCEPTION">
11.5048 - <ShortDescription>Exception is caught when Exception is not thrown</ShortDescription>
11.5049 - <LongDescription>Exception is caught when Exception is not thrown in {1}</LongDescription>
11.5050 - <Details>
11.5051 - <![CDATA[
11.5052 - <p>
11.5053 - This method uses a try-catch block that catches Exception objects, but Exception is not
11.5054 - thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to
11.5055 - say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception
11.5056 - each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well,
11.5057 - masking potential bugs.
11.5058 - </p>
11.5059 - ]]>
11.5060 - </Details>
11.5061 - </BugPattern>
11.5062 -
11.5063 - <BugPattern type="FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER">
11.5064 - <ShortDescription>Doomed test for equality to NaN</ShortDescription>
11.5065 - <LongDescription>Doomed test for equality to NaN in {1}</LongDescription>
11.5066 - <Details>
11.5067 - <![CDATA[
11.5068 - <p>
11.5069 - This code checks to see if a floating point value is equal to the special
11.5070 - Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However,
11.5071 - because of the special semantics of <code>NaN</code>, no value
11.5072 - is equal to <code>Nan</code>, including <code>NaN</code>. Thus,
11.5073 - <code>x == Double.NaN</code> always evaluates to false.
11.5074 -
11.5075 - To check to see if a value contained in <code>x</code>
11.5076 - is the special Not A Number value, use
11.5077 - <code>Double.isNaN(x)</code> (or <code>Float.isNaN(x)</code> if
11.5078 - <code>x</code> is floating point precision).
11.5079 - </p>
11.5080 - ]]>
11.5081 - </Details>
11.5082 - </BugPattern>
11.5083 - <BugPattern type="FE_FLOATING_POINT_EQUALITY">
11.5084 - <ShortDescription>Test for floating point equality</ShortDescription>
11.5085 - <LongDescription>Test for floating point equality in {1}</LongDescription>
11.5086 - <Details>
11.5087 - <![CDATA[
11.5088 - <p>
11.5089 - This operation compares two floating point values for equality.
11.5090 - Because floating point calculations may involve rounding,
11.5091 - calculated float and double values may not be accurate.
11.5092 - For values that must be precise, such as monetary values,
11.5093 - consider using a fixed-precision type such as BigDecimal.
11.5094 - For values that need not be precise, consider comparing for equality
11.5095 - within some range, for example:
11.5096 - <code>if ( Math.abs(x - y) < .0000001 )</code>.
11.5097 - See the Java Language Specification, section 4.2.4.
11.5098 - </p>
11.5099 - ]]>
11.5100 - </Details>
11.5101 - </BugPattern>
11.5102 -
11.5103 - <BugPattern type="UM_UNNECESSARY_MATH">
11.5104 - <ShortDescription>Method calls static Math class method on a constant value</ShortDescription>
11.5105 - <LongDescription>Method calls static Math class method on a constant value</LongDescription>
11.5106 - <Details>
11.5107 -<![CDATA[
11.5108 -<p> This method uses a static method from java.lang.Math on a constant value. This method's
11.5109 -result in this case, can be determined statically, and is faster and sometimes more accurate to
11.5110 -just use the constant. Methods detected are:
11.5111 -</p>
11.5112 -<table>
11.5113 -<tr>
11.5114 - <th>Method</th> <th>Parameter</th>
11.5115 -</tr>
11.5116 -<tr>
11.5117 - <td>abs</td> <td>-any-</td>
11.5118 -</tr>
11.5119 -<tr>
11.5120 - <td>acos</td> <td>0.0 or 1.0</td>
11.5121 -</tr>
11.5122 -<tr>
11.5123 - <td>asin</td> <td>0.0 or 1.0</td>
11.5124 -</tr>
11.5125 -<tr>
11.5126 - <td>atan</td> <td>0.0 or 1.0</td>
11.5127 -</tr>
11.5128 -<tr>
11.5129 - <td>atan2</td> <td>0.0</td>
11.5130 -</tr>
11.5131 -<tr>
11.5132 - <td>cbrt</td> <td>0.0 or 1.0</td>
11.5133 -</tr>
11.5134 -<tr>
11.5135 - <td>ceil</td> <td>-any-</td>
11.5136 -</tr>
11.5137 -<tr>
11.5138 - <td>cos</td> <td>0.0</td>
11.5139 -</tr>
11.5140 -<tr>
11.5141 - <td>cosh</td> <td>0.0</td>
11.5142 -</tr>
11.5143 -<tr>
11.5144 - <td>exp</td> <td>0.0 or 1.0</td>
11.5145 -</tr>
11.5146 -<tr>
11.5147 - <td>expm1</td> <td>0.0</td>
11.5148 -</tr>
11.5149 -<tr>
11.5150 - <td>floor</td> <td>-any-</td>
11.5151 -</tr>
11.5152 -<tr>
11.5153 - <td>log</td> <td>0.0 or 1.0</td>
11.5154 -</tr>
11.5155 -<tr>
11.5156 - <td>log10</td> <td>0.0 or 1.0</td>
11.5157 -</tr>
11.5158 -<tr>
11.5159 - <td>rint</td> <td>-any-</td>
11.5160 -</tr>
11.5161 -<tr>
11.5162 - <td>round</td> <td>-any-</td>
11.5163 -</tr>
11.5164 -<tr>
11.5165 - <td>sin</td> <td>0.0</td>
11.5166 -</tr>
11.5167 -<tr>
11.5168 - <td>sinh</td> <td>0.0</td>
11.5169 -</tr>
11.5170 -<tr>
11.5171 - <td>sqrt</td> <td>0.0 or 1.0</td>
11.5172 -</tr>
11.5173 -<tr>
11.5174 - <td>tan</td> <td>0.0</td>
11.5175 -</tr>
11.5176 -<tr>
11.5177 - <td>tanh</td> <td>0.0</td>
11.5178 -</tr>
11.5179 -<tr>
11.5180 - <td>toDegrees</td> <td>0.0 or 1.0</td>
11.5181 -</tr>
11.5182 -<tr>
11.5183 - <td>toRadians</td> <td>0.0</td>
11.5184 -</tr>
11.5185 -</table>
11.5186 -]]>
11.5187 - </Details>
11.5188 - </BugPattern>
11.5189 -
11.5190 - <BugPattern type="CD_CIRCULAR_DEPENDENCY">
11.5191 - <ShortDescription>Test for circular dependencies among classes</ShortDescription>
11.5192 - <LongDescription>Class {0} has a circular dependency with other classes</LongDescription>
11.5193 - <Details>
11.5194 - <![CDATA[
11.5195 - <p>
11.5196 - This class has a circular dependency with other classes. This makes building these classes
11.5197 - difficult, as each is dependent on the other to build correctly. Consider using interfaces
11.5198 - to break the hard dependency.
11.5199 - </p>
11.5200 - ]]>
11.5201 - </Details>
11.5202 - </BugPattern>
11.5203 -
11.5204 - <BugPattern type="RI_REDUNDANT_INTERFACES">
11.5205 - <ShortDescription>Class implements same interface as superclass</ShortDescription>
11.5206 - <LongDescription>Class {0} implements same interface as superclass</LongDescription>
11.5207 - <Details>
11.5208 - <![CDATA[
11.5209 - <p>
11.5210 - This class declares that it implements an interface that is also implemented by a superclass.
11.5211 - This is redundant, once a superclass implements an interface, all subclasses by default also
11.5212 - implement this interface. It may point out that the inheritance hierarchy has changed since
11.5213 - this class was created, and consideration should be taken into account for the ownership of
11.5214 - the interface's implementation.
11.5215 - </p>
11.5216 - ]]>
11.5217 - </Details>
11.5218 - </BugPattern>
11.5219 -
11.5220 - <BugPattern type="MTIA_SUSPECT_STRUTS_INSTANCE_FIELD">
11.5221 - <ShortDescription>Class extends Struts Action class and uses instance variables</ShortDescription>
11.5222 - <LongDescription>Class {0} extends Struts Action class and uses instance variables</LongDescription>
11.5223 - <Details>
11.5224 - <![CDATA[
11.5225 - <p>
11.5226 - This class extends from a Struts Action class, and uses a instance member variable. Since only
11.5227 - one instance of a struts Action class is created by the Struts framework, and used in a
11.5228 - multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
11.5229 - only using method local variables.
11.5230 - </p>
11.5231 - ]]>
11.5232 - </Details>
11.5233 - </BugPattern>
11.5234 -
11.5235 - <BugPattern type="MTIA_SUSPECT_SERVLET_INSTANCE_FIELD">
11.5236 - <ShortDescription>Class extends Servlet class and uses instance variables</ShortDescription>
11.5237 - <LongDescription>Class {0} extends Servlet class and uses instance variables</LongDescription>
11.5238 - <Details>
11.5239 - <![CDATA[
11.5240 - <p>
11.5241 - This class extends from a Servlet class, and uses a instance member variable. Since only
11.5242 - one instance of a Servlet class is created by the J2EE framework, and used in a
11.5243 - multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
11.5244 - only using method local variables.
11.5245 - </p>
11.5246 - ]]>
11.5247 - </Details>
11.5248 - </BugPattern>
11.5249 -
11.5250 - <BugPattern type="PS_PUBLIC_SEMAPHORES">
11.5251 - <ShortDescription>Class exposes synchronization and semaphores in its public interface</ShortDescription>
11.5252 - <LongDescription>Class {0} exposes synchronization and semaphores in its public interface</LongDescription>
11.5253 - <Details>
11.5254 - <![CDATA[
11.5255 - <p>
11.5256 - This class uses synchronization along with wait(), notify() or notifyAll() on itself (the this
11.5257 - reference). Client classes that use this class, may, in addition, use an instance of this class
11.5258 - as a synchronizing object. Because two classes are using the same object for synchronization,
11.5259 - Multithread correctness is suspect. You should not synchronize nor call semaphore methods on
11.5260 - a public reference. Consider using a internal private member variable to control synchronization.
11.5261 - </p>
11.5262 - ]]>
11.5263 - </Details>
11.5264 - </BugPattern>
11.5265 -
11.5266 - <BugPattern type="ICAST_INTEGER_MULTIPLY_CAST_TO_LONG">
11.5267 - <ShortDescription>Result of integer multiplication cast to long</ShortDescription>
11.5268 - <LongDescription>Result of integer multiplication cast to long in {1}</LongDescription>
11.5269 - <Details>
11.5270 -<![CDATA[
11.5271 -<p>
11.5272 -This code performs integer multiply and then converts the result to a long,
11.5273 -as in:
11.5274 -<code>
11.5275 -<pre>
11.5276 - long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }
11.5277 -</pre></code>
11.5278 -If the multiplication is done using long arithmetic, you can avoid
11.5279 -the possibility that the result will overflow. For example, you
11.5280 -could fix the above code to:
11.5281 -<code>
11.5282 -<pre>
11.5283 - long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; }
11.5284 -</pre></code>
11.5285 -or
11.5286 -<code>
11.5287 -<pre>
11.5288 - static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
11.5289 - long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; }
11.5290 -</pre></code>
11.5291 -</p>
11.5292 -
11.5293 -]]>
11.5294 - </Details>
11.5295 - </BugPattern>
11.5296 -
11.5297 - <BugPattern type="ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND">
11.5298 - <ShortDescription>int value cast to float and then passed to Math.round</ShortDescription>
11.5299 - <LongDescription>int value cast to float and then passed to Math.round in {1}</LongDescription>
11.5300 - <Details>
11.5301 -<![CDATA[
11.5302 -<p>
11.5303 -This code converts an int value to a float precision
11.5304 -floating point number and then
11.5305 -passing the result to the Math.round() function, which returns the int/long closest
11.5306 -to the argument. This operation should always be a no-op,
11.5307 -since the converting an integer to a float should give a number with no fractional part.
11.5308 -It is likely that the operation that generated the value to be passed
11.5309 -to Math.round was intended to be performed using
11.5310 -floating point arithmetic.
11.5311 -</p>
11.5312 -
11.5313 -]]>
11.5314 - </Details>
11.5315 - </BugPattern>
11.5316 -
11.5317 - <BugPattern type="ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL">
11.5318 - <ShortDescription>int value cast to double and then passed to Math.ceil</ShortDescription>
11.5319 - <LongDescription>int value cast to double and then passed to Math.ceil in {1}</LongDescription>
11.5320 - <Details>
11.5321 -<![CDATA[
11.5322 -<p>
11.5323 -This code converts an int value to a double precision
11.5324 -floating point number and then
11.5325 -passing the result to the Math.ceil() function, which rounds a double to
11.5326 -the next higher integer value. This operation should always be a no-op,
11.5327 -since the converting an integer to a double should give a number with no fractional part.
11.5328 -It is likely that the operation that generated the value to be passed
11.5329 -to Math.ceil was intended to be performed using double precision
11.5330 -floating point arithmetic.
11.5331 -</p>
11.5332 -
11.5333 -]]>
11.5334 - </Details>
11.5335 - </BugPattern>
11.5336 -
11.5337 - <BugPattern type="ICAST_IDIV_CAST_TO_DOUBLE">
11.5338 - <ShortDescription>int division result cast to double or float</ShortDescription>
11.5339 - <LongDescription>int division result cast to double or float in {1}</LongDescription>
11.5340 - <Details>
11.5341 -<![CDATA[
11.5342 -<p>
11.5343 -This code casts the result of an integer division operation to double or
11.5344 -float.
11.5345 -Doing division on integers truncates the result
11.5346 -to the integer value closest to zero. The fact that the result
11.5347 -was cast to double suggests that this precision should have been retained.
11.5348 -What was probably meant was to cast one or both of the operands to
11.5349 -double <em>before</em> performing the division. Here is an example:
11.5350 -</p>
11.5351 -<blockquote>
11.5352 -<pre>
11.5353 -int x = 2;
11.5354 -int y = 5;
11.5355 -// Wrong: yields result 0.0
11.5356 -double value1 = x / y;
11.5357 -
11.5358 -// Right: yields result 0.4
11.5359 -double value2 = x / (double) y;
11.5360 -</pre>
11.5361 -</blockquote>
11.5362 -]]>
11.5363 - </Details>
11.5364 - </BugPattern>
11.5365 -
11.5366 - <BugPattern type="J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION">
11.5367 - <ShortDescription>Store of non serializable object into HttpSession</ShortDescription>
11.5368 - <LongDescription>Store of non serializable {2} into HttpSession in {1}</LongDescription>
11.5369 - <Details>
11.5370 -<![CDATA[
11.5371 -<p>
11.5372 -This code seems to be storing a non-serializable object into an HttpSession.
11.5373 -If this session is passivated or migrated, an error will result.
11.5374 -</p>
11.5375 -]]>
11.5376 - </Details>
11.5377 - </BugPattern>
11.5378 - <BugPattern type="DMI_NONSERIALIZABLE_OBJECT_WRITTEN">
11.5379 - <ShortDescription>Non serializable object written to ObjectOutput</ShortDescription>
11.5380 - <LongDescription>Non serializable {2} written to ObjectOutput in {1}</LongDescription>
11.5381 - <Details>
11.5382 -<![CDATA[
11.5383 -<p>
11.5384 -This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method.
11.5385 -If the object is, indeed, non-serializable, an error will result.
11.5386 -</p>
11.5387 -]]>
11.5388 - </Details>
11.5389 - </BugPattern>
11.5390 -
11.5391 -
11.5392 - <BugPattern type="VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG">
11.5393 - <ShortDescription>Primitive array passed to function expecting a variable number of object arguments</ShortDescription>
11.5394 - <LongDescription>{2} passed to varargs method {3} in {1}</LongDescription>
11.5395 - <Details>
11.5396 -<![CDATA[
11.5397 -<p>
11.5398 -This code passes a primitive array to a function that takes a variable number of object arguments.
11.5399 -This creates an array of length one to hold the primitive array and passes it to the function.
11.5400 -</p>
11.5401 -]]>
11.5402 - </Details>
11.5403 - </BugPattern>
11.5404 - <BugPattern type="BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS">
11.5405 - <ShortDescription>Equals method should not assume anything about the type of its argument</ShortDescription>
11.5406 - <LongDescription>Equals method for {0} assumes the argument is of type {0.givenClass}</LongDescription>
11.5407 - <Details>
11.5408 -<![CDATA[
11.5409 -<p>
11.5410 -The <code>equals(Object o)</code> method shouldn't make any assumptions
11.5411 -about the type of <code>o</code>. It should simply return
11.5412 -false if <code>o</code> is not the same type as <code>this</code>.
11.5413 -</p>
11.5414 -]]>
11.5415 - </Details>
11.5416 - </BugPattern>
11.5417 -
11.5418 - <BugPattern type="BC_BAD_CAST_TO_ABSTRACT_COLLECTION">
11.5419 - <ShortDescription>Questionable cast to abstract collection </ShortDescription>
11.5420 - <LongDescription>Questionable cast from Collection to abstract class {3} in {1}</LongDescription>
11.5421 - <Details>
11.5422 -<![CDATA[
11.5423 -<p>
11.5424 -This code casts a Collection to an abstract collection
11.5425 -(such as <code>List</code>, <code>Set</code>, or <code>Map</code>).
11.5426 -Ensure that you are guaranteed that the object is of the type
11.5427 -you are casting to. If all you need is to be able
11.5428 -to iterate through a collection, you don't need to cast it to a Set or List.
11.5429 -</p>
11.5430 -]]>
11.5431 - </Details>
11.5432 - </BugPattern>
11.5433 -
11.5434 -
11.5435 -
11.5436 - <BugPattern type="BC_IMPOSSIBLE_CAST_PRIMITIVE_ARRAY">
11.5437 - <ShortDescription>Impossible cast involving primitive array</ShortDescription>
11.5438 - <LongDescription>Impossible cast involving primitive array in {1}</LongDescription>
11.5439 - <Details>
11.5440 -<![CDATA[
11.5441 -<p>
11.5442 -This cast will always throw a ClassCastException.
11.5443 -</p>
11.5444 -]]>
11.5445 - </Details>
11.5446 - </BugPattern>
11.5447 -
11.5448 - <BugPattern type="BC_IMPOSSIBLE_CAST">
11.5449 - <ShortDescription>Impossible cast</ShortDescription>
11.5450 - <LongDescription>Impossible cast from {2} to {3} in {1}</LongDescription>
11.5451 - <Details>
11.5452 -<![CDATA[
11.5453 -<p>
11.5454 -This cast will always throw a ClassCastException.
11.5455 -</p>
11.5456 -]]>
11.5457 - </Details>
11.5458 - </BugPattern>
11.5459 -
11.5460 - <BugPattern type="NP_NULL_INSTANCEOF">
11.5461 - <ShortDescription>A known null value is checked to see if it is an instance of a type</ShortDescription>
11.5462 - <LongDescription>A known null value is checked to see if it is an instance of {2} in {1}</LongDescription>
11.5463 - <Details>
11.5464 -<![CDATA[
11.5465 -<p>
11.5466 -This instanceof test will always return false, since the value being checked is guaranteed to be null.
11.5467 -Although this is safe, make sure it isn't
11.5468 -an indication of some misunderstanding or some other logic error.
11.5469 -</p>
11.5470 -]]>
11.5471 - </Details>
11.5472 - </BugPattern>
11.5473 - <BugPattern type="BC_NULL_INSTANCEOF" deprecated="true"> <!-- deprecated in favor of NP_NULL_INSTANCEOF -->
11.5474 - <ShortDescription>A known null value is checked to see if it is an instance of a type</ShortDescription>
11.5475 - <LongDescription>A known null value is checked to see if it is an instance of {2} in {1}</LongDescription>
11.5476 - <Details>
11.5477 -<![CDATA[
11.5478 -<p>
11.5479 -This instanceof test will always return false, since the value being checked is guaranteed to be null.
11.5480 -Although this is safe, make sure it isn't
11.5481 -an indication of some misunderstanding or some other logic error.
11.5482 -</p>
11.5483 -]]>
11.5484 - </Details>
11.5485 - </BugPattern>
11.5486 -
11.5487 - <BugPattern type="BC_IMPOSSIBLE_INSTANCEOF">
11.5488 - <ShortDescription>instanceof will always return false</ShortDescription>
11.5489 - <LongDescription>instanceof will always return false in {1}, since a {2} can't be a {3}</LongDescription>
11.5490 - <Details>
11.5491 -<![CDATA[
11.5492 -<p>
11.5493 -This instanceof test will always return false. Although this is safe, make sure it isn't
11.5494 -an indication of some misunderstanding or some other logic error.
11.5495 -</p>
11.5496 -]]>
11.5497 - </Details>
11.5498 - </BugPattern>
11.5499 -
11.5500 -
11.5501 - <BugPattern type="BC_VACUOUS_INSTANCEOF">
11.5502 - <ShortDescription>instanceof will always return true</ShortDescription>
11.5503 - <LongDescription>instanceof will always return true in {1}, since all {2} are instances of {3}</LongDescription>
11.5504 - <Details>
11.5505 -<![CDATA[
11.5506 -<p>
11.5507 -This instanceof test will always return true. Although this is safe, make sure it isn't
11.5508 -an indication of some misunderstanding or some other logic error.
11.5509 -</p>
11.5510 -]]>
11.5511 - </Details>
11.5512 - </BugPattern>
11.5513 -
11.5514 -
11.5515 -
11.5516 - <BugPattern type="BC_UNCONFIRMED_CAST">
11.5517 - <ShortDescription>Unchecked/unconfirmed cast</ShortDescription>
11.5518 - <LongDescription>Unchecked/unconfirmed cast from {2} to {3} in {1}</LongDescription>
11.5519 - <Details>
11.5520 -<![CDATA[
11.5521 -<p>
11.5522 -This cast is unchecked, and not all instances of the type casted from can be cast to
11.5523 -the type it is being cast to. Ensure that your program logic ensures that this
11.5524 -cast will not fail.
11.5525 -</p>
11.5526 -]]>
11.5527 - </Details>
11.5528 - </BugPattern>
11.5529 - <BugPattern type="BC_BAD_CAST_TO_CONCRETE_COLLECTION">
11.5530 - <ShortDescription>Questionable cast to concrete collection</ShortDescription>
11.5531 - <LongDescription>Questionable cast from {2} to {3} in {1}</LongDescription>
11.5532 - <Details>
11.5533 -<![CDATA[
11.5534 -<p>
11.5535 -This code casts an abstract collection (such as a Collection, List, or Set)
11.5536 -to a specific concrete implementation (such as an ArrayList or HashSet).
11.5537 -This might not be correct, and it may make your code fragile, since
11.5538 -it makes it harder to switch to other concrete implementations at a future
11.5539 -point. Unless you have a particular reason to do so, just use the abstract
11.5540 -collection class.
11.5541 -</p>
11.5542 -]]>
11.5543 - </Details>
11.5544 - </BugPattern>
11.5545 -
11.5546 - <BugPattern type="RE_POSSIBLE_UNINTENDED_PATTERN">
11.5547 - <ShortDescription>"." used for regular expression</ShortDescription>
11.5548 - <LongDescription>"." used for regular expression in {1}</LongDescription>
11.5549 - <Details>
11.5550 -<![CDATA[
11.5551 -<p>
11.5552 -A String function is being invoked and "." is being passed
11.5553 -to a parameter that takes a regular expression as an argument. Is this what you intended?
11.5554 -For example
11.5555 -s.replaceAll(".", "/") will return a String in which <em>every</em>
11.5556 -character has been replaced by a / character.
11.5557 -</p>
11.5558 -]]>
11.5559 - </Details>
11.5560 - </BugPattern>
11.5561 - <BugPattern type="RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION">
11.5562 - <ShortDescription>Invalid syntax for regular expression</ShortDescription>
11.5563 - <LongDescription>Invalid syntax for regular expression in {1}</LongDescription>
11.5564 - <Details>
11.5565 -<![CDATA[
11.5566 -<p>
11.5567 -The code here uses a regular expression that is invalid according to the syntax
11.5568 -for regular expressions. This statement will throw a PatternSyntaxException when
11.5569 -executed.
11.5570 -</p>
11.5571 -]]>
11.5572 - </Details>
11.5573 - </BugPattern>
11.5574 - <BugPattern type="RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION">
11.5575 - <ShortDescription>File.separator used for regular expression</ShortDescription>
11.5576 - <LongDescription>File.separator used for regular expression in {1}</LongDescription>
11.5577 - <Details>
11.5578 -<![CDATA[
11.5579 -<p>
11.5580 -The code here uses <code>File.separator</code>
11.5581 -where a regular expression is required. This will fail on Windows
11.5582 -platforms, where the <code>File.separator</code> is a backslash, which is interpreted in a
11.5583 -regular expression as an escape character. Amoung other options, you can just use
11.5584 -<code>File.separatorChar=='\\' & "\\\\" : File.separator</code> instead of
11.5585 -<code>File.separator</code>
11.5586 -
11.5587 -</p>
11.5588 -]]>
11.5589 - </Details>
11.5590 - </BugPattern>
11.5591 -
11.5592 -
11.5593 -
11.5594 - <BugPattern type="DLS_OVERWRITTEN_INCREMENT">
11.5595 - <ShortDescription>Overwritten increment</ShortDescription>
11.5596 - <LongDescription>Overwritten increment in {1}</LongDescription>
11.5597 - <Details>
11.5598 -<![CDATA[
11.5599 -<p>
11.5600 -The code performs an increment operation (e.g., <code>i++</code>) and then
11.5601 -immediately overwrites it. For example, <code>i = i++</code> immediately
11.5602 -overwrites the incremented value with the original value.
11.5603 -</p>
11.5604 -]]>
11.5605 - </Details>
11.5606 - </BugPattern>
11.5607 - <BugPattern type="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT">
11.5608 - <ShortDescription>Unsigned right shift cast to short/byte</ShortDescription>
11.5609 - <LongDescription>Unsigned right shift cast to short/byte in {1}</LongDescription>
11.5610 - <Details>
11.5611 -<![CDATA[
11.5612 -<p>
11.5613 -The code performs an unsigned right shift, whose result is then
11.5614 -cast to a short or byte, which discards the upper bits of the result.
11.5615 -Since the upper bits are discarded, there may be no difference between
11.5616 -a signed and unsigned right shift (depending upon the size of the shift).
11.5617 -</p>
11.5618 -]]>
11.5619 - </Details>
11.5620 - </BugPattern>
11.5621 - <BugPattern type="ICAST_BAD_SHIFT_AMOUNT">
11.5622 - <ShortDescription>Integer shift by an amount not in the range 0..31</ShortDescription>
11.5623 - <LongDescription>Integer shift by {2} in {1}</LongDescription>
11.5624 - <Details>
11.5625 -<![CDATA[
11.5626 -<p>
11.5627 -The code performs an integer shift by a constant amount outside
11.5628 -the range 0..31.
11.5629 -The effect of this is to use the lower 5 bits of the integer
11.5630 -value to decide how much to shift by. This probably isn't want was expected,
11.5631 -and it at least confusing.
11.5632 -</p>
11.5633 -]]>
11.5634 - </Details>
11.5635 - </BugPattern>
11.5636 - <BugPattern type="IM_MULTIPLYING_RESULT_OF_IREM">
11.5637 - <ShortDescription>Integer multiply of result of integer remainder</ShortDescription>
11.5638 - <LongDescription>Integer multiple of result of integer remainder in {1}</LongDescription>
11.5639 - <Details>
11.5640 -<![CDATA[
11.5641 -<p>
11.5642 -The code multiplies the result of an integer remaining by an integer constant.
11.5643 -Be sure you don't have your operator precedence confused. For example
11.5644 -i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000).
11.5645 -</p>
11.5646 -]]>
11.5647 - </Details>
11.5648 - </BugPattern>
11.5649 -
11.5650 -
11.5651 - <BugPattern type="DMI_INVOKING_TOSTRING_ON_ARRAY">
11.5652 - <ShortDescription>Invocation of toString on an array</ShortDescription>
11.5653 - <LongDescription>Invocation of toString on an array in {1}</LongDescription>
11.5654 - <Details>
11.5655 -<![CDATA[
11.5656 -<p>
11.5657 -The code invokes toString on an array, which will generate a fairly useless result
11.5658 -such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
11.5659 -String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
11.5660 -</p>
11.5661 -]]>
11.5662 - </Details>
11.5663 - </BugPattern>
11.5664 -
11.5665 -
11.5666 - <BugPattern type="IM_AVERAGE_COMPUTATION_COULD_OVERFLOW">
11.5667 - <ShortDescription>Computation of average could overflow</ShortDescription>
11.5668 - <LongDescription>Computation of average could overflow in {1}</LongDescription>
11.5669 - <Details>
11.5670 -<![CDATA[
11.5671 -<p>The code computes the average of two integers using either division or signed right shift,
11.5672 -and then uses the result as the index of an array.
11.5673 -If the values being averaged are very large, this can overflow (resulting in the computation
11.5674 -of a negative average). Assuming that the result is intended to be nonnegative, you
11.5675 -can use an unsigned right shift instead. In other words, rather that using <code>(low+high)/2</code>,
11.5676 -use <code>(low+high) >>> 1</code>
11.5677 -</p>
11.5678 -<p>This bug exists in many earlier implementations of binary search and merge sort.
11.5679 -Martin Buchholz <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6412541">found and fixed it</a>
11.5680 -in the JDK libraries, and Joshua Bloch
11.5681 -<a href="http://googleresearch.blogspot.com/2006/06/extra-extra-read-all-about-it-nearly.html">widely
11.5682 -publicized the bug pattern</a>.
11.5683 -</p>
11.5684 -]]>
11.5685 - </Details>
11.5686 - </BugPattern>
11.5687 -
11.5688 -
11.5689 -
11.5690 - <BugPattern type="IM_BAD_CHECK_FOR_ODD">
11.5691 - <ShortDescription>Check for oddness that won't work for negative numbers </ShortDescription>
11.5692 - <LongDescription>Check for oddness that won't work for negative numbers in {1}</LongDescription>
11.5693 - <Details>
11.5694 -<![CDATA[
11.5695 -<p>
11.5696 -The code uses x % 2 == 1 to check to see if a value is odd, but this won't work
11.5697 -for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check
11.5698 -for oddness, consider using x & 1 == 1, or x % 2 != 0.
11.5699 -</p>
11.5700 -]]>
11.5701 - </Details>
11.5702 - </BugPattern>
11.5703 -
11.5704 -
11.5705 -
11.5706 - <BugPattern type="DMI_HARDCODED_ABSOLUTE_FILENAME">
11.5707 - <ShortDescription>Code contains a hard coded reference to an absolute pathname</ShortDescription>
11.5708 - <LongDescription>Hard coded reference to an absolute pathname in {1}</LongDescription>
11.5709 - <Details>
11.5710 -<![CDATA[
11.5711 -<p>This code constructs a File object using a hard coded to an absolute pathname
11.5712 -(e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code>
11.5713 -</p>
11.5714 -]]>
11.5715 - </Details>
11.5716 - </BugPattern>
11.5717 - <BugPattern type="DMI_BAD_MONTH">
11.5718 - <ShortDescription>Bad constant value for month</ShortDescription>
11.5719 - <LongDescription>{1} passes a bad month value of {2} to {3}</LongDescription>
11.5720 - <Details>
11.5721 -<![CDATA[
11.5722 -<p>
11.5723 -This code passes a constant month
11.5724 -value outside the expected range of 0..11 to a method.
11.5725 -</p>
11.5726 -]]>
11.5727 - </Details>
11.5728 - </BugPattern>
11.5729 - <BugPattern type="DMI_USELESS_SUBSTRING">
11.5730 - <ShortDescription>Invocation of substring(0), which returns the original value</ShortDescription>
11.5731 - <LongDescription>{1} invokes substring(0), which returns the original value</LongDescription>
11.5732 - <Details>
11.5733 -<![CDATA[
11.5734 -<p>
11.5735 -This code invokes substring(0) on a String, which returns the original value.
11.5736 -</p>
11.5737 -]]>
11.5738 - </Details>
11.5739 - </BugPattern>
11.5740 - <BugPattern type="DMI_CALLING_NEXT_FROM_HASNEXT">
11.5741 - <ShortDescription>hasNext method invokes next</ShortDescription>
11.5742 - <LongDescription>{1} invokes {3}</LongDescription>
11.5743 - <Details>
11.5744 -<![CDATA[
11.5745 -<p>
11.5746 -The hasNext() method invokes the next() method. This is almost certainly wrong,
11.5747 -since the hasNext() method is not supposed to change the state of the iterator,
11.5748 -and the next method is supposed to change the state of the iterator.
11.5749 -</p>
11.5750 -]]>
11.5751 - </Details>
11.5752 - </BugPattern>
11.5753 -
11.5754 - <BugPattern type="SWL_SLEEP_WITH_LOCK_HELD">
11.5755 - <ShortDescription>Method calls Thread.sleep() with a lock held</ShortDescription>
11.5756 - <LongDescription>{1} calls Thread.sleep() with a lock held</LongDescription>
11.5757 - <Details>
11.5758 - <![CDATA[
11.5759 - <p>
11.5760 - This method calls Thread.sleep() with a lock held. This may result
11.5761 - in very poor performance and scalability, or a deadlock, since other threads may
11.5762 - be waiting to acquire the lock. It is a much better idea to call
11.5763 - wait() on the lock, which releases the lock and allows other threads
11.5764 - to run.
11.5765 - </p>
11.5766 - ]]>
11.5767 - </Details>
11.5768 - </BugPattern>
11.5769 -
11.5770 - <BugPattern type="DB_DUPLICATE_BRANCHES">
11.5771 - <ShortDescription>Method uses the same code for two branches</ShortDescription>
11.5772 - <LongDescription>Method {1} uses the same code for two branches</LongDescription>
11.5773 - <Details>
11.5774 - <![CDATA[
11.5775 - <p>
11.5776 - This method uses the same code to implement two branches of a conditional branch.
11.5777 - Check to ensure that this isn't a coding mistake.
11.5778 - </p>
11.5779 - ]]>
11.5780 - </Details>
11.5781 - </BugPattern>
11.5782 - <BugPattern type="DB_DUPLICATE_SWITCH_CLAUSES">
11.5783 - <ShortDescription>Method uses the same code for two switch clauses</ShortDescription>
11.5784 - <LongDescription>Method {1} uses the same code for two switch clauses</LongDescription>
11.5785 - <Details>
11.5786 - <![CDATA[
11.5787 - <p>
11.5788 - This method uses the same code to implement two clauses of a switch statement.
11.5789 - This could be a case of duplicate code, but it might also indicate
11.5790 - a coding mistake.
11.5791 - </p>
11.5792 - ]]>
11.5793 - </Details>
11.5794 - </BugPattern>
11.5795 -
11.5796 - <BugPattern type="IMA_INEFFICIENT_MEMBER_ACCESS">
11.5797 - <ShortDescription>Method accesses a private member variable of owning class</ShortDescription>
11.5798 - <LongDescription>Method {1} accesses to a private member variable of owning class</LongDescription>
11.5799 - <Details>
11.5800 - <![CDATA[
11.5801 - <p>
11.5802 - This method of an inner class reads from or writes to a private member variable of the owning class,
11.5803 - or calls a private method of the owning class. The compiler must generate a special method to access this
11.5804 - private member, causing this to be less efficient. Relaxing the protection of the member variable or method
11.5805 - will allow the compiler to treat this as a normal access.
11.5806 - </p>
11.5807 - ]]>
11.5808 - </Details>
11.5809 - </BugPattern>
11.5810 -
11.5811 - <BugPattern type="XFB_XML_FACTORY_BYPASS">
11.5812 - <ShortDescription>Method directly allocates a specific implementation of xml interfaces</ShortDescription>
11.5813 - <LongDescription>Method {1} directly allocates a specific implementation of xml interfaces</LongDescription>
11.5814 - <Details>
11.5815 - <![CDATA[
11.5816 - <p>
11.5817 - This method allocates a specific implementation of an xml interface. It is preferable to use
11.5818 - the supplied factory classes to create these objects so that the implementation can be
11.5819 - changed at runtime. See
11.5820 - </p>
11.5821 - <ul>
11.5822 - <li>javax.xml.parsers.DocumentBuilderFactory</li>
11.5823 - <li>javax.xml.parsers.SAXParserFactory</li>
11.5824 - <li>javax.xml.transform.TransformerFactory</li>
11.5825 - <li>org.w3c.dom.Document.create<i>XXXX</i></li>
11.5826 - </ul>
11.5827 - <p>for details.</p>
11.5828 - ]]>
11.5829 - </Details>
11.5830 - </BugPattern>
11.5831 -
11.5832 - <BugPattern type="USM_USELESS_SUBCLASS_METHOD">
11.5833 - <ShortDescription>Method superfluously delegates to parent class method</ShortDescription>
11.5834 - <LongDescription>Method {1} superfluously delegates to parent class method</LongDescription>
11.5835 - <Details>
11.5836 - <![CDATA[
11.5837 - <p>
11.5838 - This derived method merely calls the same superclass method passing in the exact parameters
11.5839 - received. This method can be removed, as it provides no additional value.
11.5840 - </p>
11.5841 - ]]>
11.5842 - </Details>
11.5843 - </BugPattern>
11.5844 -
11.5845 - <BugPattern type="USM_USELESS_ABSTRACT_METHOD">
11.5846 - <ShortDescription>Abstract Method is already defined in implemented interface</ShortDescription>
11.5847 - <LongDescription>Abstract Method {1} is already defined in implemented interface</LongDescription>
11.5848 - <Details>
11.5849 - <![CDATA[
11.5850 - <p>
11.5851 - This abstract method is already defined in an interface that is implemented by this abstract
11.5852 - class. This method can be removed, as it provides no additional value.
11.5853 - </p>
11.5854 - ]]>
11.5855 - </Details>
11.5856 - </BugPattern>
11.5857 -
11.5858 - <BugPattern type="CI_CONFUSED_INHERITANCE">
11.5859 - <ShortDescription>Class is final but declares protected field</ShortDescription>
11.5860 - <LongDescription>Class {0} is final but declares protected field {1}</LongDescription>
11.5861 - <Details>
11.5862 - <![CDATA[
11.5863 - <p>
11.5864 - This class is declared to be final, but declares fields to be protected. Since the class
11.5865 - is final, it can not be derived from, and the use of protected is confusing. The access
11.5866 - modifier for the field should be changed to private or public to represent the true
11.5867 - use for the field.
11.5868 - </p>
11.5869 - ]]>
11.5870 - </Details>
11.5871 - </BugPattern>
11.5872 -
11.5873 - <BugPattern type="QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT">
11.5874 - <ShortDescription>Method assigns boolean literal in boolean expression</ShortDescription>
11.5875 - <LongDescription>Method {1} assigns boolean literal in boolean expression</LongDescription>
11.5876 - <Details>
11.5877 - <![CDATA[
11.5878 - <p>
11.5879 - This method assigns a literal boolean value (true or false) to a boolean variable inside
11.5880 - an if or while expression. Most probably this was supposed to be a boolean comparison using
11.5881 - ==, not an assignment using =.
11.5882 - </p>
11.5883 - ]]>
11.5884 - </Details>
11.5885 - </BugPattern>
11.5886 - <BugPattern type="VR_UNRESOLVABLE_REFERENCE">
11.5887 - <ShortDescription>Class makes reference to unresolvable class or method</ShortDescription>
11.5888 - <LongDescription>Unresolvable reference to {1} by {0}</LongDescription>
11.5889 - <Details>
11.5890 - <![CDATA[
11.5891 - <p>
11.5892 - This class makes a reference to a class or method that can not be
11.5893 - resolved using against the libraries it is being analyzed with.
11.5894 - </p>
11.5895 - ]]>
11.5896 - </Details>
11.5897 - </BugPattern>
11.5898 -
11.5899 - <BugPattern type="GC_UNRELATED_TYPES">
11.5900 - <ShortDescription>No relationship between generic parameter and method argument</ShortDescription>
11.5901 - <LongDescription>{2} is incompatible with expected argument type {3} in {1}</LongDescription>
11.5902 - <Details>
11.5903 - <![CDATA[
11.5904 - <p> This call to a generic container's method contains an argument
11.5905 - with a different class type from that of the container's parameter.
11.5906 - Therefore, it is unlikely that the container contains any objects
11.5907 - with the same type as the method argument used here.
11.5908 - </p>
11.5909 - ]]>
11.5910 - </Details>
11.5911 - </BugPattern>
11.5912 -
11.5913 -<BugPattern type="STCAL_STATIC_CALENDAR_INSTANCE">
11.5914 -<ShortDescription>Static Calendar</ShortDescription>
11.5915 -<LongDescription>Found static field of type java.util.Calendar in {1}</LongDescription>
11.5916 -<Details>
11.5917 -<![CDATA[
11.5918 -<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
11.5919 -Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
11.5920 -application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see
11.5921 -random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().</p>
11.5922 -<p>You may also experience serialization problems.</p>
11.5923 -<p>Using an instance field is recommended.</p>
11.5924 -<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
11.5925 -and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
11.5926 -]]>
11.5927 -</Details>
11.5928 -</BugPattern>
11.5929 -
11.5930 -<BugPattern type="STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE">
11.5931 -<ShortDescription>Call to static Calendar</ShortDescription>
11.5932 -<LongDescription>Call to method of static java.util.Calendar in {1}</LongDescription>
11.5933 -<Details>
11.5934 -<![CDATA[
11.5935 -<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
11.5936 -The detector has found a call to an instance of Calendar that has been obtained via a static
11.5937 -field. This looks suspicous.</p>
11.5938 -<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
11.5939 -and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
11.5940 -]]>
11.5941 -</Details>
11.5942 -</BugPattern>
11.5943 -
11.5944 -
11.5945 -<BugPattern type="STCAL_STATIC_SIMPLE_DATA_FORMAT_INSTANCE">
11.5946 -<ShortDescription>Static DateFormat</ShortDescription>
11.5947 -<LongDescription>Found static field of type java.text.DateFormat in {1}</LongDescription>
11.5948 -<Details>
11.5949 -<![CDATA[
11.5950 -<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
11.5951 -Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
11.5952 -application.</p>
11.5953 -<p>You may also experience serialization problems.</p>
11.5954 -<p>Using an instance field is recommended.</p>
11.5955 -<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
11.5956 -and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
11.5957 -]]>
11.5958 -</Details>
11.5959 -</BugPattern>
11.5960 -
11.5961 -<BugPattern type="STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE">
11.5962 -<ShortDescription>Call to static DateFormat</ShortDescription>
11.5963 -<LongDescription>Call to method of static java.text.DateFormat in {1}</LongDescription>
11.5964 -<Details>
11.5965 -<![CDATA[
11.5966 -<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
11.5967 -The detector has found a call to an instance of DateFormat that has been obtained via a static
11.5968 -field. This looks suspicous.</p>
11.5969 -<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
11.5970 -and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
11.5971 -]]>
11.5972 -</Details>
11.5973 -</BugPattern>
11.5974 -
11.5975 - <!--
11.5976 - **********************************************************************
11.5977 - BugCodes
11.5978 - **********************************************************************
11.5979 - -->
11.5980 -
11.5981 - <BugCode abbrev="IL" >Infinite Loop</BugCode>
11.5982 - <BugCode abbrev="VO" >Use of volatile</BugCode>
11.5983 - <BugCode abbrev="UI" >Unsafe inheritance</BugCode>
11.5984 - <BugCode abbrev="FL" >Use of floating point precision</BugCode>
11.5985 - <BugCode abbrev="TEST" >Testing prototype and incomplete bug pattern</BugCode>
11.5986 - <BugCode abbrev="IMSE" >Dubious catching of IllegalMonitorStateException</BugCode>
11.5987 - <BugCode abbrev="CN" >Bad implementation of cloneable idiom</BugCode>
11.5988 - <BugCode abbrev="AT" >Possible atomicity violation</BugCode>
11.5989 - <BugCode abbrev="FI" >Incorrect use of finalizers</BugCode>
11.5990 - <BugCode abbrev="ES" >Checking String equality using == or !=</BugCode>
11.5991 - <BugCode abbrev="ML" >Synchronization on updated field (Mutable Lock)</BugCode>
11.5992 - <BugCode abbrev="UG" >Unsynchronized get method, synchronized set method</BugCode>
11.5993 - <BugCode abbrev="IC" >Initialization circularity</BugCode>
11.5994 - <BugCode abbrev="SI" >Suspicious static initializer</BugCode>
11.5995 - <BugCode abbrev="IS" >Inconsistent synchronization</BugCode>
11.5996 - <BugCode abbrev="Eq" >Problems with equals()</BugCode>
11.5997 - <BugCode abbrev="Co" >Problems with compareTo()</BugCode>
11.5998 - <BugCode abbrev="HE" >Equal objects must have equal hashcodes</BugCode>
11.5999 - <BugCode abbrev="AM" >API misuse</BugCode>
11.6000 - <BugCode abbrev="Dm" >Dubious method used</BugCode>
11.6001 - <BugCode abbrev="Bx" >Questionable Boxing of primitive value</BugCode>
11.6002 - <BugCode abbrev="UR" >Uninitialized read of field in constructor</BugCode>
11.6003 - <BugCode abbrev="RR" >Method ignores results of InputStream.read()</BugCode>
11.6004 - <BugCode abbrev="NN" >Naked notify</BugCode>
11.6005 - <BugCode abbrev="UW" >Unconditional wait</BugCode>
11.6006 - <BugCode abbrev="SP" >Method spins on field</BugCode>
11.6007 - <BugCode abbrev="DC" >Possible double check of field</BugCode>
11.6008 - <BugCode abbrev="Wa" >Wait not in loop</BugCode>
11.6009 - <BugCode abbrev="No" >Using notify() rather than notifyAll()</BugCode>
11.6010 - <BugCode abbrev="DE" >Dropped or ignored exception</BugCode>
11.6011 - <BugCode abbrev="Ru" >Method invokes run()</BugCode>
11.6012 - <BugCode abbrev="It" >Incorrect definition of Iterator</BugCode>
11.6013 - <BugCode abbrev="SnVI" >Serializable class with no Version ID</BugCode>
11.6014 - <BugCode abbrev="Se" >Incorrect definition of Serializable class</BugCode>
11.6015 - <BugCode abbrev="WS" >Class's writeObject() method is synchronized but nothing else is</BugCode>
11.6016 - <BugCode abbrev="RS" >Class's readObject() method is synchronized</BugCode>
11.6017 - <BugCode abbrev="SC" >Constructor invokes Thread.start()</BugCode>
11.6018 - <BugCode abbrev="MS" >Mutable static field</BugCode>
11.6019 - <BugCode abbrev="EI" >Method returning array may expose internal representation</BugCode>
11.6020 - <BugCode abbrev="Nm" >Confusing method name</BugCode>
11.6021 - <BugCode abbrev="SS" >Unread field should be static</BugCode>
11.6022 - <BugCode abbrev="UuF" >Unused field</BugCode>
11.6023 - <BugCode abbrev="UrF" >Unread field</BugCode>
11.6024 - <BugCode abbrev="UwF" >Unwritten field</BugCode>
11.6025 - <BugCode abbrev="SIC" >Inner class could be made static</BugCode>
11.6026 - <BugCode abbrev="TLW" >Wait with two locks held</BugCode>
11.6027 - <BugCode abbrev="RV" >Bad use of return value from method</BugCode>
11.6028 - <BugCode abbrev="IA" >Ambiguous invocation</BugCode>
11.6029 - <BugCode abbrev="HSC" >Huge String constants</BugCode>
11.6030 - <BugCode abbrev="NP" >Null pointer dereference</BugCode>
11.6031 - <BugCode abbrev="OS">Stream not closed on all paths</BugCode>
11.6032 - <BugCode abbrev="PZLA" >Prefer zero length arrays to null to indicate no results</BugCode>
11.6033 - <BugCode abbrev="UCF">Useless control flow</BugCode>
11.6034 - <BugCode abbrev="RCN">Redundant comparison to null</BugCode>
11.6035 - <BugCode abbrev="UL">Lock not released on all paths</BugCode>
11.6036 - <BugCode abbrev="RC">Suspicious reference comparison</BugCode>
11.6037 - <BugCode abbrev="EC">Suspicious equals() comparison</BugCode>
11.6038 - <BugCode abbrev="MWN">Mismatched wait() or notify()</BugCode>
11.6039 - <BugCode abbrev="SA">Useless self-operation</BugCode>
11.6040 - <BugCode abbrev="INT">Suspicious integer expression</BugCode>
11.6041 - <BugCode abbrev="BIT">Suspicious bitwise logical expression</BugCode>
11.6042 - <BugCode abbrev="LI">Unsynchronized Lazy Initialization</BugCode>
11.6043 - <BugCode abbrev="JLM">Synchronization on JSR166 Lock</BugCode>
11.6044 - <BugCode abbrev="UPM">Private method is never called</BugCode>
11.6045 - <BugCode abbrev="UMAC">Uncallable method of anonymous class</BugCode>
11.6046 - <BugCode abbrev="EI2">Storing reference to mutable object</BugCode>
11.6047 - <BugCode abbrev="NS">Suspicious use of non-short-circuit boolean operator</BugCode>
11.6048 - <BugCode abbrev="ODR">Database resource not closed on all paths</BugCode>
11.6049 - <BugCode abbrev="SBSC">String concatenation in loop using + operator</BugCode>
11.6050 - <BugCode abbrev="ITA">Inefficient use of collection.toArray(new Foo[0])</BugCode>
11.6051 - <BugCode abbrev="SW">Swing coding rules</BugCode>
11.6052 - <BugCode abbrev="IJU">Improperly implemented JUnit TestCase</BugCode>
11.6053 - <BugCode abbrev="BOA">Badly Overridden Adapter</BugCode>
11.6054 - <BugCode abbrev="SF">Switch case falls through</BugCode>
11.6055 - <BugCode abbrev="SIO">Superfluous instanceof</BugCode>
11.6056 - <BugCode abbrev="BAC">Bad Applet Constructor</BugCode>
11.6057 - <BugCode abbrev="UOE">Use Object Equals</BugCode>
11.6058 - <BugCode abbrev="STI">Suspicious Thread Interrupted</BugCode>
11.6059 - <BugCode abbrev="DLS">Dead local store</BugCode>
11.6060 - <BugCode abbrev="IP">Ignored parameter</BugCode>
11.6061 - <BugCode abbrev="MF">Masked Field</BugCode>
11.6062 - <BugCode abbrev="WMI">Wrong Map Iterator</BugCode>
11.6063 - <BugCode abbrev="ISC">Instantiated Static Class</BugCode>
11.6064 - <BugCode abbrev="REC">RuntimeException capture</BugCode>
11.6065 - <BugCode abbrev="FE">Test for floating point equality</BugCode>
11.6066 - <BugCode abbrev="UM">Unnecessary Math on constants</BugCode>
11.6067 - <BugCode abbrev="CD">Circular Dependencies</BugCode>
11.6068 - <BugCode abbrev="RI">Redundant Interfaces</BugCode>
11.6069 - <BugCode abbrev="MTIA">Multithreaded Instance Access</BugCode>
11.6070 - <BugCode abbrev="PS">Public Semaphores</BugCode>
11.6071 - <BugCode abbrev="ICAST">Casting from integer values</BugCode>
11.6072 - <BugCode abbrev="RE">Regular expressions</BugCode>
11.6073 - <BugCode abbrev="SQL">SQL Problem</BugCode>
11.6074 - <BugCode abbrev="ESync">Empty Synchronized blocks</BugCode>
11.6075 - <BugCode abbrev="QF">Questionable for loops</BugCode>
11.6076 - <BugCode abbrev="VA">Var arg problems</BugCode>
11.6077 - <BugCode abbrev="BC">Bad casts of object references</BugCode>
11.6078 - <BugCode abbrev="IM">Questionable integer math</BugCode>
11.6079 - <BugCode abbrev="ST">Misuse of static fields</BugCode>
11.6080 - <BugCode abbrev="JCIP">Violation of net.jcip annotations</BugCode>
11.6081 - <BugCode abbrev="DMI">Dubious method invocation</BugCode>
11.6082 - <BugCode abbrev="PZ">Warning inspired by Josh Bloch's and Neal Gafter's Programming Puzzlers</BugCode>
11.6083 - <BugCode abbrev="SWL">Sleep with lock held</BugCode>
11.6084 - <BugCode abbrev="J2EE">J2EE error</BugCode>
11.6085 - <BugCode abbrev="DB">Duplicate Branches</BugCode>
11.6086 - <BugCode abbrev="IMA">Inefficient Member Access</BugCode>
11.6087 - <BugCode abbrev="XFB">XML Factory Bypass</BugCode>
11.6088 - <BugCode abbrev="USM">Useless Subclass Method</BugCode>
11.6089 - <BugCode abbrev="CI">Confused Inheritance</BugCode>
11.6090 - <BugCode abbrev="QBA">Questionable Boolean Assignment</BugCode>
11.6091 - <BugCode abbrev="VR">Version compatibility issue</BugCode>
11.6092 - <BugCode abbrev="DP">Use doPrivileged</BugCode>
11.6093 - <BugCode abbrev="GC">Suspicious calls to generic container methods</BugCode>
11.6094 - <BugCode abbrev="STCAL">Static use of type Calendar or DateFormat</BugCode>
11.6095 - </MessageCollection>
11.6096 -
11.6097 -
11.6098 -
12.1 --- a/hudsonfindbugs/src/org/netbeans/modules/hudsonfindbugs/spi/FindBugsQueryImplementation.java Sat Aug 10 14:03:03 2013 +0200
12.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
12.3 @@ -1,68 +0,0 @@
12.4 -/*
12.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
12.6 - *
12.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
12.8 - *
12.9 - * The contents of this file are subject to the terms of either the GNU
12.10 - * General Public License Version 2 only ("GPL") or the Common
12.11 - * Development and Distribution License("CDDL") (collectively, the
12.12 - * "License"). You may not use this file except in compliance with the
12.13 - * License. You can obtain a copy of the License at
12.14 - * http://www.netbeans.org/cddl-gplv2.html
12.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
12.16 - * specific language governing permissions and limitations under the
12.17 - * License. When distributing the software, include this License Header
12.18 - * Notice in each file and include the License file at
12.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
12.20 - * particular file as subject to the "Classpath" exception as provided
12.21 - * by Sun in the GPL Version 2 section of the License file that
12.22 - * accompanied this code. If applicable, add the following below the
12.23 - * License Header, with the fields enclosed by brackets [] replaced by
12.24 - * your own identifying information:
12.25 - * "Portions Copyrighted [year] [name of copyright owner]"
12.26 - *
12.27 - * Contributor(s):
12.28 - *
12.29 - * The Original Software is NetBeans. The Initial Developer of the Original
12.30 - * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
12.31 - * Microsystems, Inc. All Rights Reserved.
12.32 - *
12.33 - * If you wish your version of this file to be governed by only the CDDL
12.34 - * or only the GPL Version 2, indicate your decision by adding
12.35 - * "[Contributor] elects to include this software in this distribution
12.36 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
12.37 - * single choice of license, a recipient has the option to distribute
12.38 - * your version of this file under either the CDDL, the GPL Version 2 or
12.39 - * to extend the choice of license to its licensees as provided above.
12.40 - * However, if you add GPL Version 2 code and therefore, elected the GPL
12.41 - * Version 2 license, then the option applies only if the new code is
12.42 - * made subject to such option by the copyright holder.
12.43 - */
12.44 -
12.45 -package org.netbeans.modules.hudsonfindbugs.spi;
12.46 -
12.47 -import java.net.URL;
12.48 -import org.netbeans.api.annotations.common.CheckForNull;
12.49 -
12.50 -/**
12.51 - * Implementations provide URLs for remote or local findbugs results for a specific projects. To be used by
12.52 - * HudsonFindBugs plugin or potentially some other FBugs plugins as well.
12.53 - *
12.54 - * @author Martin Grebac
12.55 - */
12.56 -public interface FindBugsQueryImplementation {
12.57 -
12.58 - /**
12.59 - * Recommended (not mandatory) property to store the url in the project.
12.60 - */
12.61 - public static final String FINDBUGS_PROJECT_PROPERTY = "findbugs.url";
12.62 -
12.63 - /**
12.64 - * @param remote whether to return local or remotely located file url
12.65 - * @return URL for the findbugs results file on remote server if remote is true, otherwise local location;
12.66 - * If the resource doesn't exist, return null
12.67 - */
12.68 - @CheckForNull
12.69 - URL getFindBugsUrl(boolean remote);
12.70 -
12.71 -}
13.1 --- a/hudsonfindbugs/test/unit/src/org/netbeans/modules/hudsonfindbugs/FindBugsTaskScannerTest.java Sat Aug 10 14:03:03 2013 +0200
13.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
13.3 @@ -1,109 +0,0 @@
13.4 -/*
13.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
13.6 - *
13.7 - * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
13.8 - *
13.9 - * The contents of this file are subject to the terms of either the GNU
13.10 - * General Public License Version 2 only ("GPL") or the Common
13.11 - * Development and Distribution License("CDDL") (collectively, the
13.12 - * "License"). You may not use this file except in compliance with the
13.13 - * License. You can obtain a copy of the License at
13.14 - * http://www.netbeans.org/cddl-gplv2.html
13.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13.16 - * specific language governing permissions and limitations under the
13.17 - * License. When distributing the software, include this License Header
13.18 - * Notice in each file and include the License file at
13.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
13.20 - * particular file as subject to the "Classpath" exception as provided
13.21 - * by Sun in the GPL Version 2 section of the License file that
13.22 - * accompanied this code. If applicable, add the following below the
13.23 - * License Header, with the fields enclosed by brackets [] replaced by
13.24 - * your own identifying information:
13.25 - * "Portions Copyrighted [year] [name of copyright owner]"
13.26 - *
13.27 - * If you wish your version of this file to be governed by only the CDDL
13.28 - * or only the GPL Version 2, indicate your decision by adding
13.29 - * "[Contributor] elects to include this software in this distribution
13.30 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
13.31 - * single choice of license, a recipient has the option to distribute
13.32 - * your version of this file under either the CDDL, the GPL Version 2 or
13.33 - * to extend the choice of license to its licensees as provided above.
13.34 - * However, if you add GPL Version 2 code and therefore, elected the GPL
13.35 - * Version 2 license, then the option applies only if the new code is
13.36 - * made subject to such option by the copyright holder.
13.37 - *
13.38 - * Contributor(s):
13.39 - *
13.40 - * Portions Copyrighted 2007 Sun Microsystems, Inc.
13.41 - */
13.42 -
13.43 -package org.netbeans.modules.hudsonfindbugs;
13.44 -
13.45 -import java.net.URL;
13.46 -import java.util.HashMap;
13.47 -import java.util.List;
13.48 -import java.util.Map;
13.49 -import org.netbeans.junit.NbTestCase;
13.50 -import org.netbeans.spi.tasklist.Task;
13.51 -import org.openide.filesystems.FileObject;
13.52 -import org.openide.filesystems.FileUtil;
13.53 -import org.openide.filesystems.LocalFileSystem;
13.54 -
13.55 -/**
13.56 - *
13.57 - * @author Jaroslav Tulach <jtulach@netbeans.org>
13.58 - */
13.59 -public class FindBugsTaskScannerTest extends NbTestCase {
13.60 - FileObject root;
13.61 - FindBugsTaskScanner scan;
13.62 -
13.63 - public FindBugsTaskScannerTest(String testName) {
13.64 - super(testName);
13.65 - }
13.66 -
13.67 - @Override
13.68 - protected void setUp() throws Exception {
13.69 - clearWorkDir();
13.70 -
13.71 - URL url = getClass().getResource("err.xml");
13.72 - String ext = url.toExternalForm();
13.73 - int last = ext.lastIndexOf('/');
13.74 -
13.75 - url = new URL(ext.substring(0, last + 1));
13.76 - scan = new FindBugsTaskScanner();
13.77 -
13.78 - LocalFileSystem lfs = new LocalFileSystem();
13.79 - lfs.setRootDirectory(getWorkDir());
13.80 - root = lfs.getRoot();
13.81 - }
13.82 -
13.83 - @Override
13.84 - protected void tearDown() throws Exception {
13.85 - super.tearDown();
13.86 - }
13.87 -
13.88 - public void testParseXML() throws Exception {
13.89 - Map<FileObject,List<Task>> map = new HashMap<FileObject, List<Task>>();
13.90 - FileObject fo = FileUtil.createFolder(root, "openide/util/enum");
13.91 - FileObject arrayEnumeration = FileUtil.createData(fo, "src/org/openide/util/enum/ArrayEnumeration.java");
13.92 -
13.93 - URL url = this.getClass().getClassLoader().getResource("org/netbeans/modules/hudsonfindbugs/err.xml");
13.94 - scan.parse(url, fo, map);
13.95 - assertEquals("One file", 1, map.size());
13.96 - List<Task> arr = map.get(arrayEnumeration);
13.97 - assertNotNull("This fileobject has the tasks", arr);
13.98 - assertEquals("Two bugs", 2, arr.size());
13.99 -
13.100 - Task t = arr.get(0);
13.101 - String expMsg = "May expose internal representation by incorporating reference to mutable object";
13.102 - if (!t.equals(Task.create(arrayEnumeration, "warning", expMsg, 63))) {
13.103 - fail("Task is wrong: " + t);
13.104 - }
13.105 -
13.106 - t = arr.get(1);
13.107 - if (!t.equals(Task.create(arrayEnumeration, "warning", expMsg, 5))) {
13.108 - fail("Task is wrong: " + t);
13.109 - }
13.110 - }
13.111 -
13.112 -}
14.1 --- a/hudsonfindbugs/test/unit/src/org/netbeans/modules/hudsonfindbugs/err.xml Sat Aug 10 14:03:03 2013 +0200
14.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
14.3 @@ -1,48 +0,0 @@
14.4 -<?xml version="1.0" encoding="UTF-8"?>
14.5 -
14.6 -<BugCollection version="1.2.1" sequence="0" timestamp="1193024196986" analysisTimestamp="1193024198318" release="">
14.7 - <Project filename="<<unnamed project>>" projectName="">
14.8 - <Jar>/hudson/workdir/jobs/FindBugs/workspace/openide/util/enum/build/classes</Jar>
14.9 - <AuxClasspathEntry>/hudson/workdir/jobs/FindBugs/workspace/nbbuild/netbeans/platform7/modules/org-openide-util-enumerations.jar</AuxClasspathEntry>
14.10 - <SrcDir>/hudson/workdir/jobs/FindBugs/workspace/openide/util/enum/src</SrcDir>
14.11 - </Project>
14.12 - <BugInstance type="EI_EXPOSE_REP2" priority="2" abbrev="EI2" category="MALICIOUS_CODE">
14.13 - <Class classname="org.openide.util.enum.ArrayEnumeration">
14.14 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" start="59" end="82" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.15 - </Class>
14.16 - <Method classname="org.openide.util.enum.ArrayEnumeration" name="<init>" signature="([Ljava/lang/Object;)V" isStatic="false">
14.17 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" start="62" end="64" startBytecode="0" endBytecode="78" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.18 - </Method>
14.19 - <Field classname="org.openide.util.enum.ArrayEnumeration" name="array" signature="[Ljava/lang/Object;" isStatic="true">
14.20 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.21 - </Field>
14.22 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" start="63" end="63" startBytecode="11" endBytecode="11" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.23 - </BugInstance>
14.24 - <BugInstance type="EI_EXPOSE_REP2" priority="2" abbrev="EI2" category="MALICIOUS_CODE">
14.25 - <Class classname="org.openide.util.enum.ArrayEnumeration">
14.26 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" start="5" end="10" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.27 - </Class>
14.28 - <Method classname="org.openide.util.enum.ArrayEnumeration" name="<init>" signature="([Ljava/lang/Object;)V" isStatic="false">
14.29 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" start="5" end="8" startBytecode="0" endBytecode="78" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.30 - </Method>
14.31 - <Field classname="org.openide.util.enum.ArrayEnumeration" name="array" signature="[Ljava/lang/Object;" isStatic="true">
14.32 - <SourceLine classname="org.openide.util.enum.ArrayEnumeration" sourcefile="ArrayEnumeration.java" sourcepath="org/openide/util/enum/ArrayEnumeration.java"/>
14.33 - </Field>
14.34 - </BugInstance>
14.35 - <Errors></Errors>
14.36 - <FindBugsSummary timestamp="Mon, 22 Oct 2007 03:36:36 +0000" total_classes="9" total_bugs="1" total_size="156" num_packages="1" cpu_seconds="1.46" clock_seconds="1.76" peak_mbytes="81.00" gc_seconds="0.03" priority_2="1">
14.37 - <PackageStats package="org.openide.util.enum" total_bugs="1" total_types="9" total_size="156" priority_2="1">
14.38 - <ClassStats class="org.openide.util.enum.AlterEnumeration" sourceFile="AlterEnumeration.java" interface="false" size="11" bugs="0"/>
14.39 - <ClassStats class="org.openide.util.enum.ArrayEnumeration" sourceFile="ArrayEnumeration.java" interface="false" size="14" bugs="1" priority_2="1"/>
14.40 - <ClassStats class="org.openide.util.enum.EmptyEnumeration" sourceFile="EmptyEnumeration.java" interface="false" size="10" bugs="0"/>
14.41 - <ClassStats class="org.openide.util.enum.FilterEnumeration" sourceFile="FilterEnumeration.java" interface="false" size="28" bugs="0"/>
14.42 - <ClassStats class="org.openide.util.enum.QueueEnumeration" sourceFile="QueueEnumeration.java" interface="false" size="32" bugs="0"/>
14.43 - <ClassStats class="org.openide.util.enum.QueueEnumeration$ListItem" sourceFile="QueueEnumeration.java" interface="false" size="7" bugs="0"/>
14.44 - <ClassStats class="org.openide.util.enum.RemoveDuplicatesEnumeration" sourceFile="RemoveDuplicatesEnumeration.java" interface="false" size="8" bugs="0"/>
14.45 - <ClassStats class="org.openide.util.enum.SequenceEnumeration" sourceFile="SequenceEnumeration.java" interface="false" size="32" bugs="0"/>
14.46 - <ClassStats class="org.openide.util.enum.SingletonEnumeration" sourceFile="SingletonEnumeration.java" interface="false" size="14" bugs="0"/>
14.47 - </PackageStats>
14.48 - </FindBugsSummary>
14.49 - <ClassFeatures></ClassFeatures>
14.50 - <History></History>
14.51 -</BugCollection>