org.mutabilitydetector.checkers.AllChecksRunner 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
package org.mutabilitydetector.checkers;

/*
 * #%L
 * MutabilityDetector
 * %%
 * Copyright (C) 2008 - 2014 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.
 * #L%
 */


import com.google.common.collect.ImmutableList;
import org.mutabilitydetector.AnalysisError;
import org.mutabilitydetector.AnalysisResult;
import org.mutabilitydetector.IsImmutable;
import org.mutabilitydetector.MutableReasonDetail;
import org.mutabilitydetector.asmoverride.AsmVerifierFactory;
import org.mutabilitydetector.checkers.info.AnalysisDatabase;
import org.mutabilitydetector.checkers.info.AnalysisInProgress;
import org.mutabilitydetector.checkers.info.MutableTypeInformation;
import org.mutabilitydetector.locations.Dotted;

import java.util.Collection;
import java.util.Map;

import static com.google.common.collect.Lists.newArrayList;
import static com.google.common.collect.Maps.newHashMap;

public final class AllChecksRunner {

    private final MutabilityCheckerFactory factory;
    private final CheckerRunnerFactory checkerRunnerFactory;
    private final AsmVerifierFactory verifierFactory;
    private final Dotted toAnalyse;

    public AllChecksRunner(MutabilityCheckerFactory checkerFactory,
            CheckerRunnerFactory checkerRunnerFactory,
            AsmVerifierFactory verifierFactory,
            Dotted toAnalyse) {
        this.factory = checkerFactory;
        this.checkerRunnerFactory = checkerRunnerFactory;
        this.verifierFactory = verifierFactory;
        this.toAnalyse = toAnalyse;
    }

    public AnalysisResult runCheckers(ImmutableList knownResultsSoFar,
                                      AnalysisDatabase database,
                                      MutableTypeInformation mutableTypeInformation,
                                      AnalysisInProgress analysisInProgress) {
        Map results = newHashMap();
        Collection reasons = newArrayList();
        Collection errors = newArrayList();

        Iterable checkers = factory.createInstances(
                database,
                verifierFactory,
                mutableTypeInformation,
                analysisInProgress);

        CheckerRunner checkerRunner = checkerRunnerFactory.createRunner();

        for (AsmMutabilityChecker checker : checkers) {
            CheckerResult checkerResult = checkerRunner.run(checker, toAnalyse, knownResultsSoFar);
            results.put(checkerResult.isImmutable, getNewCount(results, checkerResult.isImmutable));
            reasons.addAll(checkerResult.reasons);
            errors.addAll(checkerResult.errors);
        }

        IsImmutable isImmutable = new ResultCalculator().calculateImmutableStatus(results);

        return AnalysisResult.analysisResult(toAnalyse, isImmutable, reasons, errors);
    }

    private Integer getNewCount(Map results, IsImmutable result) {
        Integer oldCount = results.get(result);
        if (oldCount == null) oldCount = 0;
        return (oldCount + 1);
    }

}