uk.me.tom_fitzhenry.findbugs.guice.ScopingOnInterfacesDetector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of findbugs-guice Show documentation

A detector for Findbugs, a popular static analysis tool, that detects error in the use of Guice.

The newest version!

package uk.me.tom_fitzhenry.findbugs.guice;

import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.Detector;
import edu.umd.cs.findbugs.ba.ClassContext;
import edu.umd.cs.findbugs.ba.XClass;
import edu.umd.cs.findbugs.classfile.CheckedAnalysisException;
import edu.umd.cs.findbugs.classfile.ClassDescriptor;
import edu.umd.cs.findbugs.classfile.Global;
import edu.umd.cs.findbugs.classfile.IAnalysisCache;
import edu.umd.cs.findbugs.classfile.analysis.AnnotationValue;

public class ScopingOnInterfacesDetector implements Detector {
    
    private final static String SCOPE_ANNOTATION = "com.google.inject.ScopeAnnotation";
    
    private final BugReporter bugReporter;

    public ScopingOnInterfacesDetector(BugReporter bugReporter) {
        this.bugReporter = bugReporter;
    }
    
    @Override
    public void visitClassContext(ClassContext classContext) {
        final XClass classInfo = classContext.getXClass();

        if (classInfo.isInterface()) {
            visitInterface(classInfo);
        }
    }
    
    private void visitInterface(XClass classInfo) {
        for (AnnotationValue annotation : classInfo.getAnnotations()) {
            final XClass annotationInfo = classDescriptionToXClass(annotation.getAnnotationClass());
            for (AnnotationValue annotationAnnotation : annotationInfo.getAnnotations()) {
                if (annotationAnnotation.getAnnotationClass().getDottedClassName().equals(SCOPE_ANNOTATION)) {
                    bugReporter.reportBug(new BugInstance(this, "GUICE_SCOPE_ON_INTERFACE",
                            NORMAL_PRIORITY).addClass(classInfo.getClassDescriptor())
                                            .addString(annotationAnnotation.getAnnotationClass().getSimpleName()));
                }
            }
        }
    }
    
    private XClass classDescriptionToXClass(ClassDescriptor classDescriptor) {
        final IAnalysisCache analysisCache = Global.getAnalysisCache();

        XClass classInfo = null;
        try {
            classInfo = analysisCache.getClassAnalysis(XClass.class, classDescriptor);
        } catch (CheckedAnalysisException e) {
            bugReporter.logError("Error when converting a classDescriptor, " + classDescriptor
                    + ", " + "to an XClass.", e);
        }
        return classInfo;
    }

    @Override
    public void report() {
    }
}