org.checkerframework.dataflow.livevariable.LiveVarValue 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.44.0

Show newest version

package org.checkerframework.dataflow.livevariable;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.analysis.AbstractValue;
import org.checkerframework.dataflow.cfg.node.Node;
import org.checkerframework.javacutil.BugInCF;

/** A live variable (which is represented by a node) wrapper turning node into abstract value. */
public class LiveVarValue implements AbstractValue {

  /**
   * A live variable is represented by a node, which can be a {@link
   * org.checkerframework.dataflow.cfg.node.LocalVariableNode} or {@link
   * org.checkerframework.dataflow.cfg.node.FieldAccessNode}.
   */
  protected final Node liveVariable;

  @Override
  public LiveVarValue leastUpperBound(LiveVarValue other) {
    throw new BugInCF("lub of LiveVar get called!");
  }

  /**
   * Create a new live variable.
   *
   * @param n a node
   */
  public LiveVarValue(Node n) {
    this.liveVariable = n;
  }

  @Override
  public int hashCode() {
    return this.liveVariable.hashCode();
  }

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

  @Override
  public String toString() {
    return this.liveVariable.toString();
  }
}