org.checkerframework.common.accumulation.AccumulationAnalysis Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

Show newest version

package org.checkerframework.common.accumulation;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.common.basetype.BaseTypeChecker;
import org.checkerframework.framework.flow.CFAbstractAnalysis;
import org.checkerframework.framework.flow.CFAbstractValue;
import org.checkerframework.javacutil.AnnotationMirrorSet;

import javax.lang.model.type.TypeMirror;

/**
 * This class only contains boilerplate code to permit AccumulationValue's accumulatedValues
 * functionality to interact with the rest of an accumulation type system.
 */
public class AccumulationAnalysis
        extends CFAbstractAnalysis {

    /**
     * Constructs an AccumulationAnalysis.
     *
     * @param checker the checker
     * @param factory the type factory
     */
    public AccumulationAnalysis(BaseTypeChecker checker, AccumulationAnnotatedTypeFactory factory) {
        super(checker, factory);
    }

    @Override
    public AccumulationStore createEmptyStore(boolean sequentialSemantics) {
        return new AccumulationStore(this, sequentialSemantics);
    }

    @Override
    public AccumulationStore createCopiedStore(AccumulationStore accumulationStore) {
        return new AccumulationStore(accumulationStore);
    }

    @Override
    public @Nullable AccumulationValue createAbstractValue(
            AnnotationMirrorSet annotations, TypeMirror underlyingType) {
        if (!CFAbstractValue.validateSet(annotations, underlyingType, atypeFactory)) {
            return null;
        }
        return new AccumulationValue(this, annotations, underlyingType);
    }
}