fb-contrib-commit

[Dave B. <dbr...@us...>]

Update of /cvsroot/fb-contrib/fb-contrib/src/com/mebigfatguy/fbcontrib/detect
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13344/src/com/mebigfatguy/fbcontrib/detect

Added Files:
	AbstractOverriddenMethod.java 
Log Message:
intial checkin, new AOM detector

--- NEW FILE: AbstractOverriddenMethod.java ---
/*
 * fb-contrib - Auxilliary detectors for Java programs
 * Copyright (C) 2005 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 org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Method;

import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.Detector;
import edu.umd.cs.findbugs.StatelessDetector;
import edu.umd.cs.findbugs.ba.ClassContext;
import edu.umd.cs.findbugs.visitclass.PreorderVisitor;

/**
 * finds methods that are declared abstract but override concrete methods in a superclass
 */
public class AbstractOverriddenMethod extends PreorderVisitor implements Detector, StatelessDetector {
	private BugReporter bugReporter;
	private JavaClass[] superClasses;
	
	/**
     * constructs a AOM detector given the reporter to report bugs on
     * @param bugReporter the sync of bug reports
	 */
	public AbstractOverriddenMethod(BugReporter bugReporter) {
		this.bugReporter = bugReporter;
	}
	
	/**
	 * clone this detector so that it can be a StatelessDetector
	 * 
	 * @return a clone of this object
	 */
	public Object clone() throws CloneNotSupportedException {
		return super.clone();
	}
	
	/**
	 * implements the detector to collect the super classes
	 * 
	 * @param classContext the context object for the currently parsed class
	 */
	public void visitClassContext(ClassContext classContext) {
		try {
			JavaClass cls = classContext.getJavaClass();
			superClasses = cls.getSuperClasses();
			cls.accept(this);
		} catch (ClassNotFoundException cnfe) {
			bugReporter.reportMissingClass(cnfe);
		}
	}
	
	/**
	 * overrides the visitor to find abstract methods that override concrete ones
	 * 
	 * @param obj the context object of the currently parsed method
	 */
	@Override
	public void visitMethod(Method obj) {
		if (!obj.isAbstract())
			return;
		
		String methodName = obj.getName();
		String methodSig = obj.getSignature();
		for (JavaClass cls : superClasses) {
			Method[] methods = cls.getMethods();
			for (Method m : methods) {
				if (m.isPrivate() || m.isAbstract())
					continue;
				
				if (methodName.equals(m.getName()) && methodSig.equals(m.getSignature())) {
					bugReporter.reportBug(new BugInstance(this, "AOM_ABSTRACT_OVERRIDDEN_METHOD", NORMAL_PRIORITY)
									.addClass(this)
									.addMethod(this));
				}
			}
		}
		
	}
	
	/**
	 * implements the Detector with a nop
	 */
	public void report() {
	}
}