org.checkerframework.dataflow.cfg.builder.MissingEdge Maven / Gradle / Ivy

Go to download

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

Dataflow is a dataflow framework based on the javac compiler.

There is a newer version: 3.42.0-eisop4

package org.checkerframework.dataflow.cfg.builder;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.analysis.Store.FlowRule;
import org.checkerframework.dataflow.cfg.block.SingleSuccessorBlockImpl;

import javax.lang.model.type.TypeMirror;

/* --------------------------------------------------------- */
/* Phase Two */
/* --------------------------------------------------------- */

/** Represents a missing edge that will be added later. */
/*package-private*/ class MissingEdge {
    /** The source of the edge. */
    /*package-private*/ final SingleSuccessorBlockImpl source;

    /** The index (target?) of the edge. Null means go to exceptional exit. */
    /*package-private*/ final @Nullable Integer index;

    /** The cause exception type, for an exceptional edge; otherwise null. */
    /*package-private*/ final @Nullable TypeMirror cause;

    /** The flow rule for this edge. */
    /*package-private*/ final @Nullable FlowRule flowRule;

    /**
     * Create a new MissingEdge.
     *
     * @param source the source of the edge
     * @param index the index (target?) of the edge
     */
    public MissingEdge(SingleSuccessorBlockImpl source, int index) {
        this(source, index, null, FlowRule.EACH_TO_EACH);
    }

    /**
     * Create a new MissingEdge.
     *
     * @param source the source of the edge
     * @param index the index (target?) of the edge
     * @param flowRule the flow rule for this edge
     */
    public MissingEdge(SingleSuccessorBlockImpl source, int index, FlowRule flowRule) {
        this(source, index, null, flowRule);
    }

    /**
     * Create a new MissingEdge.
     *
     * @param source the source of the edge
     * @param index the index (target?) of the edge; null means go to exceptional exit
     * @param cause the cause exception type, for an exceptional edge; otherwise null
     */
    public MissingEdge(
            SingleSuccessorBlockImpl source, @Nullable Integer index, @Nullable TypeMirror cause) {
        this(source, index, cause, FlowRule.EACH_TO_EACH);
    }

    /**
     * Create a new MissingEdge.
     *
     * @param source the source of the edge
     * @param index the index (target?) of the edge; null means go to exceptional exit
     * @param cause the cause exception type, for an exceptional edge; otherwise null
     * @param flowRule the flow rule for this edge
     */
    public MissingEdge(
            SingleSuccessorBlockImpl source,
            @Nullable Integer index,
            @Nullable TypeMirror cause,
            FlowRule flowRule) {
        assert (index != null) || (cause != null);
        this.source = source;
        this.index = index;
        this.cause = cause;
        this.flowRule = flowRule;
    }

    @Override
    public String toString() {
        return "MissingEdge(" + source + ", " + index + ", " + cause + ")";
    }
}