org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder 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.builder;

import org.checkerframework.dataflow.cfg.builder.ExtendedNode.ExtendedNodeType;
import org.checkerframework.dataflow.cfg.node.Node;

import java.util.Map;
import java.util.Set;
import java.util.StringJoiner;

import javax.lang.model.type.TypeMirror;

/** An extended node of type {@code EXCEPTION_NODE}. */
/*package-private*/ class NodeWithExceptionsHolder extends ExtendedNode {

    /** The node to hold. */
    protected final Node node;

    /**
     * Map from exception type to labels of successors that may be reached as a result of that
     * exception.
     *
     * This map's keys are the exception types that a Java expression or statement is declared to
     * throw -- say, in the {@code throws} clause of the declaration of a method being called. The
     * expression might be within a {@code try} statement with {@code catch} blocks that are
     * different (either finer-grained or coarser).
     */
    protected final Map> exceptions;

    /**
     * Construct a NodeWithExceptionsHolder for the given node and exceptions.
     *
     * @param node the node to hold
     * @param exceptions the exceptions to hold
     */
    public NodeWithExceptionsHolder(Node node, Map> exceptions) {
        super(ExtendedNodeType.EXCEPTION_NODE);
        this.node = node;
        this.exceptions = exceptions;
    }

    /**
     * Get the exceptions for the node.
     *
     * @return exceptions for the node
     */
    public Map> getExceptions() {
        return exceptions;
    }

    @Override
    public Node getNode() {
        return node;
    }

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

    @Override
    public String toStringDebug() {
        StringJoiner sj = new StringJoiner(String.format("%n    "));
        sj.add("NodeWithExceptionsHolder(" + node.toStringDebug() + ") {");
        for (Map.Entry> entry : exceptions.entrySet()) {
            sj.add(entry.getKey() + " => " + entry.getValue());
        }
        sj.add("}");
        return sj.toString();
    }
}