dataflow/src/main/java/org/checkerframework/dataflow/cfg/node/ArrayCreationNode.java

package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.NewArrayTree;
import com.sun.source.tree.Tree;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import javax.lang.model.type.TypeMirror;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.plumelib.util.StringsPlume;

/**
 * A node for new array creation.
 *
 * <pre>
 *   <em>new type[1][2]</em>
 *   <em>new type[] = { expr1, expr2, ... }</em>
 * </pre>
 */
public class ArrayCreationNode extends Node {

  /** The tree is null when an array is created for variable arity method calls. */
  protected final @Nullable NewArrayTree tree;

  /**
   * The length of this list is the number of dimensions in the array. Each element is the size of
   * the given dimension. It can be empty if initializers is non-empty, as in {@code new SomeType[]
   * = { expr1, expr2, ... }}.
   */
  protected final List<Node> dimensions;

  protected final List<Node> initializers;

  public ArrayCreationNode(
      @Nullable NewArrayTree tree,
      TypeMirror type,
      List<Node> dimensions,
      List<Node> initializers) {
    super(type);
    this.tree = tree;
    this.dimensions = dimensions;
    this.initializers = initializers;
  }

  public List<Node> getDimensions() {
    return dimensions;
  }

  public Node getDimension(int i) {
    return dimensions.get(i);
  }

  public List<Node> getInitializers() {
    return initializers;
  }

  public Node getInitializer(int i) {
    return initializers.get(i);
  }

  @Override
  public @Nullable Tree getTree() {
    return tree;
  }

  @Override
  public <R, P> R accept(NodeVisitor<R, P> visitor, P p) {
    return visitor.visitArrayCreation(this, p);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("new " + type);
    if (!dimensions.isEmpty()) {
      sb.append(" (");
      sb.append(StringsPlume.join(", ", dimensions));
      sb.append(")");
    }
    if (!initializers.isEmpty()) {
      sb.append(" = {");
      sb.append(StringsPlume.join(", ", initializers));
      sb.append("}");
    }
    return sb.toString();
  }

  @Override
  public boolean equals(@Nullable Object obj) {
    if (!(obj instanceof ArrayCreationNode)) {
      return false;
    }
    ArrayCreationNode other = (ArrayCreationNode) obj;

    return getDimensions().equals(other.getDimensions())
        && getInitializers().equals(other.getInitializers());
  }

  @Override
  public int hashCode() {
    return Objects.hash(dimensions, initializers);
  }

  @Override
  public Collection<Node> getOperands() {
    ArrayList<Node> list = new ArrayList<>(dimensions.size() + initializers.size());
    list.addAll(dimensions);
    list.addAll(initializers);
    return list;
  }
}