edu.umd.cs.findbugs.detect.RedundantInterfaces Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotbugs Show documentation
SpotBugs: Because it's easy!
The newest version!
/*
 * FindBugs - Find bugs in Java programs
 * Copyright (C) 2005 Dave Brosius 
 * Copyright (C) 2005 University of Maryland
 *
 * 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 edu.umd.cs.findbugs.detect;

import java.util.SortedSet;
import java.util.TreeSet;

import org.apache.bcel.Repository;
import org.apache.bcel.classfile.JavaClass;

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.util.Values;
import edu.umd.cs.findbugs.visitclass.PreorderVisitor;

public class RedundantInterfaces extends PreorderVisitor implements Detector, StatelessDetector {
    private final BugReporter bugReporter;

    public RedundantInterfaces(BugReporter bugReporter) {
        this.bugReporter = bugReporter;
    }

    @Override
    public void visitClassContext(ClassContext classContext) {
        JavaClass obj = classContext.getJavaClass();

        String superClassName = obj.getSuperclassName();
        if (Values.DOTTED_JAVA_LANG_OBJECT.equals(superClassName)) {
            return;
        }

        String[] interfaceNames = obj.getInterfaceNames();
        if ((interfaceNames == null) || (interfaceNames.length == 0)) {
            return;
        }

        try {
            JavaClass superObj = obj.getSuperClass();
            SortedSet redundantInfNames = new TreeSet<>();

            for (String interfaceName : interfaceNames) {
                if (!"java.io.Serializable".equals(interfaceName)) {
                    JavaClass inf = Repository.lookupClass(interfaceName);
                    if (superObj.instanceOf(inf)) {
                        redundantInfNames.add(inf.getClassName());
                    }
                }
            }

            if (redundantInfNames.size() > 0) {
                BugInstance bug = new BugInstance(this, "RI_REDUNDANT_INTERFACES", LOW_PRIORITY).addClass(obj);
                for (String redundantInfName : redundantInfNames) {
                    bug.addClass(redundantInfName).describe("INTERFACE_TYPE");
                }

                bugReporter.reportBug(bug);
            }

        } catch (ClassNotFoundException cnfe) {
            bugReporter.reportMissingClass(cnfe);
        }
    }

    @Override
    public void report() {
    }
}