org.mutabilitydetector.checkers.AbstractMutabilityChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of MutabilityDetector Show documentation
Lightweight analysis tool for detecting mutability in Java classes.
There is a newer version: 0.10.6
/*
 *    Copyright (c) 2008-2011 Graham Allan
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
 */
package org.mutabilitydetector.checkers;

import static org.mutabilitydetector.locations.Slashed.slashed;

import java.util.ArrayList;
import java.util.Collection;

import org.mutabilitydetector.IsImmutable;
import org.mutabilitydetector.MutabilityReason;
import org.mutabilitydetector.MutableReasonDetail;
import org.mutabilitydetector.Reason;
import org.mutabilitydetector.locations.ClassLocation;
import org.mutabilitydetector.locations.CodeLocation;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Type;

public abstract class AbstractMutabilityChecker implements AsmMutabilityChecker {

    protected Collection reasons = new ArrayList();
    private IsImmutable result = IsImmutable.IMMUTABLE;
    protected String ownerClass;

    @Override
    public IsImmutable result() {
        return result;
    }

    @Override
    public Collection reasons() {
        return reasons;
    }

    @Override
    public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
        ownerClass = name;
    }

    @Override
    public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
        return null;
    }

    @Override
    public void visitAttribute(Attribute attr) {

    }

    @Override
    public void visitEnd() {

    }

    @Override
    public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) {
        return null;
    }

    @Override
    public void visitInnerClass(String name, String outerName, String innerName, int access) {

    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
        return null;
    }

    @Override
    public void visitOuterClass(String owner, String name, String desc) {

    }

    @Override
    public void visitSource(String source, String debug) {

    }

    @Override
    public void visitAnalysisException(Throwable toBeThrown) {
        addResult(errorReasonDescription(toBeThrown), getCodeLocationForException(), MutabilityReason.CANNOT_ANALYSE);
    }

    private String errorReasonDescription(Throwable toBeThrown) {
        if (toBeThrown instanceof StackOverflowError) {
            return "It appears a circular dependency between classes is causing an error in analysing this class.";
        }
        return "Encountered an unhandled error in analysis.";
    }
    
    

    public CodeLocation getCodeLocationForException() {
        return ownerClass != null 
                ? ClassLocation.from(slashed(ownerClass))
                : CodeLocation.UnknownCodeLocation.UNKNOWN;
    }

    protected String dottedClassName(Type objectType) {
        String className = objectType.getInternalName();
        String dottedClassName = className.replace("/", ".");
        return dottedClassName;
    }

    protected MutableReasonDetail createResult(String message, CodeLocation location, Reason reason) {
        return MutableReasonDetail.newMutableReasonDetail(message, location, reason);
    }

    protected void addResult(String message, CodeLocation location, Reason reason) {
        reasons.add(createResult(message, location, reason));
        result = reason.createsResult();
    }

}