org.checkerframework.dataflow.expression.FormalParameter 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.expression;

import com.sun.tools.javac.code.Symbol.VarSymbol;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.javacutil.AnnotationProvider;
import org.checkerframework.javacutil.ElementUtils;
import org.checkerframework.javacutil.TypeAnnotationUtils;

import java.util.Objects;

import javax.lang.model.element.VariableElement;

/**
 * A formal parameter, represented by its 1-based index.
 *
 * {@link LocalVariable} represents a formal parameter expressed using its name.
 */
public class FormalParameter extends JavaExpression {

    /** The 1-based index. */
    protected final int index;

    /** The element for this formal parameter. */
    protected final VariableElement element;

    /**
     * Creates a FormalParameter.
     *
     * @param index the 1-based index
     * @param element the element for the formal parameter
     */
    public FormalParameter(int index, VariableElement element) {
        super(ElementUtils.getType(element));
        this.index = index;
        this.element = element;
    }

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

        FormalParameter other = (FormalParameter) obj;
        return this.index == other.index && LocalVariable.sameElement(this.element, other.element);
    }

    /**
     * Returns the 1-based index of this formal parameter.
     *
     * @return the 1-based index of this formal parameter
     */
    public int getIndex() {
        return index;
    }

    /**
     * Returns the element for this variable.
     *
     * @return the element for this variable
     */
    public VariableElement getElement() {
        return element;
    }

    @Override
    public int hashCode() {
        VarSymbol vs = (VarSymbol) element;
        return Objects.hash(
                index,
                vs.name.toString(),
                TypeAnnotationUtils.unannotatedType(vs.type).toString(),
                vs.owner.toString());
    }

    @Override
    public String toString() {
        return "#" + index;
    }

    @Override
    public String toStringDebug() {
        return super.toStringDebug()
                + " [element="
                + element
                + ", owner="
                + ((VarSymbol) element).owner
                + "]";
    }

    @Override
    public boolean containsOfClass(Class clazz) {
        return getClass() == clazz;
    }

    @Override
    public boolean syntacticEquals(JavaExpression je) {
        if (!(je instanceof FormalParameter)) {
            return false;
        }
        FormalParameter other = (FormalParameter) je;
        return index == other.index;
    }

    @Override
    public boolean containsSyntacticEqualJavaExpression(JavaExpression other) {
        return syntacticEquals(other);
    }

    @Override
    public boolean isUnassignableByOtherCode() {
        return true;
    }

    @Override
    public boolean isUnmodifiableByOtherCode() {
        return true;
    }

    @Override
    public boolean isDeterministic(AnnotationProvider provider) {
        return true;
    }

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