dataflow/src/main/java/org/checkerframework/dataflow/cfg/builder/NodeWithExceptionsHolder.java

package org.checkerframework.dataflow.cfg.builder;

import java.util.Map;
import java.util.Set;
import java.util.StringJoiner;
import javax.lang.model.type.TypeMirror;
import org.checkerframework.dataflow.cfg.builder.ExtendedNode.ExtendedNodeType;
import org.checkerframework.dataflow.cfg.node.Node;

/** An extended node of type {@code EXCEPTION_NODE}. */
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.
   */
  protected final Map<TypeMirror, Set<Label>> 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<TypeMirror, Set<Label>> exceptions) {
    super(ExtendedNodeType.EXCEPTION_NODE);
    this.node = node;
    this.exceptions = exceptions;
  }

  /**
   * Get the exceptions for the node.
   *
   * @return exceptions for the node
   */
  public Map<TypeMirror, Set<Label>> 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<TypeMirror, Set<Label>> entry : exceptions.entrySet()) {
      sj.add(entry.getKey() + " => " + entry.getValue());
    }
    sj.add("}");
    return sj.toString();
  }
}