Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2014 Dave Brosius
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 package com.mebigfatguy.fbcontrib.detect;
 
 import java.util.Set;
 
 import  org.apache.bcel.Repository;
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.ExceptionTable;
 import  org.apache.bcel.classfile.JavaClass;
 import  org.apache.bcel.classfile.Method;
 
looks for constructors, private methods or static methods that declare that they throw specific checked exceptions, but that do not. This just causes callers of these methods to do extra work to handle an exception that will never be thrown.
 
 public class BogusExceptionDeclaration extends BytecodeScanningDetector {
 	private static JavaClass runtimeExceptionClass;
 	private static final Set<StringsafeClasses = new HashSet<String>(8);
 	static {
 		try {
 			.add("java/lang/Object");
 			.add("java/lang/String");
 			.add("java/lang/Integer");
 			.add("java/lang/Long");
 			.add("java/lang/Float");
 			.add("java/lang/Double");
 			.add("java/lang/Short");
 			.add("java/lang/Boolean");
 
 			 = Repository.lookupClass("java/lang/RuntimeException");
 		} catch (ClassNotFoundException cnfe) {
 		}
 	}
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
 	private boolean classIsFinal;
 
 	public BogusExceptionDeclaration(BugReporter bugReporter) {
 		this. = bugReporter;
 	}
 
 
 	public void visitClassContext(ClassContext classContext) {
 		try {
 			if ( != null) {
 				 = new OpcodeStack();
 				 = classContext.getJavaClass().isFinal();
 				super.visitClassContext(classContext);
 			}
 		} finally {
 			 = null;
 		}
 	}

implements the visitor to see if the method declares that it throws any checked exceptions.

Parameters:
obj the context object of the currently parsed code block
 
 	public void visitCode(Code obj) {
 		Method method = getMethod();
 		if ( || method.isStatic() || method.isPrivate() || method.isFinal() || (("<init>".equals(method.getName()) && !isAnonymousInnerCtor(methodgetThisClass())))) {
 			ExceptionTable et = method.getExceptionTable();
 			if (et != null) {
 				String[] exNames = et.getExceptionNames();
				for (String exName : exNames) {
					try {
						JavaClass exCls = Repository.lookupClass(exName);
						if (!exCls.instanceOf()) {
						}
catch (ClassNotFoundException cnfe) {
					}
				}
					super.visitCode(obj);
						BugInstance bi = new BugInstance(this"BED_BOGUS_EXCEPTION_DECLARATION", NORMAL_PRIORITY)
									.addClass(this)
									.addMethod(this)
									.addSourceLine(this, 0);
							bi.addString(ex.replaceAll("/""."));
						}
					}
				}
			}
		}
	}

checks to see if this method is constructor of an instance based inner class, as jdk1.5 compiler has a bug where it attaches bogus exception declarations to this constructors in some cases.

Parameters:
m the method to check
cls the cls that owns the method
Returns:
whether this method is a ctor of an instance based anonymous inner class
	private boolean isAnonymousInnerCtor(Method m, JavaClass cls) {
	    if (!"<init>".equals(m.getName())) {
			return false;
		}
	    String clsName = cls.getClassName();
	    int dollarPos = clsName.lastIndexOf('$');
	    if (dollarPos <0) {
			return false;
		}
	    String signature = m.getSignature();
	    return ("(L" + clsName.substring(0, dollarPos).replace('.''/') + ";)V").equals(signature);
	}

implements the visitor to look for method calls that could throw the exceptions that are listed in the declaration.
	public void sawOpcode(int seen) {
			return;
		}
		try {
	        .precomputation(this);
	        
			if ((seen == INVOKEVIRTUAL)
			||  (seen == INVOKEINTERFACE)
			||  (seen == INVOKESPECIAL)
			||  (seen == INVOKESTATIC)) {
				if (!.contains(clsName)) {
					try {
						JavaClass cls = Repository.lookupClass(clsName);
						Method[] methods = cls.getMethods();
						String methodName = getNameConstantOperand();
						String signature = getSigConstantOperand();
						boolean found = false;
						for (Method m : methods) {
							if (m.getName().equals(methodName) && m.getSignature().equals(signature)) {
								ExceptionTable et = m.getExceptionTable();
								if (et != null) {
									String[] thrownExceptions = et.getExceptionNames();
									for (String thrownException : thrownExceptions) {
										JavaClass exCls = Repository.lookupClass(thrownException);
										JavaClass superCls = exCls.getSuperClass();
										do {
											exCls = superCls;
											if (exCls != null) {
	    										.remove(exCls.getClassName());
	    										superCls = exCls.getSuperClass();
else {
											    break;
											}
while (!.isEmpty() && !"java.lang.Exception".equals(exCls.getClassName()) && !"java.lang.Error".equals(exCls.getClassName()));
									}
else {
								}
								found = true;
								break;
							}
						}
						if (!found) {
						}
					}
					catch (ClassNotFoundException cnfe) {
					}
				}
else if (seen == ATHROW) {
				if (.getStackDepth() > 0) {
					String exSig = item.getSignature();
					String exClass = exSig.substring(1, exSig.length() - 1).replaceAll("/"".");
				}
			}
finally {
			.sawOpcode(thisseen);
		}
	}
New to GrepCode? Check out our FAQ X