org.checkerframework.dataflow.cfg.block.ExceptionBlockImpl Maven / Gradle / Ivy

Go to download

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

dataflow-shaded is a dataflow framework based on the javac compiler. It differs from the org.checkerframework:dataflow artifact in two ways. First, the packages in this artifact have been renamed to org.checkerframework.shaded.*. Second, unlike the dataflow artifact, this artifact contains the dependencies it requires.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.dataflow.cfg.block;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.cfg.node.Node;
import org.checkerframework.javacutil.BugInCF;
import org.plumelib.util.ArrayMap;
import org.plumelib.util.ArraySet;
import org.plumelib.util.CollectionsPlume;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.lang.model.type.TypeMirror;

/** Implementation of {@link ExceptionBlock}. */
public class ExceptionBlockImpl extends SingleSuccessorBlockImpl implements ExceptionBlock {

    /** The node of this block. */
    protected @Nullable Node node;

    /** Set of exceptional successors. */
    protected final Map> exceptionalSuccessors;

    /** Create an empty exceptional block. */
    public ExceptionBlockImpl() {
        super(BlockType.EXCEPTION_BLOCK);
        exceptionalSuccessors = new ArrayMap<>(2);
    }

    /** Set the node. */
    public void setNode(Node c) {
        node = c;
        c.setBlock(this);
    }

    @Override
    public Node getNode() {
        if (node == null) {
            throw new BugInCF("Requested node for exception block before initialization");
        }
        return node;
    }

    /**
     * {@inheritDoc}
     *
     * This implementation returns a singleton list.
     */
    @Override
    public List getNodes() {
        return Collections.singletonList(getNode());
    }

    @Override
    public @Nullable Node getLastNode() {
        return getNode();
    }

    /**
     * Add an exceptional successor.
     *
     * @param b the successor
     * @param cause the exception type that leads to the given block
     */
    public void addExceptionalSuccessor(BlockImpl b, TypeMirror cause) {
        Set blocks = exceptionalSuccessors.computeIfAbsent(cause, __ -> new ArraySet<>(2));
        blocks.add(b);
        b.addPredecessor(this);
    }

    @Override
    public Map> getExceptionalSuccessors() {
        if (exceptionalSuccessors == null) {
            return Collections.emptyMap();
        }
        return Collections.unmodifiableMap(exceptionalSuccessors);
    }

    @Override
    public Set getSuccessors() {
        Set result = new ArraySet<>(super.getSuccessors());
        for (Set blocks : getExceptionalSuccessors().values()) {
            CollectionsPlume.adjoinAll(result, blocks);
        }
        return result;
    }

    @Override
    public String toString() {
        return "ExceptionBlock(" + node + ")";
    }
}