org.checkerframework.dataflow.cfg.node.ClassNameNode Maven / Gradle / Ivy

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

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.43.0

Show newest version

package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.ClassTree;
import com.sun.source.tree.IdentifierTree;
import com.sun.source.tree.MemberSelectTree;
import com.sun.source.tree.Tree;
import java.util.Collection;
import java.util.Collections;
import java.util.Objects;
import javax.lang.model.element.Element;
import javax.lang.model.type.TypeMirror;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.javacutil.TreeUtils;

/**
 * A node representing a class name used in an expression such as a static method invocation.
 *
 * parent.class .forName(...)
 */
public class ClassNameNode extends Node {

  /** The tree for this node. */
  protected final @Nullable Tree tree;

  /** The class named by this node. */
  protected final Element element;

  /** The parent name, if any. */
  protected final @Nullable Node parent;

  public ClassNameNode(IdentifierTree tree) {
    super(TreeUtils.typeOf(tree));
    assert tree.getKind() == Tree.Kind.IDENTIFIER;
    this.tree = tree;
    assert TreeUtils.isUseOfElement(tree) : "@AssumeAssertion(nullness): tree kind";
    this.element = TreeUtils.elementFromUse(tree);
    this.parent = null;
  }

  /**
   * Create a new ClassNameNode.
   *
   * @param tree the class tree for this node
   */
  public ClassNameNode(ClassTree tree) {
    super(TreeUtils.typeOf(tree));
    this.tree = tree;
    this.element = TreeUtils.elementFromDeclaration(tree);
    this.parent = null;
  }

  public ClassNameNode(MemberSelectTree tree, Node parent) {
    super(TreeUtils.typeOf(tree));
    this.tree = tree;
    assert TreeUtils.isUseOfElement(tree) : "@AssumeAssertion(nullness): tree kind";
    this.element = TreeUtils.elementFromUse(tree);
    this.parent = parent;
  }

  public ClassNameNode(TypeMirror type, Element element) {
    super(type);
    this.tree = null;
    this.element = element;
    this.parent = null;
  }

  public Element getElement() {
    return element;
  }

  /** The parent node of the current node. */
  public @Nullable Node getParent() {
    return parent;
  }

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

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

  @Override
  public String toString() {
    return getElement().getSimpleName().toString();
  }

  @Override
  public boolean equals(@Nullable Object obj) {
    if (!(obj instanceof ClassNameNode)) {
      return false;
    }
    ClassNameNode other = (ClassNameNode) obj;
    return Objects.equals(getParent(), other.getParent())
        && getElement().equals(other.getElement());
  }

  @Override
  public int hashCode() {
    return Objects.hash(getElement(), getParent());
  }

  @Override
  public Collection getOperands() {
    if (parent == null) {
      return Collections.emptyList();
    }
    return Collections.singleton(parent);
  }
}